FMWebSyncChatJoinArgs Class Reference

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

Overview

Arguments for a client joining a chat channel.

– channel

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

- (NSString *)channel

Discussion

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

Declared In

FMWebSyncChat.h

– channels

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

- (NSMutableArray *)channels

Discussion

Gets the channels to which the client should be subscribed. 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 join.

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 join.
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 join.
name="tag">The

tag identifying the subscription.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSyncChat.h

+ joinArgsWithChannel:

Initializes a new instance of the class.

+ (FMWebSyncChatJoinArgs *)joinArgsWithChannel:(NSString *)channel

Parameters

name="channel">The

channel to join.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSyncChat.h

+ joinArgsWithChannel:tag:

Initializes a new instance of the class.

+ (FMWebSyncChatJoinArgs *)joinArgsWithChannel:(NSString *)channel tag:(NSString *)tag

Parameters

name="channel">The

channel to join.
name="tag">The

tag identifying the subscription.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSyncChat.h

+ joinArgsWithChannels:

Initializes a new instance of the class.

+ (FMWebSyncChatJoinArgs *)joinArgsWithChannels:(NSMutableArray *)channels

Parameters

name="channels">The

channels to join.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSyncChat.h

+ joinArgsWithChannels:tag:

Initializes a new instance of the class.

+ (FMWebSyncChatJoinArgs *)joinArgsWithChannels:(NSMutableArray *)channels tag:(NSString *)tag

Parameters

name="channels">The

channels to join.
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

– onReceive

Gets the callback to invoke when data is received on the channel. See for callback argument details.

- (FMCallback *)onReceive

Discussion

Gets the callback to invoke when data is received on the channel. See for callback argument details.

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

– onUserClientJoin

Gets the callback to invoke when any client associated with a given user ID joins the channel. See for callback argument details. This callback is invoked when the client count for a given user ID increases.

- (FMCallback *)onUserClientJoin

Discussion

Gets the callback to invoke when any client associated with a given user ID joins the channel. See for callback argument details. This callback is invoked when the client count for a given user ID increases.

Declared In

FMWebSyncChat.h

– onUserClientLeave

Gets the callback to invoke when any client associated with a given user ID leaves the channel. See for callback argument details. This callback is invoked when the client count for a given user ID decreases.

- (FMCallback *)onUserClientLeave

Discussion

Gets the callback to invoke when any client associated with a given user ID leaves the channel. See for callback argument details. This callback is invoked when the client count for a given user ID decreases.

Declared In

FMWebSyncChat.h

– onUserJoin

Gets the callback to invoke when the first client associated with a given user ID joins the channel. See for callback argument details. This callback is invoked when the client count for a given user ID moves from 0 to 1.

- (FMCallback *)onUserJoin

Discussion

Gets the callback to invoke when the first client associated with a given user ID joins the channel. See for callback argument details. This callback is invoked when the client count for a given user ID moves from 0 to 1.

Declared In

FMWebSyncChat.h

– onUserLeave

Gets the callback to invoke when the last client associated with a given user ID leaves the channel. See for callback argument details. This callback is invoked when the client count for a given user ID moves from 1 to 0.

- (FMCallback *)onUserLeave

Discussion

Gets the callback to invoke when the last client associated with a given user ID leaves the channel. See for callback argument details. This callback is invoked when the client count for a given user ID moves from 1 to 0.

Declared In

FMWebSyncChat.h

– setChannel:

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

- (void)setChannel:(NSString *)value

Discussion

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

Declared In

FMWebSyncChat.h

– setChannels:

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

- (void)setChannels:(NSMutableArray *)value

Discussion

Sets the channels to which the client should be subscribed. 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 ( ^ ) ( FMWebSyncChatJoinCompleteArgs *))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 ( ^ ) ( FMWebSyncChatJoinFailureArgs *))valueBlock

Discussion

Sets the callback to invoke if the request fails.

Declared In

FMWebSyncChat.h

– setOnReceive:

Sets the callback to invoke when data is received on the channel. See for callback argument details.

- (void)setOnReceive:(FMCallback *)value

Discussion

Sets the callback to invoke when data is received on the channel. See for callback argument details.

Declared In

FMWebSyncChat.h

– setOnReceiveBlock:

Sets the callback to invoke when data is received on the channel. See for callback argument details.

- (void)setOnReceiveBlock:(void ( ^ ) ( FMWebSyncChatJoinReceiveArgs *))valueBlock

Discussion

Sets the callback to invoke when data is received on the channel. See for callback argument details.

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 ( ^ ) ( FMWebSyncChatJoinSuccessArgs *))valueBlock

Discussion

Sets the callback to invoke if the request succeeds.

Declared In

FMWebSyncChat.h

– setOnUserClientJoin:

Sets the callback to invoke when any client associated with a given user ID joins the channel. See for callback argument details. This callback is invoked when the client count for a given user ID increases.

- (void)setOnUserClientJoin:(FMCallback *)value

Discussion

