Class NSChatPresence

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

Syntax

Constructors

NSChatPresence()

Initializes a new instance of the NSChatPresence class.

Declaration

NSChatPresence

Methods

GetChatTopics()

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

Declaration

Integer[] GetChatTopics()

Returns

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

Examples

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

GetDisplayName()

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

Declaration

String GetDisplayName()

Returns

Type	Description
String	The display name of the chat user.

Examples

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

GetOngoingChats()

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

Declaration

Integer GetOngoingChats()

Returns

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

Examples

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

GetPresent()

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

Declaration

Bool GetPresent()

Returns

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

Examples

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

GetUserId()

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

Declaration

Integer GetUserId()

Returns

Type	Description
Integer	The ID for the chat user.

Examples

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

SetChatTopics(Integer[])

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

Declaration

Void SetChatTopics(Integer[] 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

Examples

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

SetDisplayName(String)

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

Declaration

Void SetDisplayName(String displayName)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetOngoingChats(Integer)

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

Declaration

Void SetOngoingChats(Integer ongoingChats)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetPresent(Bool)

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

Declaration

Void SetPresent(Bool present)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetUserId(Integer)

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

Declaration

Void SetUserId(Integer userId)

Parameters

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

Returns

Type	Description
Void

Examples

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