FMWebSyncChatLeaveArgs Class Reference

Inherits from FMWebSyncBaseInputArgs : FMWebSyncExtensible : FMDynamic : FMSerializable : NSObject
Declared in FMWebSyncChat.h

Overview

Arguments for a client leaving a chat channel.

– channel

Gets the channel from which the client should be unsubscribed. Must start with a forward slash (/). Overrides .

- (NSString *)channel

Discussion

Gets the channel from which the client should be unsubscribed. Must start with a forward slash (/). Overrides .

Declared In

FMWebSyncChat.h

– channels

Gets the channels from which the client should be unsubscribed. Each must start with a forward slash (/). Overrides .

- (NSMutableArray *)channels

Discussion

Gets the channels from which the client should be unsubscribed. Each must start with a forward slash (/). Overrides .

Declared In

FMWebSyncChat.h

– initWithChannel:

Initializes a new instance of the class.

- (id)initWithChannel:(NSString *)channel

Parameters

name="channel">The

channel to leave.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSyncChat.h

– initWithChannel:tag:

Initializes a new instance of the class.

- (id)initWithChannel:(NSString *)channel tag:(NSString *)tag

Parameters

name="channel">The

channel to leave.
name="tag">The

tag identifying the subscription.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSyncChat.h

– initWithChannels:

Initializes a new instance of the class.

- (id)initWithChannels:(NSMutableArray *)channels

Parameters

name="channels">The

channels to join.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSyncChat.h

– initWithChannels:tag:

Initializes a new instance of the class.

- (id)initWithChannels:(NSMutableArray *)channels tag:(NSString *)tag

Parameters

name="channels">The

channels to leave.
name="tag">The

tag identifying the subscription.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSyncChat.h

+ leaveArgsWithChannel:

Initializes a new instance of the class.

+ (FMWebSyncChatLeaveArgs *)leaveArgsWithChannel:(NSString *)channel

Parameters

name="channel">The

channel to leave.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSyncChat.h

+ leaveArgsWithChannel:tag:

Initializes a new instance of the class.

+ (FMWebSyncChatLeaveArgs *)leaveArgsWithChannel:(NSString *)channel tag:(NSString *)tag

Parameters

name="channel">The

channel to leave.
name="tag">The

tag identifying the subscription.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSyncChat.h

+ leaveArgsWithChannels:

Initializes a new instance of the class.

+ (FMWebSyncChatLeaveArgs *)leaveArgsWithChannels:(NSMutableArray *)channels

Parameters

name="channels">The

channels to join.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSyncChat.h

+ leaveArgsWithChannels:tag:

Initializes a new instance of the class.

+ (FMWebSyncChatLeaveArgs *)leaveArgsWithChannels:(NSMutableArray *)channels tag:(NSString *)tag

Parameters

name="channels">The

channels to leave.
name="tag">The

tag identifying the subscription.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSyncChat.h

– onComplete

Gets the callback to invoke after or .

- (FMCallback *)onComplete

Discussion

Gets the callback to invoke after or .

Declared In

FMWebSyncChat.h

– onFailure

Gets the callback to invoke if the request fails.

- (FMCallback *)onFailure

Discussion

Gets the callback to invoke if the request fails.

Declared In

FMWebSyncChat.h

– onSuccess

Gets the callback to invoke if the request succeeds.

- (FMCallback *)onSuccess

Discussion

Gets the callback to invoke if the request succeeds.

Declared In

FMWebSyncChat.h

– setChannel:

Sets the channel from which the client should be unsubscribed. Must start with a forward slash (/). Overrides .

- (void)setChannel:(NSString *)value

Discussion

Sets the channel from which the client should be unsubscribed. Must start with a forward slash (/). Overrides .

Declared In

FMWebSyncChat.h

– setChannels:

Sets the channels from which the client should be unsubscribed. Each must start with a forward slash (/). Overrides .

- (void)setChannels:(NSMutableArray *)value

Discussion

Sets the channels from which the client should be unsubscribed. Each must start with a forward slash (/). Overrides .

Declared In

FMWebSyncChat.h

– setOnComplete:

Sets the callback to invoke after or .

- (void)setOnComplete:(FMCallback *)value

Discussion

Sets the callback to invoke after or .

Declared In

FMWebSyncChat.h

– setOnCompleteBlock:

Sets the callback to invoke after or .

- (void)setOnCompleteBlock:(void ( ^ ) ( FMWebSyncChatLeaveCompleteArgs *))valueBlock

Discussion

Sets the callback to invoke after or .

Declared In

FMWebSyncChat.h

– setOnFailure:

Sets the callback to invoke if the request fails.

- (void)setOnFailure:(FMCallback *)value

Discussion

Sets the callback to invoke if the request fails.

Declared In

FMWebSyncChat.h

– setOnFailureBlock:

Sets the callback to invoke if the request fails.

- (void)setOnFailureBlock:(void ( ^ ) ( FMWebSyncChatLeaveFailureArgs *))valueBlock

Discussion

Sets the callback to invoke if the request fails.

Declared In

FMWebSyncChat.h

– setOnSuccess:

Sets the callback to invoke if the request succeeds.

- (void)setOnSuccess:(FMCallback *)value

Discussion

Sets the callback to invoke if the request succeeds.

Declared In

FMWebSyncChat.h

– setOnSuccessBlock:

Sets the callback to invoke if the request succeeds.

- (void)setOnSuccessBlock:(void ( ^ ) ( FMWebSyncChatLeaveSuccessArgs *))valueBlock

Discussion

Sets the callback to invoke if the request succeeds.

Declared In

FMWebSyncChat.h

– setTag:

Sets a tag that uniquely identifies a subscription so other subscriptions with the same channel are not affected.

- (void)setTag:(NSString *)value

Discussion

Sets a tag that uniquely identifies a subscription so other subscriptions with the same channel are not affected.

Declared In

FMWebSyncChat.h

– tag

Gets a tag that uniquely identifies a subscription so other subscriptions with the same channel are not affected.

- (NSString *)tag

Discussion

Gets a tag that uniquely identifies a subscription so other subscriptions with the same channel are not affected.

Declared In

FMWebSyncChat.h