Class NSChatWidgetSettings
Defines the look of the chat widget. Carrier object for ChatWidgetSettings.
Constructors
NSChatWidgetSettings()
Initializes a new instance of the NSChatWidgetSettings class.
Declaration
NSChatWidgetSettingsMethods
GetAutoFaqCategory()
Declaration
NSKbCategory GetAutoFaqCategory()Examples
NSChatWidgetSettings thing;
NSKbCategory autoFaqCategory = thing.GetAutoFaqCategory();Returns
| Type | Description |
| NSKbCategory | Root folder for FAQ suggestions. |
GetAutoFaqEnabled()
Declaration
Bool GetAutoFaqEnabled()Examples
NSChatWidgetSettings thing;
Bool autoFaqEnabled = thing.GetAutoFaqEnabled();Returns
| Type | Description |
| Bool | Enable automatic FAQ suggestions. |
GetColor()
Declaration
String GetColor()Examples
NSChatWidgetSettings thing;
String color = thing.GetColor();Returns
| Type | Description |
| String | The base color of the widget. |
GetFont()
Declaration
String GetFont()Examples
NSChatWidgetSettings thing;
String font = thing.GetFont();Returns
| Type | Description |
| String | The font used in the widget. |
GetLanguageIsoCode()
Declaration
String GetLanguageIsoCode()Examples
NSChatWidgetSettings thing;
String languageIsoCode = thing.GetLanguageIsoCode();Returns
| Type | Description |
| String | The language ISO code for the widget language. |
GetLogoBlobId()
Declaration
Integer GetLogoBlobId()Examples
NSChatWidgetSettings thing;
Integer logoBlobId = thing.GetLogoBlobId();Returns
| Type | Description |
| Integer | Blob ID that contains logo image. |
GetLogoEnabled()
Declaration
Bool GetLogoEnabled()Examples
NSChatWidgetSettings thing;
Bool logoEnabled = thing.GetLogoEnabled();Returns
| Type | Description |
| Bool | Indicates if the logo should be shown in the widget. |
GetLogoName()
Declaration
String GetLogoName()Examples
NSChatWidgetSettings thing;
String logoName = thing.GetLogoName();Returns
| Type | Description |
| String | filename/description of logo (from blob). |
GetOfflineFields()
Declaration
Integer GetOfflineFields()Examples
NSChatWidgetSettings thing;
Integer offlineFields = thing.GetOfflineFields();Returns
| Type | Description |
| Integer | Required field when creating ticket in offline mode. See <xref href="CRMScript.NetServer.WidgetRequiredFields" data-throw-if-not-resolved="false"></xref> |
GetOfflineHeader()
Declaration
String GetOfflineHeader()Examples
NSChatWidgetSettings thing;
String offlineHeader = thing.GetOfflineHeader();Returns
| Type | Description |
| String | Offline text shown in widget header. |
GetOfflineMessage()
Declaration
String GetOfflineMessage()Examples
NSChatWidgetSettings thing;
String offlineMessage = thing.GetOfflineMessage();Returns
| Type | Description |
| String | Offline message shown in widget. |
GetPostFormEnabled()
Declaration
Bool GetPostFormEnabled()Examples
NSChatWidgetSettings thing;
Bool postFormEnabled = thing.GetPostFormEnabled();Returns
| Type | Description |
| Bool | Enable post chat form. |
GetPostFormHeader()
Declaration
String GetPostFormHeader()Examples
NSChatWidgetSettings thing;
String postFormHeader = thing.GetPostFormHeader();Returns
| Type | Description |
| String | Header text to show in post chat form. |
GetPostFormMessage()
Declaration
String GetPostFormMessage()Examples
NSChatWidgetSettings thing;
String postFormMessage = thing.GetPostFormMessage();Returns
| Type | Description |
| String | Message text to show in post chat form. |
GetPostTranscriptEnabled()
Declaration
Bool GetPostTranscriptEnabled()Examples
NSChatWidgetSettings thing;
Bool postTranscriptEnabled = thing.GetPostTranscriptEnabled();Returns
| Type | Description |
| Bool | Enable transcript of chat session. |
GetPreFormEnabled()
Declaration
Bool GetPreFormEnabled()Examples
NSChatWidgetSettings thing;
Bool preFormEnabled = thing.GetPreFormEnabled();Returns
| Type | Description |
| Bool | Enable pre-chat form for anonymous users. |
GetPreFormMessage()
Declaration
String GetPreFormMessage()Examples
NSChatWidgetSettings thing;
String preFormMessage = thing.GetPreFormMessage();Returns
| Type | Description |
| String | Message to be shown in a pre-chat. |
GetRequiredFields()
Declaration
Integer GetRequiredFields()Examples
NSChatWidgetSettings thing;
Integer requiredFields = thing.GetRequiredFields();Returns
| Type | Description |
| Integer | Fields required to start a chat. See <xref href="CRMScript.NetServer.WidgetRequiredFields" data-throw-if-not-resolved="false"></xref> |
GetShowAgentPhoto()
Declaration
Bool GetShowAgentPhoto()Examples
NSChatWidgetSettings thing;
Bool showAgentPhoto = thing.GetShowAgentPhoto();Returns
| Type | Description |
| Bool | Use agent photo and name when chatting. |
GetSize()
Declaration
Integer GetSize()Examples
NSChatWidgetSettings thing;
Integer size = thing.GetSize();Returns
| Type | Description |
| Integer | Chat widget size - normal or large. See <xref href="CRMScript.NetServer.ChatWidgetSize" data-throw-if-not-resolved="false"></xref>. |
GetTheme()
Declaration
Integer GetTheme()Examples
NSChatWidgetSettings thing;
Integer theme = thing.GetTheme();Returns
| Type | Description |
| Integer | Predefined themes for the chat widget. See <xref href="CRMScript.NetServer.WidgetTheme" data-throw-if-not-resolved="false"></xref> |
GetWelcomeMessage()
Declaration
String GetWelcomeMessage()Examples
NSChatWidgetSettings thing;
String welcomeMessage = thing.GetWelcomeMessage();Returns
| Type | Description |
| String | Short message displayed as long as the request is in queue or active. |
GetWelcomeTitle()
Declaration
String GetWelcomeTitle()Examples
NSChatWidgetSettings thing;
String welcomeTitle = thing.GetWelcomeTitle();Returns
| Type | Description |
| String | Short welcome message when user initiates a chat. |
SetAutoFaqCategory(NSKbCategory)
Declaration
Void SetAutoFaqCategory(NSKbCategory autoFaqCategory)Examples
NSChatWidgetSettings thing;
NSKbCategory autoFaqCategory;
thing.SetAutoFaqCategory(autoFaqCategory);Parameters
| Type | Name | Description |
| NSKbCategory | autoFaqCategory | Root folder for FAQ suggestions. |
Returns
| Type | Description |
| Void |
SetAutoFaqEnabled(Bool)
Declaration
Void SetAutoFaqEnabled(Bool autoFaqEnabled)Examples
NSChatWidgetSettings thing;
Bool autoFaqEnabled;
thing.SetAutoFaqEnabled(autoFaqEnabled);Parameters
| Type | Name | Description |
| Bool | autoFaqEnabled | Enable automatic FAQ suggestions. |
Returns
| Type | Description |
| Void |
SetColor(String)
Declaration
Void SetColor(String color)Examples
NSChatWidgetSettings thing;
String color;
thing.SetColor(color);Parameters
| Type | Name | Description |
| String | color | The base color of the widget. |
Returns
| Type | Description |
| Void |
SetFont(String)
Declaration
Void SetFont(String font)Examples
NSChatWidgetSettings thing;
String font;
thing.SetFont(font);Parameters
| Type | Name | Description |
| String | font | The font used in the widget. |
Returns
| Type | Description |
| Void |
SetLanguageIsoCode(String)
Declaration
Void SetLanguageIsoCode(String languageIsoCode)Examples
NSChatWidgetSettings thing;
String languageIsoCode;
thing.SetLanguageIsoCode(languageIsoCode);Parameters
| Type | Name | Description |
| String | languageIsoCode | The language ISO code for the widget language. |
Returns
| Type | Description |
| Void |
SetLogoBlobId(Integer)
Declaration
Void SetLogoBlobId(Integer logoBlobId)Examples
NSChatWidgetSettings thing;
Integer logoBlobId;
thing.SetLogoBlobId(logoBlobId);Parameters
| Type | Name | Description |
| Integer | logoBlobId | Blob ID that contains logo image. |
Returns
| Type | Description |
| Void |
SetLogoEnabled(Bool)
Declaration
Void SetLogoEnabled(Bool logoEnabled)Examples
NSChatWidgetSettings thing;
Bool logoEnabled;
thing.SetLogoEnabled(logoEnabled);Parameters
| Type | Name | Description |
| Bool | logoEnabled | Indicates if the logo should be shown in the widget. |
Returns
| Type | Description |
| Void |
SetLogoName(String)
Declaration
Void SetLogoName(String logoName)Examples
NSChatWidgetSettings thing;
String logoName;
thing.SetLogoName(logoName);Parameters
| Type | Name | Description |
| String | logoName | filename/description of logo (from blob). |
Returns
| Type | Description |
| Void |
SetOfflineFields(Integer)
Declaration
Void SetOfflineFields(Integer offlineFields)Examples
NSChatWidgetSettings thing;
Integer offlineFields;
thing.SetOfflineFields(offlineFields);Parameters
| Type | Name | Description |
| Integer | offlineFields | Required field when creating a ticket in offline mode. See <xref href="CRMScript.NetServer.WidgetRequiredFields" data-throw-if-not-resolved="false"></xref> |
Returns
| Type | Description |
| Void |
SetOfflineHeader(String)
Declaration
Void SetOfflineHeader(String offlineHeader)Examples
NSChatWidgetSettings thing;
String offlineHeader;
thing.SetOfflineHeader(offlineHeader);Parameters
| Type | Name | Description |
| String | offlineHeader | Offline text shown in widget header. |
Returns
| Type | Description |
| Void |
SetOfflineMessage(String)
Declaration
Void SetOfflineMessage(String offlineMessage)Examples
NSChatWidgetSettings thing;
String offlineMessage;
thing.SetOfflineMessage(offlineMessage);Parameters
| Type | Name | Description |
| String | offlineMessage | Offline message shown in widget. |
Returns
| Type | Description |
| Void |
SetPostFormEnabled(Bool)
Declaration
Void SetPostFormEnabled(Bool postFormEnabled)Examples
NSChatWidgetSettings thing;
Bool postFormEnabled;
thing.SetPostFormEnabled(postFormEnabled);Parameters
| Type | Name | Description |
| Bool | postFormEnabled | Enable post chat form. |
Returns
| Type | Description |
| Void |
SetPostFormHeader(String)
Declaration
Void SetPostFormHeader(String postFormHeader)Examples
NSChatWidgetSettings thing;
String postFormHeader;
thing.SetPostFormHeader(postFormHeader);Parameters
| Type | Name | Description |
| String | postFormHeader | Header text to show in post chat form. |
Returns
| Type | Description |
| Void |
SetPostFormMessage(String)
Declaration
Void SetPostFormMessage(String postFormMessage)Examples
NSChatWidgetSettings thing;
String postFormMessage;
thing.SetPostFormMessage(postFormMessage);Parameters
| Type | Name | Description |
| String | postFormMessage | Message text to show in post chat form. |
Returns
| Type | Description |
| Void |
SetPostTranscriptEnabled(Bool)
Declaration
Void SetPostTranscriptEnabled(Bool postTranscriptEnabled)Examples
NSChatWidgetSettings thing;
Bool postTranscriptEnabled;
thing.SetPostTranscriptEnabled(postTranscriptEnabled);Parameters
| Type | Name | Description |
| Bool | postTranscriptEnabled | Enable transcript of chat session. |
Returns
| Type | Description |
| Void |
SetPreFormEnabled(Bool)
Declaration
Void SetPreFormEnabled(Bool preFormEnabled)Examples
NSChatWidgetSettings thing;
Bool preFormEnabled;
thing.SetPreFormEnabled(preFormEnabled);Parameters
| Type | Name | Description |
| Bool | preFormEnabled | Enable pre-chat form for anonymous users. |
Returns
| Type | Description |
| Void |
SetPreFormMessage(String)
Declaration
Void SetPreFormMessage(String preFormMessage)Examples
NSChatWidgetSettings thing;
String preFormMessage;
thing.SetPreFormMessage(preFormMessage);Parameters
| Type | Name | Description |
| String | preFormMessage | Message to be shown in a pre-chat. |
Returns
| Type | Description |
| Void |
SetRequiredFields(Integer)
Declaration
Void SetRequiredFields(Integer requiredFields)Examples
NSChatWidgetSettings thing;
Integer requiredFields;
thing.SetRequiredFields(requiredFields);Parameters
| Type | Name | Description |
| Integer | requiredFields | Fields required to start a chat. See <xref href="CRMScript.NetServer.WidgetRequiredFields" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetShowAgentPhoto(Bool)
Declaration
Void SetShowAgentPhoto(Bool showAgentPhoto)Examples
NSChatWidgetSettings thing;
Bool showAgentPhoto;
thing.SetShowAgentPhoto(showAgentPhoto);Parameters
| Type | Name | Description |
| Bool | showAgentPhoto | Use agent photo and name when chatting. |
Returns
| Type | Description |
| Void |
SetSize(Integer)
Declaration
Void SetSize(Integer size)Examples
NSChatWidgetSettings thing;
Integer size;
thing.SetSize(size);Parameters
| Type | Name | Description |
| Integer | size | Chat widget size - normal or large. See <xref href="CRMScript.NetServer.ChatWidgetSize" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetTheme(Integer)
Declaration
Void SetTheme(Integer theme)Examples
NSChatWidgetSettings thing;
Integer theme;
thing.SetTheme(theme);Parameters
| Type | Name | Description |
| Integer | theme | Predefined themes for the chat widget. See <xref href="CRMScript.NetServer.WidgetTheme" data-throw-if-not-resolved="false"></xref>. |
Returns
| Type | Description |
| Void |
SetWelcomeMessage(String)
Declaration
Void SetWelcomeMessage(String welcomeMessage)Examples
NSChatWidgetSettings thing;
String welcomeMessage;
thing.SetWelcomeMessage(welcomeMessage);Parameters
| Type | Name | Description |
| String | welcomeMessage | Short message displayed as long as the request is in queue or active. |
Returns
| Type | Description |
| Void |
SetWelcomeTitle(String)
Declaration
Void SetWelcomeTitle(String welcomeTitle)Examples
NSChatWidgetSettings thing;
String welcomeTitle;
thing.SetWelcomeTitle(welcomeTitle);Parameters
| Type | Name | Description |
| String | welcomeTitle | Short welcome message when user initiates a chat. |
Returns
| Type | Description |
| Void |