Class NSChatTopicEntity
Chat topics define who is assigned, when the channel is open for business, and look of the chat widget. Carrier object for ChatTopicEntity.
Constructors
NSChatTopicEntity()
Initializes a new instance of the NSChatTopicEntity class.
Declaration
NSChatTopicEntityMethods
GetAlertRecipient()
Declaration
String GetAlertRecipient()Examples
NSChatTopicEntity thing;
String alertRecipient = thing.GetAlertRecipient();Returns
| Type | Description |
| String | The recipients for the alert template. |
GetAlertTemplate()
Declaration
NSReplyTemplate GetAlertTemplate()Examples
NSChatTopicEntity thing;
NSReplyTemplate alertTemplate = thing.GetAlertTemplate();Returns
| Type | Description |
| NSReplyTemplate | Template to use for alerts. |
GetBadgeHeader()
Declaration
String GetBadgeHeader()Examples
NSChatTopicEntity thing;
String badgeHeader = thing.GetBadgeHeader();Returns
| Type | Description |
| String | The badge header of the chat topic. |
GetBotEnabled()
Declaration
Bool GetBotEnabled()Examples
NSChatTopicEntity thing;
Bool botEnabled = thing.GetBotEnabled();Returns
| Type | Description |
| Bool | Enable chatbot on this topic. Run the trigger scripts on bot events. |
GetBotSettings()
Declaration
NSChatBotSettings GetBotSettings()Examples
NSChatTopicEntity thing;
NSChatBotSettings botSettings = thing.GetBotSettings();Returns
| Type | Description |
| NSChatBotSettings | Settings for chatbot - trigger script IDs to run on bot events. |
GetChatTopicId()
Declaration
Integer GetChatTopicId()Examples
NSChatTopicEntity thing;
Integer chatTopicId = thing.GetChatTopicId();Returns
| Type | Description |
| Integer | The primary key (auto-incremented). |
GetCollectConsent()
Declaration
Bool GetCollectConsent()Examples
NSChatTopicEntity thing;
Bool collectConsent = thing.GetCollectConsent();Returns
| Type | Description |
| Bool | Collect consent to store from user. |
GetCustomQueueText()
Declaration
String GetCustomQueueText()Examples
NSChatTopicEntity thing;
String customQueueText = thing.GetCustomQueueText();Returns
| Type | Description |
| String | A text to be used in the queue message in the chat widget. Usage is controlled by the flags field, bit number 3. |
GetCustomQueueTextEnabled()
Declaration
Bool GetCustomQueueTextEnabled()Examples
NSChatTopicEntity thing;
Bool customQueueTextEnabled = thing.GetCustomQueueTextEnabled();Returns
| Type | Description |
| Bool | Use the custom queue message text. |
GetDescription()
Declaration
String GetDescription()Examples
NSChatTopicEntity thing;
String description = thing.GetDescription();Returns
| Type | Description |
| String | The description for this topic. |
GetLanguage()
Declaration
NSCustomerLanguage GetLanguage()Examples
NSChatTopicEntity thing;
NSCustomerLanguage language = thing.GetLanguage();Returns
| Type | Description |
| NSCustomerLanguage | Customer language used in this topic. Optional. |
GetLastAccept()
Declaration
DateTime GetLastAccept()Examples
NSChatTopicEntity thing;
DateTime lastAccept = thing.GetLastAccept();Returns
| Type | Description |
| DateTime | The last time a session was accepted from the inside for this topic. |
GetName()
Declaration
String GetName()Examples
NSChatTopicEntity thing;
String name = thing.GetName();Returns
| Type | Description |
| String | The name of this chat topic. |
GetOpeningHours()
Declaration
NSChatOpeningHours GetOpeningHours()Examples
NSChatTopicEntity thing;
NSChatOpeningHours openingHours = thing.GetOpeningHours();Returns
| Type | Description |
| NSChatOpeningHours | Opening hours settings. |
GetOpeningHoursEnabled()
Declaration
Bool GetOpeningHoursEnabled()Examples
NSChatTopicEntity thing;
Bool openingHoursEnabled = thing.GetOpeningHoursEnabled();Returns
| Type | Description |
| Bool | Whether to use opening hours or not. |
GetSecondsPrAccept()
Declaration
Integer GetSecondsPrAccept()Examples
NSChatTopicEntity thing;
Integer secondsPrAccept = thing.GetSecondsPrAccept();Returns
| Type | Description |
| Integer | The average number of seconds per accept for this topic. |
GetTicketCategory()
Declaration
NSTicketCategory GetTicketCategory()Examples
NSChatTopicEntity thing;
NSTicketCategory ticketCategory = thing.GetTicketCategory();Returns
| Type | Description |
| NSTicketCategory | Category on ticket created from off-line request. |
GetTicketEnabled()
Declaration
Bool GetTicketEnabled()Examples
NSChatTopicEntity thing;
Bool ticketEnabled = thing.GetTicketEnabled();Returns
| Type | Description |
| Bool | Enable ticket submission in offline mode. |
GetTicketPriority()
Declaration
NSTicketPriority GetTicketPriority()Examples
NSChatTopicEntity thing;
NSTicketPriority ticketPriority = thing.GetTicketPriority();Returns
| Type | Description |
| NSTicketPriority | Priority on ticket created from off-line request. |
GetWarnManagerNewChatMinutes()
Declaration
Integer GetWarnManagerNewChatMinutes()Examples
NSChatTopicEntity thing;
Integer warnManagerNewChatMinutes = thing.GetWarnManagerNewChatMinutes();Returns
| Type | Description |
| Integer | Contains the manager notify time in minutes. |
GetWarnNewChatMinutes()
Declaration
Integer GetWarnNewChatMinutes()Examples
NSChatTopicEntity thing;
Integer warnNewChatMinutes = thing.GetWarnNewChatMinutes();Returns
| Type | Description |
| Integer | Contains the user notify time in minutes. |
GetWelcomeMessage()
Declaration
String GetWelcomeMessage()Examples
NSChatTopicEntity thing;
String welcomeMessage = thing.GetWelcomeMessage();Returns
| Type | Description |
| String | The welcome message sent to the customer when the chat session starts. |
GetWidget()
Declaration
NSChatWidgetSettings GetWidget()Examples
NSChatTopicEntity thing;
NSChatWidgetSettings widget = thing.GetWidget();Returns
| Type | Description |
| NSChatWidgetSettings | Settings for the chat widget. |
SetAlertRecipient(String)
Declaration
Void SetAlertRecipient(String alertRecipient)Examples
NSChatTopicEntity thing;
String alertRecipient;
thing.SetAlertRecipient(alertRecipient);Parameters
| Type | Name | Description |
| String | alertRecipient | The recipients for the alert template. |
Returns
| Type | Description |
| Void |
SetAlertTemplate(NSReplyTemplate)
Declaration
Void SetAlertTemplate(NSReplyTemplate alertTemplate)Examples
NSChatTopicEntity thing;
NSReplyTemplate alertTemplate;
thing.SetAlertTemplate(alertTemplate);Parameters
| Type | Name | Description |
| NSReplyTemplate | alertTemplate | Template to use for alerts. |
Returns
| Type | Description |
| Void |
SetBadgeHeader(String)
Declaration
Void SetBadgeHeader(String badgeHeader)Examples
NSChatTopicEntity thing;
String badgeHeader;
thing.SetBadgeHeader(badgeHeader);Parameters
| Type | Name | Description |
| String | badgeHeader | The badge header of the chat topic. |
Returns
| Type | Description |
| Void |
SetBotEnabled(Bool)
Declaration
Void SetBotEnabled(Bool botEnabled)Examples
NSChatTopicEntity thing;
Bool botEnabled;
thing.SetBotEnabled(botEnabled);Parameters
| Type | Name | Description |
| Bool | botEnabled | Enable chatbot on this topic. Run the trigger scripts on bot events. |
Returns
| Type | Description |
| Void |
SetBotSettings(NSChatBotSettings)
Declaration
Void SetBotSettings(NSChatBotSettings botSettings)Examples
NSChatTopicEntity thing;
NSChatBotSettings botSettings;
thing.SetBotSettings(botSettings);Parameters
| Type | Name | Description |
| botSettings | Settings for chatbot - trigger script ids to run on bot events. |
Returns
| Type | Description |
| Void |
SetChatTopicId(Integer)
Declaration
Void SetChatTopicId(Integer chatTopicId)Examples
NSChatTopicEntity thing;
Integer chatTopicId;
thing.SetChatTopicId(chatTopicId);Parameters
| Type | Name | Description |
| Integer | chatTopicId | The primary key (auto-incremented). |
Returns
| Type | Description |
| Void |
SetCollectConsent(Bool)
Declaration
Void SetCollectConsent(Bool collectConsent)Examples
NSChatTopicEntity thing;
Bool collectConsent;
thing.SetCollectConsent(collectConsent);Parameters
| Type | Name | Description |
| Bool | collectConsent | Collect consent to store from user. |
Returns
| Type | Description |
| Void |
SetCustomQueueText(String)
Declaration
Void SetCustomQueueText(String customQueueText)Examples
NSChatTopicEntity thing;
String customQueueText;
thing.SetCustomQueueText(customQueueText);Parameters
| Type | Name | Description |
| String | customQueueText | A text to be used in the queue message in the chat widget. Usage is controlled by the flags field, bit number 3. |
Returns
| Type | Description |
| Void |
SetCustomQueueTextEnabled(Bool)
Declaration
Void SetCustomQueueTextEnabled(Bool customQueueTextEnabled)Examples
NSChatTopicEntity thing;
Bool customQueueTextEnabled;
thing.SetCustomQueueTextEnabled(customQueueTextEnabled);Parameters
| Type | Name | Description |
| Bool | customQueueTextEnabled | Use the custom queue message text. |
Returns
| Type | Description |
| Void |
SetDescription(String)
Declaration
Void SetDescription(String description)Examples
NSChatTopicEntity thing;
String description;
thing.SetDescription(description);Parameters
| Type | Name | Description |
| String | description | The description for this topic. |
Returns
| Type | Description |
| Void |
SetLanguage(NSCustomerLanguage)
Declaration
Void SetLanguage(NSCustomerLanguage language)Examples
NSChatTopicEntity thing;
NSCustomerLanguage language;
thing.SetLanguage(language);Parameters
| Type | Name | Description |
| NSCustomerLanguage | language | Customer language used in this topic. Optional. |
Returns
| Type | Description |
| Void |
SetLastAccept(DateTime)
Declaration
Void SetLastAccept(DateTime lastAccept)Examples
NSChatTopicEntity thing;
DateTime lastAccept;
thing.SetLastAccept(lastAccept);Parameters
| Type | Name | Description |
| DateTime | lastAccept | The last time a session was accepted from the inside for this topic. |
Returns
| Type | Description |
| Void |
SetName(String)
Declaration
Void SetName(String name)Examples
NSChatTopicEntity thing;
String name;
thing.SetName(name);Parameters
| Type | Name | Description |
| String | name | The name of this chat topic. |
Returns
| Type | Description |
| Void |
SetOpeningHours(NSChatOpeningHours)
Declaration
Void SetOpeningHours(NSChatOpeningHours openingHours)Examples
NSChatTopicEntity thing;
NSChatOpeningHours openingHours;
thing.SetOpeningHours(openingHours);Parameters
| Type | Name | Description |
| NSChatOpeningHours | openingHours | Opening hours settings. |
Returns
| Type | Description |
| Void |
SetOpeningHoursEnabled(Bool)
Declaration
Void SetOpeningHoursEnabled(Bool openingHoursEnabled)Examples
NSChatTopicEntity thing;
Bool openingHoursEnabled;
thing.SetOpeningHoursEnabled(openingHoursEnabled);Parameters
| Type | Name | Description |
| Bool | openingHoursEnabled | Whether to use opening hours or not. |
Returns
| Type | Description |
| Void |
SetSecondsPrAccept(Integer)
Declaration
Void SetSecondsPrAccept(Integer secondsPrAccept)Examples
NSChatTopicEntity thing;
Integer secondsPrAccept;
thing.SetSecondsPrAccept(secondsPrAccept);Parameters
| Type | Name | Description |
| Integer | secondsPrAccept | The average number of seconds per accept for this topic. |
Returns
| Type | Description |
| Void |
SetTicketCategory(NSTicketCategory)
Declaration
Void SetTicketCategory(NSTicketCategory ticketCategory)Examples
NSChatTopicEntity thing;
NSTicketCategory ticketCategory;
thing.SetTicketCategory(ticketCategory);Parameters
| Type | Name | Description |
| NSTicketCategory | ticketCategory | Category on ticket created from off-line request. |
Returns
| Type | Description |
| Void |
SetTicketEnabled(Bool)
Declaration
Void SetTicketEnabled(Bool ticketEnabled)Examples
NSChatTopicEntity thing;
Bool ticketEnabled;
thing.SetTicketEnabled(ticketEnabled);Parameters
| Type | Name | Description |
| Bool | ticketEnabled | Enable ticket submission in offline mode. |
Returns
| Type | Description |
| Void |
SetTicketPriority(NSTicketPriority)
Declaration
Void SetTicketPriority(NSTicketPriority ticketPriority)Examples
NSChatTopicEntity thing;
NSTicketPriority ticketPriority;
thing.SetTicketPriority(ticketPriority);Parameters
| Type | Name | Description |
| NSTicketPriority | ticketPriority | Priority on ticket created from off-line request. |
Returns
| Type | Description |
| Void |
SetWarnManagerNewChatMinutes(Integer)
Declaration
Void SetWarnManagerNewChatMinutes(Integer warnManagerNewChatMinutes)Examples
NSChatTopicEntity thing;
Integer warnManagerNewChatMinutes;
thing.SetWarnManagerNewChatMinutes(warnManagerNewChatMinutes);Parameters
| Type | Name | Description |
| Integer | warnManagerNewChatMinutes | Contains the manager notify time in minutes. |
Returns
| Type | Description |
| Void |
SetWarnNewChatMinutes(Integer)
Declaration
Void SetWarnNewChatMinutes(Integer warnNewChatMinutes)Examples
NSChatTopicEntity thing;
Integer warnNewChatMinutes;
thing.SetWarnNewChatMinutes(warnNewChatMinutes);Parameters
| Type | Name | Description |
| Integer | warnNewChatMinutes | Contains the user notify time in minutes. |
Returns
| Type | Description |
| Void |
SetWelcomeMessage(String)
Declaration
Void SetWelcomeMessage(String welcomeMessage)Examples
NSChatTopicEntity thing;
String welcomeMessage;
thing.SetWelcomeMessage(welcomeMessage);Parameters
| Type | Name | Description |
| String | welcomeMessage | The welcome message sent to the customer when the chat session starts. |
Returns
| Type | Description |
| Void |
SetWidget(NSChatWidgetSettings)
Declaration
Void SetWidget(NSChatWidgetSettings widget)Examples
NSChatTopicEntity thing;
NSChatWidgetSettings widget;
thing.SetWidget(widget);Parameters
| Type | Name | Description |
| NSChatWidgetSettings | widget | Settings for the chat widget. |
Returns
| Type | Description |
| Void |