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.

Syntax

Constructors

NSChatTopicEntity()

Initializes a new instance of the NSChatTopicEntity class.

Declaration

NSChatTopicEntity

Methods

GetAlertRecipient()

Declaration

String GetAlertRecipient()

Returns

Type	Description
String	The recipients for the alert template.

Examples

NSChatTopicEntity thing;
String alertRecipient = thing.GetAlertRecipient();

GetAlertTemplate()

Declaration

NSReplyTemplate GetAlertTemplate()

Returns

Type	Description
NSReplyTemplate	Template to use for alerts.

Examples

NSChatTopicEntity thing;
NSReplyTemplate alertTemplate = thing.GetAlertTemplate();

GetBadgeHeader()

Declaration

String GetBadgeHeader()

Returns

Type	Description
String	The badge header of the chat topic.

Examples

NSChatTopicEntity thing;
String badgeHeader = thing.GetBadgeHeader();

GetBotEnabled()

Declaration

Bool GetBotEnabled()

Returns

Type	Description
Bool	Enable chatbot on this topic. Run the trigger scripts on bot events.

Examples

NSChatTopicEntity thing;
Bool botEnabled = thing.GetBotEnabled();

GetBotSettings()

Declaration

NSChatBotSettings GetBotSettings()

Returns

Type	Description
NSChatBotSettings	Settings for chatbot - trigger script IDs to run on bot events.

Examples

NSChatTopicEntity thing;
NSChatBotSettings botSettings = thing.GetBotSettings();

GetChatTopicId()

Declaration

Integer GetChatTopicId()

Returns

Type	Description
Integer	The primary key (auto-incremented).

Examples

NSChatTopicEntity thing;
Integer chatTopicId = thing.GetChatTopicId();

GetCollectConsent()

Declaration

Bool GetCollectConsent()

Returns

Type	Description
Bool	Collect consent to store from user.

Examples

NSChatTopicEntity thing;
Bool collectConsent = thing.GetCollectConsent();

GetCustomQueueText()

Declaration

String 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.

Examples

NSChatTopicEntity thing;
String customQueueText = thing.GetCustomQueueText();

GetCustomQueueTextEnabled()

Declaration

Bool GetCustomQueueTextEnabled()

Returns

Type	Description
Bool	Use the custom queue message text.

Examples

NSChatTopicEntity thing;
Bool customQueueTextEnabled = thing.GetCustomQueueTextEnabled();

GetDescription()

Declaration

String GetDescription()

Returns

Type	Description
String	The description for this topic.

Examples

NSChatTopicEntity thing;
String description = thing.GetDescription();

GetLanguage()

Declaration

NSCustomerLanguage GetLanguage()

Returns

Type	Description
NSCustomerLanguage	Customer language used in this topic. Optional.

Examples

NSChatTopicEntity thing;
NSCustomerLanguage language = thing.GetLanguage();

GetLastAccept()

Declaration

DateTime GetLastAccept()

Returns

Type	Description
DateTime	The last time a session was accepted from the inside for this topic.

Examples

NSChatTopicEntity thing;
DateTime lastAccept = thing.GetLastAccept();

GetName()

Declaration

String GetName()

Returns

Type	Description
String	The name of this chat topic.

Examples

NSChatTopicEntity thing;
String name = thing.GetName();

GetOpeningHours()

Declaration

NSChatOpeningHours GetOpeningHours()

Returns

Type	Description
NSChatOpeningHours	Opening hours settings.

Examples

NSChatTopicEntity thing;
NSChatOpeningHours openingHours = thing.GetOpeningHours();

GetOpeningHoursEnabled()

Declaration

Bool GetOpeningHoursEnabled()

Returns

Type	Description
Bool	Whether to use opening hours or not.

Examples

NSChatTopicEntity thing;
Bool openingHoursEnabled = thing.GetOpeningHoursEnabled();

GetSecondsPrAccept()

Declaration

Integer GetSecondsPrAccept()

Returns

Type	Description
Integer	The average number of seconds per accept for this topic.

Examples

NSChatTopicEntity thing;
Integer secondsPrAccept = thing.GetSecondsPrAccept();

GetTicketCategory()

Declaration

NSTicketCategory GetTicketCategory()

Returns

Type	Description
NSTicketCategory	Category on ticket created from off-line request.

Examples

