FMWebSyncChatChatUser Class Reference

Inherits from FMSerializable : NSObject
Declared in FMWebSyncChat.h

Overview

An instance of a chat participant.

– boundRecords

Gets the bound records of the chat client triggering this event.

- (NSMutableDictionary *)boundRecords

Discussion

Gets the bound records of the chat client triggering this event.

Declared In

FMWebSyncChat.h

+ chatUserWithUserId:userNickname:clientId:boundRecords:

Initializes a new instance of the class.

+ (FMWebSyncChatChatUser *)chatUserWithUserId:(NSString *)userId userNickname:(NSString *)userNickname clientId:(FMNullableGuid *)clientId boundRecords:(NSMutableDictionary *)boundRecords

Parameters

name="userId">The

user ID of the chat participant.
name="userNickname">The

user nickname of the chat participant.
name="boundRecords">The

bound records of the chat client triggering this event.
name="clientId">The

ID of the chat client triggering this event.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSyncChat.h

+ chatUserWithId:userNickname:clientId:boundRecords:

Initializes a new instance of the class.

+ (FMWebSyncChatChatUser *)chatUserWithId:(NSString *)userId userNickname:(NSString *)userNickname clientId:(FMNullableGuid *)clientId boundRecords:(NSMutableDictionary *)boundRecords

Parameters

name="userId">The

user ID of the chat participant.
name="userNickname">The

user nickname of the chat participant.
name="boundRecords">The

bound records of the chat client triggering this event.
name="clientId">The

ID of the chat client triggering this event.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSyncChat.h

– clientId

Gets the ID of the chat client triggering this event.

- (FMNullableGuid *)clientId

Discussion

Gets the ID of the chat client triggering this event.

Declared In

FMWebSyncChat.h

– clients

Gets the chat clients associated with the chat user.

- (NSMutableArray *)clients

Discussion

Gets the chat clients associated with the chat user.

Declared In

FMWebSyncChat.h

– initWithUserId:userNickname:clientId:boundRecords:

Initializes a new instance of the class.

- (id)initWithUserId:(NSString *)userId userNickname:(NSString *)userNickname clientId:(FMNullableGuid *)clientId boundRecords:(NSMutableDictionary *)boundRecords

Parameters

name="userId">The

user ID of the chat participant.
name="userNickname">The

user nickname of the chat participant.
name="boundRecords">The

bound records of the chat client triggering this event.
name="clientId">The

ID of the chat client triggering this event.

Discussion

Initializes a new instance of the class.

Declared In

FMWebSyncChat.h

– setBoundRecords:

Sets the bound records of the chat client triggering this event.

- (void)setBoundRecords:(NSMutableDictionary *)value

Discussion

Sets the bound records of the chat client triggering this event.

Declared In

FMWebSyncChat.h

– setClientId:

Sets the ID of the chat client triggering this event.

- (void)setClientId:(FMNullableGuid *)value

Discussion

Sets the ID of the chat client triggering this event.

Declared In

FMWebSyncChat.h

– setClients:

Sets the chat clients associated with the chat user.

- (void)setClients:(NSMutableArray *)value

Discussion

Sets the chat clients associated with the chat user.

Declared In

FMWebSyncChat.h

– setUserId:

Sets the user ID of the chat participant.

- (void)setUserId:(NSString *)value

Discussion

Sets the user ID of the chat participant.

Declared In

FMWebSyncChat.h

– setUserNickname:

Sets the user nickname of the chat participant.

- (void)setUserNickname:(NSString *)value

Discussion

Sets the user nickname of the chat participant.

Declared In

FMWebSyncChat.h

– userId

Gets the user ID of the chat participant.

- (NSString *)userId

Discussion

Gets the user ID of the chat participant.

Declared In

FMWebSyncChat.h

– userNickname

Gets the user nickname of the chat participant.

- (NSString *)userNickname

Discussion

Gets the user nickname of the chat participant.

Declared In

FMWebSyncChat.h