Class NSChatTopicAgent

User agents within a chat topic. Which users are assigned and what roles they have within the chat topic. Carrier object for ChatTopicAgent.

Syntax

Constructors

NSChatTopicAgent()

Initializes a new instance of the NSChatTopicAgent class.

Declaration

NSChatTopicAgent

Methods

GetCanListen()

User agents within a chat topic. Which users are assigned and what roles they have within the chat topic. Carrier object for ChatTopicAgent.

Declaration

Bool GetCanListen()

Returns

Type	Description
Bool	True of a user can listen in on this topic.

Examples

NSChatTopicAgent thing;
Bool canListen = thing.GetCanListen();

GetCanManage()

User agents within a chat topic. Which users are assigned and what roles they have within the chat topic. Carrier object for ChatTopicAgent.

Declaration

Bool GetCanManage()

Returns

Type	Description
Bool	True if the user is a manager for this topic.

Examples

NSChatTopicAgent thing;
Bool canManage = thing.GetCanManage();

GetCanNotify()

User agents within a chat topic. Which users are assigned and what roles they have within the chat topic. Carrier object for ChatTopicAgent.

Declaration

Bool GetCanNotify()

Returns

Type	Description
Bool	True if the user should receive notifications for this topic.

Examples

NSChatTopicAgent thing;
Bool canNotify = thing.GetCanNotify();

GetCanRespond()

True if the user can respond to chats in this topic

Declaration

Bool GetCanRespond()

Returns

Type	Description
Bool

Examples

NSChatTopicAgent thing;
Bool canRespond = thing.GetCanRespond();

GetTopicId()

User agents within a chat topic. Which users are assigned and what roles they have within the chat topic. Carrier object for ChatTopicAgent.

Declaration

Integer GetTopicId()

Returns

Type	Description
Integer	The reference to the associated chat topic.

Examples

NSChatTopicAgent thing;
Integer topicId = thing.GetTopicId();

GetUser()

User agents within a chat topic. Which users are assigned and what roles they have within the chat topic. Carrier object for ChatTopicAgent.

Declaration

NSAssociate GetUser()

Returns

Type	Description
NSAssociate	The associate that is the user agent.

Examples

NSChatTopicAgent thing;
NSAssociate user = thing.GetUser();

SetCanListen(Bool)

User agents within a chat topic. Which users are assigned and what roles they have within the chat topic. Carrier object for ChatTopicAgent.

Declaration

Void SetCanListen(Bool canListen)

Parameters

Type	Name	Description
Bool	canListen	True of a user can listen in on this topic.

Returns

Type	Description
Void

Examples

NSChatTopicAgent thing;
Bool canListen;
thing.SetCanListen(canListen);

SetCanManage(Bool)

User agents within a chat topic. Which users are assigned and what roles they have within the chat topic. Carrier object for ChatTopicAgent.

Declaration

Void SetCanManage(Bool canManage)

Parameters

Type	Name	Description
Bool	canManage	True if the user is a manager for this topic.

Returns

Type	Description
Void

Examples

NSChatTopicAgent thing;
Bool canManage;
thing.SetCanManage(canManage);

SetCanNotify(Bool)

User agents within a chat topic. Which users are assigned and what roles they have within the chat topic. Carrier object for ChatTopicAgent.

Declaration

Void SetCanNotify(Bool canNotify)

Parameters

Type	Name	Description
Bool	canNotify	True if the user should receive notifications for this topic.

Returns

Type	Description
Void

Examples

NSChatTopicAgent thing;
Bool canNotify;
thing.SetCanNotify(canNotify);

SetCanRespond(Bool)

User agents within a chat topic. Which users are assigned and what roles they have within the chat topic. Carrier object for ChatTopicAgent.

Declaration

Void SetCanRespond(Bool canRespond)

Parameters

Type	Name	Description
Bool	canRespond	True if the user can respond to chats in this topic.

Returns

Type	Description
Void

Examples

NSChatTopicAgent thing;
Bool canRespond;
thing.SetCanRespond(canRespond);

SetTopicId(Integer)

User agents within a chat topic. Which users are assigned and what roles they have within the chat topic. Carrier object for ChatTopicAgent.

Declaration

Void SetTopicId(Integer topicId)

Parameters

Type	Name	Description
Integer	topicId	The reference to the associated chat topic.

Returns

Type	Description
Void

Examples

NSChatTopicAgent thing;
Integer topicId;
thing.SetTopicId(topicId);

SetUser(NSAssociate)

User agents within a chat topic. Which users are assigned and what roles they have within the chat topic. Carrier object for ChatTopicAgent.

Declaration

Void SetUser(NSAssociate user)

Parameters

Type	Name	Description
NSAssociate	user	The associate that is the user agent.

Returns

Type	Description
Void

Examples

NSChatTopicAgent thing;
NSAssociate user;
thing.SetUser(user);