NSChatTopicEntity - SuperOffice

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()

NSChatTopicEntity

Initializes a new instance of the NSChatTopicEntity class.

Methods

GetAlertRecipient()

String GetAlertRecipient()

Returns: CRMScript.Global.String - The recipients for the alert template. Example:

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

GetAlertTemplate()

NSReplyTemplate GetAlertTemplate()

Returns: CRMScript.NetServer.NSReplyTemplate - Template to use for alerts. Example:

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

GetBadgeHeader()

String GetBadgeHeader()

Returns: CRMScript.Global.String - The badge header of the chat topic. Example:

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

GetBotEnabled()

Bool GetBotEnabled()

Returns: CRMScript.Global.Bool - Enable chatbot on this topic. Run the trigger scripts on bot events. Example:

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

GetBotSettings()

NSChatBotSettings GetBotSettings()

Returns: CRMScript.NetServer.NSChatBotSettings - Settings for chatbot - trigger script IDs to run on bot events. Example:

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

GetChatTopicId()

Integer GetChatTopicId()

Returns: CRMScript.Global.Integer - The primary key (auto-incremented). Example:

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

GetCollectConsent()

Bool GetCollectConsent()

Returns: CRMScript.Global.Bool - Collect consent to store from user. Example:

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

GetCustomQueueText()

String GetCustomQueueText()

Returns: CRMScript.Global.String - A text to be used in the queue message in the chat widget. Usage is controlled by the flags field, bit number 3. Example:

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

GetCustomQueueTextEnabled()

Bool GetCustomQueueTextEnabled()

Returns: CRMScript.Global.Bool - Use the custom queue message text. Example:

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

GetDescription()

String GetDescription()

Returns: CRMScript.Global.String - The description for this topic. Example:

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

GetLanguage()

NSCustomerLanguage GetLanguage()

Returns: CRMScript.NetServer.NSCustomerLanguage - Customer language used in this topic. Optional. Example:

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

GetLastAccept()

DateTime GetLastAccept()

Returns: CRMScript.Global.DateTime - The last time a session was accepted from the inside for this topic. Example:

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

GetName()

String GetName()

Returns: CRMScript.Global.String - The name of this chat topic. Example:

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

GetOpeningHours()

NSChatOpeningHours GetOpeningHours()

Returns: CRMScript.NetServer.NSChatOpeningHours - Opening hours settings. Example:

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

GetOpeningHoursEnabled()

Bool GetOpeningHoursEnabled()

Returns: CRMScript.Global.Bool - Whether to use opening hours or not. Example:

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

GetSecondsPrAccept()

Integer GetSecondsPrAccept()

Returns: CRMScript.Global.Integer - The average number of seconds per accept for this topic. Example:

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

GetTicketCategory()

NSTicketCategory GetTicketCategory()

Returns: CRMScript.NetServer.NSTicketCategory - Category on ticket created from off-line request. Example:

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

GetTicketEnabled()

Bool GetTicketEnabled()

Returns: CRMScript.Global.Bool - Enable ticket submission in offline mode. Example:

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

GetTicketPriority()

NSTicketPriority GetTicketPriority()

Returns: CRMScript.NetServer.NSTicketPriority - Priority on ticket created from off-line request. Example:

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

GetWarnManagerNewChatMinutes()

Integer GetWarnManagerNewChatMinutes()

Returns: CRMScript.Global.Integer - Contains the manager notify time in minutes. Example:

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

GetWarnNewChatMinutes()

Integer GetWarnNewChatMinutes()

Returns: CRMScript.Global.Integer - Contains the user notify time in minutes. Example:

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

GetWelcomeMessage()

String GetWelcomeMessage()

Returns: CRMScript.Global.String - The welcome message sent to the customer when the chat session starts. Example:

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

GetWidget()

NSChatWidgetSettings GetWidget()

Returns: CRMScript.NetServer.NSChatWidgetSettings - Settings for the chat widget. Example:

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

SetAlertRecipient(String)

Void SetAlertRecipient(String alertRecipient)

Returns: CRMScript.Global.Void Example:

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

SetAlertTemplate(NSReplyTemplate)

Void SetAlertTemplate(NSReplyTemplate alertTemplate)

Returns: CRMScript.Global.Void Example:

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

SetBadgeHeader(String)

Void SetBadgeHeader(String badgeHeader)

Returns: CRMScript.Global.Void Example:

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

SetBotEnabled(Bool)

Void SetBotEnabled(Bool botEnabled)

Returns: CRMScript.Global.Void Example:

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

SetBotSettings(NSChatBotSettings)

Void SetBotSettings(NSChatBotSettings botSettings)

Returns: CRMScript.Global.Void Example:

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

SetChatTopicId(Integer)

Void SetChatTopicId(Integer chatTopicId)

Returns: CRMScript.Global.Void Example:

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

SetCollectConsent(Bool)

Void SetCollectConsent(Bool collectConsent)

Returns: CRMScript.Global.Void Example:

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

SetCustomQueueText(String)

Void SetCustomQueueText(String customQueueText)

Returns: CRMScript.Global.Void Example:

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

SetCustomQueueTextEnabled(Bool)

Void SetCustomQueueTextEnabled(Bool customQueueTextEnabled)

Returns: CRMScript.Global.Void Example:

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

SetDescription(String)

Void SetDescription(String description)

Returns: CRMScript.Global.Void Example:

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

