NSChatWidgetSettings - SuperOffice

Defines the look of the chat widget. Carrier object for ChatWidgetSettings.

Constructors

NSChatWidgetSettings()

NSChatWidgetSettings

Initializes a new instance of the NSChatWidgetSettings class.

Methods

GetAutoFaqCategory()

NSKbCategory GetAutoFaqCategory()

Returns: CRMScript.NetServer.NSKbCategory - Root folder for FAQ suggestions. Example:

NSChatWidgetSettings thing;
NSKbCategory autoFaqCategory = thing.GetAutoFaqCategory();

GetAutoFaqEnabled()

Bool GetAutoFaqEnabled()

Returns: CRMScript.Global.Bool - Enable automatic FAQ suggestions. Example:

NSChatWidgetSettings thing;
Bool autoFaqEnabled = thing.GetAutoFaqEnabled();

GetColor()

String GetColor()

Returns: CRMScript.Global.String - The base color of the widget. Example:

NSChatWidgetSettings thing;
String color = thing.GetColor();

GetFont()

String GetFont()

Returns: CRMScript.Global.String - The font used in the widget. Example:

NSChatWidgetSettings thing;
String font = thing.GetFont();

GetLanguageIsoCode()

String GetLanguageIsoCode()

Returns: CRMScript.Global.String - The language ISO code for the widget language. Example:

NSChatWidgetSettings thing;
String languageIsoCode = thing.GetLanguageIsoCode();

GetLogoBlobId()

Integer GetLogoBlobId()

Returns: CRMScript.Global.Integer - Blob ID that contains logo image. Example:

NSChatWidgetSettings thing;
Integer logoBlobId = thing.GetLogoBlobId();

GetLogoEnabled()

Bool GetLogoEnabled()

Returns: CRMScript.Global.Bool - Indicates if the logo should be shown in the widget. Example:

NSChatWidgetSettings thing;
Bool logoEnabled = thing.GetLogoEnabled();

GetLogoName()

String GetLogoName()

Returns: CRMScript.Global.String - filename/description of logo (from blob). Example:

NSChatWidgetSettings thing;
String logoName = thing.GetLogoName();

GetOfflineFields()

Integer GetOfflineFields()

Returns: CRMScript.Global.Integer - Required field when creating ticket in offline mode. See <xref href=“CRMScript.NetServer.WidgetRequiredFields” data-throw-if-not-resolved=“false”></xref> Example:

NSChatWidgetSettings thing;
Integer offlineFields = thing.GetOfflineFields();

GetOfflineHeader()

String GetOfflineHeader()

Returns: CRMScript.Global.String - Offline text shown in widget header. Example:

NSChatWidgetSettings thing;
String offlineHeader = thing.GetOfflineHeader();

GetOfflineMessage()

String GetOfflineMessage()

Returns: CRMScript.Global.String - Offline message shown in widget. Example:

NSChatWidgetSettings thing;
String offlineMessage = thing.GetOfflineMessage();

GetPostFormEnabled()

Bool GetPostFormEnabled()

Returns: CRMScript.Global.Bool - Enable post chat form. Example:

NSChatWidgetSettings thing;
Bool postFormEnabled = thing.GetPostFormEnabled();

GetPostFormHeader()

String GetPostFormHeader()

Returns: CRMScript.Global.String - Header text to show in post chat form. Example:

NSChatWidgetSettings thing;
String postFormHeader = thing.GetPostFormHeader();

GetPostFormMessage()

String GetPostFormMessage()

Returns: CRMScript.Global.String - Message text to show in post chat form. Example:

NSChatWidgetSettings thing;
String postFormMessage = thing.GetPostFormMessage();

GetPostTranscriptEnabled()

Bool GetPostTranscriptEnabled()

Returns: CRMScript.Global.Bool - Enable transcript of chat session. Example:

NSChatWidgetSettings thing;
Bool postTranscriptEnabled = thing.GetPostTranscriptEnabled();

GetPreFormEnabled()

Bool GetPreFormEnabled()

Returns: CRMScript.Global.Bool - Enable pre-chat form for anonymous users. Example:

NSChatWidgetSettings thing;
Bool preFormEnabled = thing.GetPreFormEnabled();

GetPreFormMessage()

String GetPreFormMessage()

Returns: CRMScript.Global.String - Message to be shown in a pre-chat. Example:

