Class NSChatBotSettings
Chat topic bot settings. Trigger script ids to run on bot events. Carrier object for ChatBotSettings.
Syntax
Constructors
NSChatBotSettings()
Initializes a new instance of the NSChatBotSettings class.
Declaration
Methods
GetBotMessageReceivedScriptId()
Declaration
Integer GetBotMessageReceivedScriptId()
Returns
Type |
Description |
Integer |
Script ID to run when new messages received from customer.
|
Examples
NSChatBotSettings thing;
Integer botMessageReceivedScriptId = thing.GetBotMessageReceivedScriptId();
GetBotName()
Declaration
Returns
Type |
Description |
String |
Chatbot name.
|
Examples
NSChatBotSettings thing;
String botName = thing.GetBotName();
GetBotRegisterScriptId()
Declaration
Integer GetBotRegisterScriptId()
Returns
Type |
Description |
Integer |
Script ID to register/unregister chatbot. 0 if there is no bot.
|
Examples
NSChatBotSettings thing;
Integer botRegisterScriptId = thing.GetBotRegisterScriptId();
GetBotSessionChangedScriptId()
Declaration
Integer GetBotSessionChangedScriptId()
Returns
Type |
Description |
Integer |
Script ID to run when session state changes.
|
Examples
NSChatBotSettings thing;
Integer botSessionChangedScriptId = thing.GetBotSessionChangedScriptId();
GetBotSessionCreatedScriptId()
Declaration
Integer GetBotSessionCreatedScriptId()
Returns
Type |
Description |
Integer |
Script ID to run on new session.
|
Examples
NSChatBotSettings thing;
Integer botSessionCreatedScriptId = thing.GetBotSessionCreatedScriptId();
SetBotMessageReceivedScriptId(Integer)
Declaration
Void SetBotMessageReceivedScriptId(Integer botMessageReceivedScriptId)
Parameters
Type |
Name |
Description |
Integer |
botMessageReceivedScriptId |
Script ID to run when new messages received from customer.
|
Returns
Examples
NSChatBotSettings thing;
Integer botMessageReceivedScriptId;
thing.SetBotMessageReceivedScriptId(botMessageReceivedScriptId);
SetBotName(String)
Declaration
Void SetBotName(String botName)
Parameters
Type |
Name |
Description |
String |
botName |
Chatbot name.
|
Returns
Examples
NSChatBotSettings thing;
String botName;
thing.SetBotName(botName);
SetBotRegisterScriptId(Integer)
Declaration
Void SetBotRegisterScriptId(Integer botRegisterScriptId)
Parameters
Type |
Name |
Description |
Integer |
botRegisterScriptId |
Script ID to register/unregister chatbot. 0 if there is no bot.
|
Returns
Examples
NSChatBotSettings thing;
Integer botRegisterScriptId;
thing.SetBotRegisterScriptId(botRegisterScriptId);
SetBotSessionChangedScriptId(Integer)
Declaration
Void SetBotSessionChangedScriptId(Integer botSessionChangedScriptId)
Parameters
Type |
Name |
Description |
Integer |
botSessionChangedScriptId |
Script ID to run when session state changes.
|
Returns
Examples
NSChatBotSettings thing;
Integer botSessionChangedScriptId;
thing.SetBotSessionChangedScriptId(botSessionChangedScriptId);
SetBotSessionCreatedScriptId(Integer)
Declaration
Void SetBotSessionCreatedScriptId(Integer botSessionCreatedScriptId)
Parameters
Type |
Name |
Description |
Integer |
botSessionCreatedScriptId |
Script ID to run on new session.
|
Returns
Examples
NSChatBotSettings thing;
Integer botSessionCreatedScriptId;
thing.SetBotSessionCreatedScriptId(botSessionCreatedScriptId);