SetLanguage(NSCustomerLanguage)

Void SetLanguage(NSCustomerLanguage language)

Returns: CRMScript.Global.Void Example:

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

SetLastAccept(DateTime)

Void SetLastAccept(DateTime lastAccept)

Returns: CRMScript.Global.Void Example:

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

SetName(String)

Void SetName(String name)

Returns: CRMScript.Global.Void Example:

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

SetOpeningHours(NSChatOpeningHours)

Void SetOpeningHours(NSChatOpeningHours openingHours)

Returns: CRMScript.Global.Void Example:

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

SetOpeningHoursEnabled(Bool)

Void SetOpeningHoursEnabled(Bool openingHoursEnabled)

Returns: CRMScript.Global.Void Example:

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

SetSecondsPrAccept(Integer)

Void SetSecondsPrAccept(Integer secondsPrAccept)

Returns: CRMScript.Global.Void Example:

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

SetTicketCategory(NSTicketCategory)

Void SetTicketCategory(NSTicketCategory ticketCategory)

Returns: CRMScript.Global.Void Example:

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

SetTicketEnabled(Bool)

Void SetTicketEnabled(Bool ticketEnabled)

Returns: CRMScript.Global.Void Example:

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

SetTicketPriority(NSTicketPriority)

Void SetTicketPriority(NSTicketPriority ticketPriority)

Returns: CRMScript.Global.Void Example:

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

SetWarnManagerNewChatMinutes(Integer)

Void SetWarnManagerNewChatMinutes(Integer warnManagerNewChatMinutes)

Returns: CRMScript.Global.Void Example:

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

SetWarnNewChatMinutes(Integer)

Void SetWarnNewChatMinutes(Integer warnNewChatMinutes)

Returns: CRMScript.Global.Void Example:

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

SetWelcomeMessage(String)

Void SetWelcomeMessage(String welcomeMessage)

Returns: CRMScript.Global.Void Example:

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

SetWidget(NSChatWidgetSettings)

Void SetWidget(NSChatWidgetSettings widget)

Returns: CRMScript.Global.Void Example:

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

​Constructors

​NSChatTopicEntity()

​Methods

​GetAlertRecipient()

​GetAlertTemplate()

​GetBadgeHeader()

​GetBotEnabled()

​GetBotSettings()

​GetChatTopicId()

​GetCollectConsent()

​GetCustomQueueText()

​GetCustomQueueTextEnabled()

​GetDescription()

​GetLanguage()

​GetLastAccept()

​GetName()

​GetOpeningHours()

​GetOpeningHoursEnabled()

​GetSecondsPrAccept()

​GetTicketCategory()

​GetTicketEnabled()

​GetTicketPriority()

​GetWarnManagerNewChatMinutes()

​GetWarnNewChatMinutes()

​GetWelcomeMessage()

​GetWidget()

​SetAlertRecipient(String)

​SetAlertTemplate(NSReplyTemplate)

​SetBadgeHeader(String)

​SetBotEnabled(Bool)

​SetBotSettings(NSChatBotSettings)

​SetChatTopicId(Integer)

​SetCollectConsent(Bool)

​SetCustomQueueText(String)

​SetCustomQueueTextEnabled(Bool)

​SetDescription(String)

​SetLanguage(NSCustomerLanguage)

​SetLastAccept(DateTime)

​SetName(String)

​SetOpeningHours(NSChatOpeningHours)

​SetOpeningHoursEnabled(Bool)

​SetSecondsPrAccept(Integer)

​SetTicketCategory(NSTicketCategory)

​SetTicketEnabled(Bool)

​SetTicketPriority(NSTicketPriority)

​SetWarnManagerNewChatMinutes(Integer)

​SetWarnNewChatMinutes(Integer)

​SetWelcomeMessage(String)

​SetWidget(NSChatWidgetSettings)

Constructors

NSChatTopicEntity()

Methods

GetAlertRecipient()

GetAlertTemplate()

GetBadgeHeader()

GetBotEnabled()

GetBotSettings()

GetChatTopicId()

GetCollectConsent()

GetCustomQueueText()

GetCustomQueueTextEnabled()

GetDescription()

GetLanguage()

GetLastAccept()

GetName()

GetOpeningHours()

GetOpeningHoursEnabled()

GetSecondsPrAccept()

GetTicketCategory()

GetTicketEnabled()

GetTicketPriority()

GetWarnManagerNewChatMinutes()

GetWarnNewChatMinutes()

GetWelcomeMessage()

GetWidget()

SetAlertRecipient(String)

SetAlertTemplate(NSReplyTemplate)

SetBadgeHeader(String)

SetBotEnabled(Bool)

SetBotSettings(NSChatBotSettings)

SetChatTopicId(Integer)

SetCollectConsent(Bool)

SetCustomQueueText(String)

SetCustomQueueTextEnabled(Bool)

SetDescription(String)

SetLanguage(NSCustomerLanguage)

SetLastAccept(DateTime)

SetName(String)

SetOpeningHours(NSChatOpeningHours)

SetOpeningHoursEnabled(Bool)

SetSecondsPrAccept(Integer)

SetTicketCategory(NSTicketCategory)

SetTicketEnabled(Bool)

SetTicketPriority(NSTicketPriority)

SetWarnManagerNewChatMinutes(Integer)

SetWarnNewChatMinutes(Integer)

SetWelcomeMessage(String)

SetWidget(NSChatWidgetSettings)