Class NSChatPresence

Represents presence information for a chat user, bundled with some other useful information. Carrier object for ChatPresence.

Constructors

NSChatPresence()

Initializes a new instance of the NSChatPresence class.

Declaration

NSChatPresence

Methods

GetChatTopics()

Declaration

Integer[] GetChatTopics()

Examples

NSChatPresence thing;
Integer[] chatTopics = thing.GetChatTopics();

Returns

Type	Description
Integer[]	An array of IDs with chat topics that this user is a member of.

GetDisplayName()

Declaration

String GetDisplayName()

Examples

NSChatPresence thing;
String displayName = thing.GetDisplayName();

Returns

Type	Description
String	The display name of the chat user.

GetOngoingChats()

Declaration

Integer GetOngoingChats()

Examples

NSChatPresence thing;
Integer ongoingChats = thing.GetOngoingChats();

Returns

Type	Description
Integer	The number of ongoing chats this users has now.

GetPresent()

Declaration

Bool GetPresent()

Examples

NSChatPresence thing;
Bool present = thing.GetPresent();

Returns

Type	Description
Bool	Indicates if the user has the chat presence turned on or off.

GetUserId()

Declaration

Integer GetUserId()

Examples

NSChatPresence thing;
Integer userId = thing.GetUserId();

Returns

Type	Description
Integer	The ID for the chat user.

SetChatTopics(Integer[])

Declaration

Void SetChatTopics(Integer[] chatTopics)

Examples

NSChatPresence thing;
Integer[] chatTopics;
thing.SetChatTopics(chatTopics);

Parameters

Type	Name	Description
Integer[]	chatTopics	An array of IDs with chat topics that this user is a member of.

Returns

Type	Description
Void

SetDisplayName(String)

Declaration

Void SetDisplayName(String displayName)

Examples

NSChatPresence thing;
String displayName;
thing.SetDisplayName(displayName);

Parameters

Type	Name	Description
String	displayName	The display name of the chat user.

Returns

Type	Description
Void

SetOngoingChats(Integer)

Declaration

Void SetOngoingChats(Integer ongoingChats)

Examples

NSChatPresence thing;
Integer ongoingChats;
thing.SetOngoingChats(ongoingChats);

Parameters

Type	Name	Description
Integer	ongoingChats	The number of ongoing chats this users has now.

Returns

Type	Description
Void

SetPresent(Bool)

Declaration

Void SetPresent(Bool present)

Examples

NSChatPresence thing;
Bool present;
thing.SetPresent(present);

Parameters

Type	Name	Description
Bool	present	Indicates if the user has the chat presence turned on or off.

Returns

Type	Description
Void

SetUserId(Integer)

Declaration

Void SetUserId(Integer userId)

Examples

NSChatPresence thing;
Integer userId;
thing.SetUserId(userId);

Parameters

Type	Name	Description
Integer	userId	The ID for the chat user.

Returns

Type	Description
Void