NSChatWidgetSettings thing;
String preFormMessage = thing.GetPreFormMessage();

GetRequiredFields()

Integer GetRequiredFields()

Returns: CRMScript.Global.Integer - Fields required to start a chat. See <xref href=“CRMScript.NetServer.WidgetRequiredFields” data-throw-if-not-resolved=“false”></xref> Example:

NSChatWidgetSettings thing;
Integer requiredFields = thing.GetRequiredFields();

GetShowAgentPhoto()

Bool GetShowAgentPhoto()

Returns: CRMScript.Global.Bool - Use agent photo and name when chatting. Example:

NSChatWidgetSettings thing;
Bool showAgentPhoto = thing.GetShowAgentPhoto();

GetSize()

Integer GetSize()

Returns: CRMScript.Global.Integer - Chat widget size - normal or large. See <xref href=“CRMScript.NetServer.ChatWidgetSize” data-throw-if-not-resolved=“false”></xref>. Example:

NSChatWidgetSettings thing;
Integer size = thing.GetSize();

GetTheme()

Integer GetTheme()

Returns: CRMScript.Global.Integer - Predefined themes for the chat widget. See <xref href=“CRMScript.NetServer.WidgetTheme” data-throw-if-not-resolved=“false”></xref> Example:

NSChatWidgetSettings thing;
Integer theme = thing.GetTheme();

GetWelcomeMessage()

String GetWelcomeMessage()

Returns: CRMScript.Global.String - Short message displayed as long as the request is in queue or active. Example:

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

GetWelcomeTitle()

String GetWelcomeTitle()

Returns: CRMScript.Global.String - Short welcome message when user initiates a chat. Example:

NSChatWidgetSettings thing;
String welcomeTitle = thing.GetWelcomeTitle();

SetAutoFaqCategory(NSKbCategory)

Void SetAutoFaqCategory(NSKbCategory autoFaqCategory)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
NSKbCategory autoFaqCategory;
thing.SetAutoFaqCategory(autoFaqCategory);

SetAutoFaqEnabled(Bool)

Void SetAutoFaqEnabled(Bool autoFaqEnabled)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
Bool autoFaqEnabled;
thing.SetAutoFaqEnabled(autoFaqEnabled);

SetColor(String)

Void SetColor(String color)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
String color;
thing.SetColor(color);

SetFont(String)

Void SetFont(String font)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
String font;
thing.SetFont(font);

SetLanguageIsoCode(String)

Void SetLanguageIsoCode(String languageIsoCode)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
String languageIsoCode;
thing.SetLanguageIsoCode(languageIsoCode);

SetLogoBlobId(Integer)

Void SetLogoBlobId(Integer logoBlobId)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
Integer logoBlobId;
thing.SetLogoBlobId(logoBlobId);

SetLogoEnabled(Bool)

Void SetLogoEnabled(Bool logoEnabled)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
Bool logoEnabled;
thing.SetLogoEnabled(logoEnabled);

SetLogoName(String)

Void SetLogoName(String logoName)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
String logoName;
thing.SetLogoName(logoName);

SetOfflineFields(Integer)

Void SetOfflineFields(Integer offlineFields)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
Integer offlineFields;
thing.SetOfflineFields(offlineFields);

SetOfflineHeader(String)

Void SetOfflineHeader(String offlineHeader)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
String offlineHeader;
thing.SetOfflineHeader(offlineHeader);

SetOfflineMessage(String)

Void SetOfflineMessage(String offlineMessage)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
String offlineMessage;
thing.SetOfflineMessage(offlineMessage);

SetPostFormEnabled(Bool)

Void SetPostFormEnabled(Bool postFormEnabled)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
Bool postFormEnabled;
thing.SetPostFormEnabled(postFormEnabled);

SetPostFormHeader(String)

Void SetPostFormHeader(String postFormHeader)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
String postFormHeader;
thing.SetPostFormHeader(postFormHeader);

SetPostFormMessage(String)

Void SetPostFormMessage(String postFormMessage)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
String postFormMessage;
thing.SetPostFormMessage(postFormMessage);

SetPostTranscriptEnabled(Bool)

Void SetPostTranscriptEnabled(Bool postTranscriptEnabled)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
Bool postTranscriptEnabled;
thing.SetPostTranscriptEnabled(postTranscriptEnabled);

SetPreFormEnabled(Bool)