NSChatTopicEntity thing;
NSTicketCategory ticketCategory = thing.GetTicketCategory();

GetTicketEnabled()

Declaration

Bool GetTicketEnabled()

Returns

Type	Description
Bool	Enable ticket submission in offline mode.

Examples

NSChatTopicEntity thing;
Bool ticketEnabled = thing.GetTicketEnabled();

GetTicketPriority()

Declaration

NSTicketPriority GetTicketPriority()

Returns

Type	Description
NSTicketPriority	Priority on ticket created from off-line request.

Examples

NSChatTopicEntity thing;
NSTicketPriority ticketPriority = thing.GetTicketPriority();

GetWarnManagerNewChatMinutes()

Declaration

Integer GetWarnManagerNewChatMinutes()

Returns

Type	Description
Integer	Contains the manager notify time in minutes.

Examples

NSChatTopicEntity thing;
Integer warnManagerNewChatMinutes = thing.GetWarnManagerNewChatMinutes();

GetWarnNewChatMinutes()

Declaration

Integer GetWarnNewChatMinutes()

Returns

Type	Description
Integer	Contains the user notify time in minutes.

Examples

NSChatTopicEntity thing;
Integer warnNewChatMinutes = thing.GetWarnNewChatMinutes();

GetWelcomeMessage()

Declaration

String GetWelcomeMessage()

Returns

Type	Description
String	The welcome message sent to the customer when the chat session starts.

Examples

NSChatTopicEntity thing;
String welcomeMessage = thing.GetWelcomeMessage();

GetWidget()

Declaration

NSChatWidgetSettings GetWidget()

Returns

Type	Description
NSChatWidgetSettings	Settings for the chat widget.

Examples

NSChatTopicEntity thing;
NSChatWidgetSettings widget = thing.GetWidget();

SetAlertRecipient(String)

Declaration

Void SetAlertRecipient(String alertRecipient)

Parameters

Type	Name	Description
String	alertRecipient	The recipients for the alert template.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
String alertRecipient;
thing.SetAlertRecipient(alertRecipient);

SetAlertTemplate(NSReplyTemplate)

Declaration

Void SetAlertTemplate(NSReplyTemplate alertTemplate)

Parameters

Type	Name	Description
NSReplyTemplate	alertTemplate	Template to use for alerts.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
NSReplyTemplate alertTemplate;
thing.SetAlertTemplate(alertTemplate);

SetBadgeHeader(String)

Declaration

Void SetBadgeHeader(String badgeHeader)

Parameters

Type	Name	Description
String	badgeHeader	The badge header of the chat topic.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
String badgeHeader;
thing.SetBadgeHeader(badgeHeader);

SetBotEnabled(Bool)

Declaration

Void SetBotEnabled(Bool botEnabled)

Parameters

Type	Name	Description
Bool	botEnabled	Enable chatbot on this topic. Run the trigger scripts on bot events.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
Bool botEnabled;
thing.SetBotEnabled(botEnabled);

SetBotSettings(NSChatBotSettings)

Declaration

Void SetBotSettings(NSChatBotSettings botSettings)

Parameters

Type	Name	Description
	botSettings	Settings for chatbot - trigger script ids to run on bot events.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
NSChatBotSettings botSettings;
thing.SetBotSettings(botSettings);

SetChatTopicId(Integer)

Declaration

Void SetChatTopicId(Integer chatTopicId)

Parameters

Type	Name	Description
Integer	chatTopicId	The primary key (auto-incremented).

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
Integer chatTopicId;
thing.SetChatTopicId(chatTopicId);

SetCollectConsent(Bool)

Declaration

Void SetCollectConsent(Bool collectConsent)

Parameters

Type	Name	Description
Bool	collectConsent	Collect consent to store from user.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
Bool collectConsent;
thing.SetCollectConsent(collectConsent);

SetCustomQueueText(String)

Declaration

