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.
Constructors
NSChatTopicAgent()
Initializes a new instance of the NSChatTopicAgent class.
Declaration
NSChatTopicAgentMethods
GetCanListen()
Declaration
Bool GetCanListen()Examples
NSChatTopicAgent thing;
Bool canListen = thing.GetCanListen();Returns
| Type | Description |
| Bool | True of a user can listen in on this topic. |
GetCanManage()
Declaration
Bool GetCanManage()Examples
NSChatTopicAgent thing;
Bool canManage = thing.GetCanManage();Returns
| Type | Description |
| Bool | True if the user is a manager for this topic. |
GetCanNotify()
Declaration
Bool GetCanNotify()Examples
NSChatTopicAgent thing;
Bool canNotify = thing.GetCanNotify();Returns
| Type | Description |
| Bool | True if the user should receive notifications for this topic. |
GetCanRespond()
True if the user can respond to chats in this topic
Declaration
Bool GetCanRespond()Examples
NSChatTopicAgent thing;
Bool canRespond = thing.GetCanRespond();Returns
| Type | Description |
| Bool |
GetTopicId()
Declaration
Integer GetTopicId()Examples
NSChatTopicAgent thing;
Integer topicId = thing.GetTopicId();Returns
| Type | Description |
| Integer | The reference to the associated chat topic. |
GetUser()
Declaration
NSAssociate GetUser()Examples
NSChatTopicAgent thing;
NSAssociate user = thing.GetUser();Returns
| Type | Description |
| NSAssociate | The associate that is the user agent. |
SetCanListen(Bool)
Declaration
Void SetCanListen(Bool canListen)Examples
NSChatTopicAgent thing;
Bool canListen;
thing.SetCanListen(canListen);Parameters
| Type | Name | Description |
| Bool | canListen | True of a user can listen in on this topic. |
Returns
| Type | Description |
| Void |
SetCanManage(Bool)
Declaration
Void SetCanManage(Bool canManage)Examples
NSChatTopicAgent thing;
Bool canManage;
thing.SetCanManage(canManage);Parameters
| Type | Name | Description |
| Bool | canManage | True if the user is a manager for this topic. |
Returns
| Type | Description |
| Void |
SetCanNotify(Bool)
Declaration
Void SetCanNotify(Bool canNotify)Examples
NSChatTopicAgent thing;
Bool canNotify;
thing.SetCanNotify(canNotify);Parameters
| Type | Name | Description |
| Bool | canNotify | True if the user should receive notifications for this topic. |
Returns
| Type | Description |
| Void |
SetCanRespond(Bool)
Declaration
Void SetCanRespond(Bool canRespond)Examples
NSChatTopicAgent thing;
Bool canRespond;
thing.SetCanRespond(canRespond);Parameters
| Type | Name | Description |
| Bool | canRespond | True if the user can respond to chats in this topic. |
Returns
| Type | Description |
| Void |
SetTopicId(Integer)
Declaration
Void SetTopicId(Integer topicId)Examples
NSChatTopicAgent thing;
Integer topicId;
thing.SetTopicId(topicId);Parameters
| Type | Name | Description |
| Integer | topicId | The reference to the associated chat topic. |
Returns
| Type | Description |
| Void |
SetUser(NSAssociate)
Declaration
Void SetUser(NSAssociate user)Examples
NSChatTopicAgent thing;
NSAssociate user;
thing.SetUser(user);Parameters
| Type | Name | Description |
| NSAssociate | user | The associate that is the user agent. |
Returns
| Type | Description |
| Void |