Void SetPreFormEnabled(Bool preFormEnabled)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
Bool preFormEnabled;
thing.SetPreFormEnabled(preFormEnabled);

SetPreFormMessage(String)

Void SetPreFormMessage(String preFormMessage)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
String preFormMessage;
thing.SetPreFormMessage(preFormMessage);

SetRequiredFields(Integer)

Void SetRequiredFields(Integer requiredFields)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
Integer requiredFields;
thing.SetRequiredFields(requiredFields);

SetShowAgentPhoto(Bool)

Void SetShowAgentPhoto(Bool showAgentPhoto)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
Bool showAgentPhoto;
thing.SetShowAgentPhoto(showAgentPhoto);

SetSize(Integer)

Void SetSize(Integer size)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
Integer size;
thing.SetSize(size);

SetTheme(Integer)

Void SetTheme(Integer theme)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
Integer theme;
thing.SetTheme(theme);

SetWelcomeMessage(String)

Void SetWelcomeMessage(String welcomeMessage)

Returns: CRMScript.Global.Void Example:

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

SetWelcomeTitle(String)

Void SetWelcomeTitle(String welcomeTitle)

Returns: CRMScript.Global.Void Example:

NSChatWidgetSettings thing;
String welcomeTitle;
thing.SetWelcomeTitle(welcomeTitle);

​Constructors

​NSChatWidgetSettings()

​Methods

​GetAutoFaqCategory()

​GetAutoFaqEnabled()

​GetColor()

​GetFont()

​GetLanguageIsoCode()

​GetLogoBlobId()

​GetLogoEnabled()

​GetLogoName()

​GetOfflineFields()

​GetOfflineHeader()

​GetOfflineMessage()

​GetPostFormEnabled()

​GetPostFormHeader()

​GetPostFormMessage()

​GetPostTranscriptEnabled()

​GetPreFormEnabled()

​GetPreFormMessage()

​GetRequiredFields()

​GetShowAgentPhoto()

​GetSize()

​GetTheme()

​GetWelcomeMessage()

​GetWelcomeTitle()

​SetAutoFaqCategory(NSKbCategory)

​SetAutoFaqEnabled(Bool)

​SetColor(String)

​SetFont(String)

​SetLanguageIsoCode(String)

​SetLogoBlobId(Integer)

​SetLogoEnabled(Bool)

​SetLogoName(String)

​SetOfflineFields(Integer)

​SetOfflineHeader(String)

​SetOfflineMessage(String)

​SetPostFormEnabled(Bool)

​SetPostFormHeader(String)

​SetPostFormMessage(String)

​SetPostTranscriptEnabled(Bool)

​SetPreFormEnabled(Bool)

​SetPreFormMessage(String)

​SetRequiredFields(Integer)

​SetShowAgentPhoto(Bool)

​SetSize(Integer)

​SetTheme(Integer)

​SetWelcomeMessage(String)

​SetWelcomeTitle(String)

Constructors

NSChatWidgetSettings()

Methods

GetAutoFaqCategory()

GetAutoFaqEnabled()

GetColor()

GetFont()

GetLanguageIsoCode()

GetLogoBlobId()

GetLogoEnabled()

GetLogoName()

GetOfflineFields()

GetOfflineHeader()

GetOfflineMessage()

GetPostFormEnabled()

GetPostFormHeader()

GetPostFormMessage()

GetPostTranscriptEnabled()

GetPreFormEnabled()

GetPreFormMessage()

GetRequiredFields()

GetShowAgentPhoto()

GetSize()

GetTheme()

GetWelcomeMessage()

GetWelcomeTitle()

SetAutoFaqCategory(NSKbCategory)

SetAutoFaqEnabled(Bool)

SetColor(String)

SetFont(String)

SetLanguageIsoCode(String)

SetLogoBlobId(Integer)

SetLogoEnabled(Bool)

SetLogoName(String)

SetOfflineFields(Integer)

SetOfflineHeader(String)

SetOfflineMessage(String)

SetPostFormEnabled(Bool)

SetPostFormHeader(String)

SetPostFormMessage(String)

SetPostTranscriptEnabled(Bool)

SetPreFormEnabled(Bool)

SetPreFormMessage(String)

SetRequiredFields(Integer)

SetShowAgentPhoto(Bool)

SetSize(Integer)

SetTheme(Integer)

SetWelcomeMessage(String)

SetWelcomeTitle(String)