Void SetCustomQueueText(String 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

Examples

NSChatTopicEntity thing;
String customQueueText;
thing.SetCustomQueueText(customQueueText);

SetCustomQueueTextEnabled(Bool)

Declaration

Void SetCustomQueueTextEnabled(Bool customQueueTextEnabled)

Parameters

Type	Name	Description
Bool	customQueueTextEnabled	Use the custom queue message text.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
Bool customQueueTextEnabled;
thing.SetCustomQueueTextEnabled(customQueueTextEnabled);

SetDescription(String)

Declaration

Void SetDescription(String description)

Parameters

Type	Name	Description
String	description	The description for this topic.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
String description;
thing.SetDescription(description);

SetLanguage(NSCustomerLanguage)

Declaration

Void SetLanguage(NSCustomerLanguage language)

Parameters

Type	Name	Description
NSCustomerLanguage	language	Customer language used in this topic. Optional.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
NSCustomerLanguage language;
thing.SetLanguage(language);

SetLastAccept(DateTime)

Declaration

Void SetLastAccept(DateTime lastAccept)

Parameters

Type	Name	Description
DateTime	lastAccept	The last time a session was accepted from the inside for this topic.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
DateTime lastAccept;
thing.SetLastAccept(lastAccept);

SetName(String)

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	The name of this chat topic.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
String name;
thing.SetName(name);

SetOpeningHours(NSChatOpeningHours)

Declaration

Void SetOpeningHours(NSChatOpeningHours openingHours)

Parameters

Type	Name	Description
NSChatOpeningHours	openingHours	Opening hours settings.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
NSChatOpeningHours openingHours;
thing.SetOpeningHours(openingHours);

SetOpeningHoursEnabled(Bool)

Declaration

Void SetOpeningHoursEnabled(Bool openingHoursEnabled)

Parameters

Type	Name	Description
Bool	openingHoursEnabled	Whether to use opening hours or not.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
Bool openingHoursEnabled;
thing.SetOpeningHoursEnabled(openingHoursEnabled);

SetSecondsPrAccept(Integer)

Declaration

Void SetSecondsPrAccept(Integer secondsPrAccept)

Parameters

Type	Name	Description
Integer	secondsPrAccept	The average number of seconds per accept for this topic.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
Integer secondsPrAccept;
thing.SetSecondsPrAccept(secondsPrAccept);

SetTicketCategory(NSTicketCategory)

Declaration

Void SetTicketCategory(NSTicketCategory ticketCategory)

Parameters

Type	Name	Description
NSTicketCategory	ticketCategory	Category on ticket created from off-line request.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
NSTicketCategory ticketCategory;
thing.SetTicketCategory(ticketCategory);

SetTicketEnabled(Bool)

Declaration

Void SetTicketEnabled(Bool ticketEnabled)

Parameters

Type	Name	Description
Bool	ticketEnabled	Enable ticket submission in offline mode.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
Bool ticketEnabled;
thing.SetTicketEnabled(ticketEnabled);

SetTicketPriority(NSTicketPriority)

Declaration

Void SetTicketPriority(NSTicketPriority ticketPriority)

Parameters

Type	Name	Description
NSTicketPriority	ticketPriority	Priority on ticket created from off-line request.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
NSTicketPriority ticketPriority;
thing.SetTicketPriority(ticketPriority);

SetWarnManagerNewChatMinutes(Integer)

Declaration

Void SetWarnManagerNewChatMinutes(Integer warnManagerNewChatMinutes)

Parameters

Type	Name	Description
Integer	warnManagerNewChatMinutes	Contains the manager notify time in minutes.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
Integer warnManagerNewChatMinutes;
thing.SetWarnManagerNewChatMinutes(warnManagerNewChatMinutes);

SetWarnNewChatMinutes(Integer)

Declaration

Void SetWarnNewChatMinutes(Integer warnNewChatMinutes)

Parameters

Type	Name	Description
Integer	warnNewChatMinutes	Contains the user notify time in minutes.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
Integer warnNewChatMinutes;
thing.SetWarnNewChatMinutes(warnNewChatMinutes);

SetWelcomeMessage(String)

Declaration

Void SetWelcomeMessage(String welcomeMessage)

Parameters

Type	Name	Description
String	welcomeMessage	The welcome message sent to the customer when the chat session starts.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
String welcomeMessage;
thing.SetWelcomeMessage(welcomeMessage);

SetWidget(NSChatWidgetSettings)

Declaration

Void SetWidget(NSChatWidgetSettings widget)

Parameters

Type	Name	Description
NSChatWidgetSettings	widget	Settings for the chat widget.

Returns

Type	Description
Void

Examples

NSChatTopicEntity thing;
NSChatWidgetSettings widget;
thing.SetWidget(widget);