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