Sets the callback to invoke when any client associated with a given user ID joins the channel. See for callback argument details. This callback is invoked when the client count for a given user ID increases.

Declared In

FMWebSyncChat.h

– setOnUserClientJoinBlock:

Sets the callback to invoke when any client associated with a given user ID joins the channel. See for callback argument details. This callback is invoked when the client count for a given user ID increases.

- (void)setOnUserClientJoinBlock:(void ( ^ ) ( FMWebSyncChatUserClientJoinArgs *))valueBlock

Discussion

Sets the callback to invoke when any client associated with a given user ID joins the channel. See for callback argument details. This callback is invoked when the client count for a given user ID increases.

Declared In

FMWebSyncChat.h

– setOnUserClientLeave:

Sets the callback to invoke when any client associated with a given user ID leaves the channel. See for callback argument details. This callback is invoked when the client count for a given user ID decreases.

- (void)setOnUserClientLeave:(FMCallback *)value

Discussion

Sets the callback to invoke when any client associated with a given user ID leaves the channel. See for callback argument details. This callback is invoked when the client count for a given user ID decreases.

Declared In

FMWebSyncChat.h

– setOnUserClientLeaveBlock:

Sets the callback to invoke when any client associated with a given user ID leaves the channel. See for callback argument details. This callback is invoked when the client count for a given user ID decreases.

- (void)setOnUserClientLeaveBlock:(void ( ^ ) ( FMWebSyncChatUserClientLeaveArgs *))valueBlock

Discussion

Sets the callback to invoke when any client associated with a given user ID leaves the channel. See for callback argument details. This callback is invoked when the client count for a given user ID decreases.

Declared In

FMWebSyncChat.h

– setOnUserJoin:

Sets the callback to invoke when the first client associated with a given user ID joins the channel. See for callback argument details. This callback is invoked when the client count for a given user ID moves from 0 to 1.

- (void)setOnUserJoin:(FMCallback *)value

Discussion

Sets the callback to invoke when the first client associated with a given user ID joins the channel. See for callback argument details. This callback is invoked when the client count for a given user ID moves from 0 to 1.

Declared In

FMWebSyncChat.h

– setOnUserJoinBlock:

Sets the callback to invoke when the first client associated with a given user ID joins the channel. See for callback argument details. This callback is invoked when the client count for a given user ID moves from 0 to 1.

- (void)setOnUserJoinBlock:(void ( ^ ) ( FMWebSyncChatUserJoinArgs *))valueBlock

Discussion

Sets the callback to invoke when the first client associated with a given user ID joins the channel. See for callback argument details. This callback is invoked when the client count for a given user ID moves from 0 to 1.

Declared In

FMWebSyncChat.h

– setOnUserLeave:

Sets the callback to invoke when the last client associated with a given user ID leaves the channel. See for callback argument details. This callback is invoked when the client count for a given user ID moves from 1 to 0.

- (void)setOnUserLeave:(FMCallback *)value

Discussion

Sets the callback to invoke when the last client associated with a given user ID leaves the channel. See for callback argument details. This callback is invoked when the client count for a given user ID moves from 1 to 0.

Declared In

FMWebSyncChat.h

– setOnUserLeaveBlock:

Sets the callback to invoke when the last client associated with a given user ID leaves the channel. See for callback argument details. This callback is invoked when the client count for a given user ID moves from 1 to 0.

- (void)setOnUserLeaveBlock:(void ( ^ ) ( FMWebSyncChatUserLeaveArgs *))valueBlock

Discussion

Sets the callback to invoke when the last client associated with a given user ID leaves the channel. See for callback argument details. This callback is invoked when the client count for a given user ID moves from 1 to 0.

Declared In

FMWebSyncChat.h

– setTag:

Sets a tag that will uniquely identify this subscription so it can be unsubscribed later without affecting other subscriptions with the same channel.

- (void)setTag:(NSString *)value

Discussion

Sets a tag that will uniquely identify this subscription so it can be unsubscribed later without affecting other subscriptions with the same channel.

Declared In

FMWebSyncChat.h

– setUserId:

Sets the current user ID.

- (void)setUserId:(NSString *)value

Discussion

Sets the current user ID.

Declared In

FMWebSyncChat.h

– setUserNickname:

Sets the current user nickname.

- (void)setUserNickname:(NSString *)value

Discussion

Sets the current user nickname.

Declared In

FMWebSyncChat.h

– tag

Gets a tag that will uniquely identify this subscription so it can be unsubscribed later without affecting other subscriptions with the same channel.

- (NSString *)tag

Discussion

Gets a tag that will uniquely identify this subscription so it can be unsubscribed later without affecting other subscriptions with the same channel.

Declared In

FMWebSyncChat.h

– userId

Gets the current user ID.

- (NSString *)userId

Discussion

Gets the current user ID.

Declared In

FMWebSyncChat.h

– userNickname

Gets the current user nickname.

- (NSString *)userNickname

Discussion

Gets the current user nickname.

Declared In

FMWebSyncChat.h