Class NSChatWidgetSettings

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

Syntax

Constructors

NSChatWidgetSettings()

Initializes a new instance of the NSChatWidgetSettings class.

Declaration

NSChatWidgetSettings

Methods

GetAutoFaqCategory()

Declaration

NSKbCategory GetAutoFaqCategory()

Returns

Type	Description
NSKbCategory	Root folder for FAQ suggestions.

Examples

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

GetAutoFaqEnabled()

Declaration

Bool GetAutoFaqEnabled()

Returns

Type	Description
Bool	Enable automatic FAQ suggestions.

Examples

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

GetColor()

Declaration

String GetColor()

Returns

Type	Description
String	The base color of the widget.

Examples

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

GetFont()

Declaration

String GetFont()

Returns

Type	Description
String	The font used in the widget.

Examples

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

GetLanguageIsoCode()

Declaration

String GetLanguageIsoCode()

Returns

Type	Description
String	The language ISO code for the widget language.

Examples

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

GetLogoBlobId()

Declaration

Integer GetLogoBlobId()

Returns

Type	Description
Integer	Blob ID that contains logo image.

Examples

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

GetLogoEnabled()

Declaration

Bool GetLogoEnabled()

Returns

Type	Description
Bool	Indicates if the logo should be shown in the widget.

Examples

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

GetLogoName()

Declaration

String GetLogoName()

Returns

Type	Description
String	filename/description of logo (from blob).

Examples

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

GetOfflineFields()

Declaration

Integer GetOfflineFields()

Returns

Type	Description
Integer	Required field when creating ticket in offline mode. See WidgetRequiredFields

Examples

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

GetOfflineHeader()

Declaration

String GetOfflineHeader()

Returns

Type	Description
String	Offline text shown in widget header.

Examples

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

GetOfflineMessage()

Declaration

String GetOfflineMessage()

Returns

Type	Description
String	Offline message shown in widget.

Examples

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

GetPostFormEnabled()

Declaration

Bool GetPostFormEnabled()

Returns

Type	Description
Bool	Enable post chat form.

Examples

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

GetPostFormHeader()

Declaration

String GetPostFormHeader()

Returns

Type	Description
String	Header text to show in post chat form.

Examples

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

GetPostFormMessage()

Declaration

String GetPostFormMessage()

Returns

Type	Description
String	Message text to show in post chat form.

Examples

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

GetPostTranscriptEnabled()

Declaration

Bool GetPostTranscriptEnabled()

Returns

Type	Description
Bool	Enable transcript of chat session.

Examples

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

GetPreFormEnabled()

Declaration

Bool GetPreFormEnabled()

Returns

Type	Description
Bool	Enable pre-chat form for anonymous users.

Examples

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

GetPreFormMessage()

Declaration

String GetPreFormMessage()

Returns

Type	Description
String	Message to be shown in a pre-chat.

Examples

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

GetRequiredFields()

Declaration

Integer GetRequiredFields()

Returns

Type	Description
Integer	Fields required to start a chat. See WidgetRequiredFields

Examples

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

GetShowAgentPhoto()

Declaration

Bool GetShowAgentPhoto()

Returns

Type	Description
Bool	Use agent photo and name when chatting.

Examples

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

GetSize()

Declaration

Integer GetSize()

Returns

Type	Description
Integer	Chat widget size - normal or large. See ChatWidgetSize.

Examples

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

GetTheme()

Declaration

Integer GetTheme()

Returns

Type	Description
Integer	Predefined themes for the chat widget. See WidgetTheme

Examples

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

GetWelcomeMessage()

Declaration

String GetWelcomeMessage()

Returns

Type	Description
String	Short message displayed as long as the request is in queue or active.

Examples

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

GetWelcomeTitle()

Declaration

String GetWelcomeTitle()

Returns

Type	Description
String	Short welcome message when user initiates a chat.

Examples

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

SetAutoFaqCategory(NSKbCategory)

Declaration

Void SetAutoFaqCategory(NSKbCategory autoFaqCategory)

Parameters

Type	Name	Description
NSKbCategory	autoFaqCategory	Root folder for FAQ suggestions.

Returns

Type	Description
Void

Examples

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

SetAutoFaqEnabled(Bool)

Declaration

Void SetAutoFaqEnabled(Bool autoFaqEnabled)

Parameters

Type	Name	Description
Bool	autoFaqEnabled	Enable automatic FAQ suggestions.

Returns

Type	Description
Void

Examples

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

SetColor(String)

Declaration

Void SetColor(String color)

Parameters

Type	Name	Description
String	color	The base color of the widget.

Returns

Type	Description
Void

Examples

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

SetFont(String)

Declaration

Void SetFont(String font)

Parameters

Type	Name	Description
String	font	The font used in the widget.

Returns

Type	Description
Void

Examples

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

SetLanguageIsoCode(String)

Declaration

Void SetLanguageIsoCode(String languageIsoCode)

Parameters

Type	Name	Description
String	languageIsoCode	The language ISO code for the widget language.

Returns

Type	Description
Void

Examples

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

SetLogoBlobId(Integer)

Declaration

Void SetLogoBlobId(Integer logoBlobId)

Parameters

Type	Name	Description
Integer	logoBlobId	Blob ID that contains logo image.

Returns

Type	Description
Void

Examples

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

SetLogoEnabled(Bool)

Declaration

Void SetLogoEnabled(Bool logoEnabled)

Parameters

Type	Name	Description
Bool	logoEnabled	Indicates if the logo should be shown in the widget.

Returns

Type	Description
Void

Examples

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

SetLogoName(String)

Declaration

Void SetLogoName(String logoName)

Parameters

Type	Name	Description
String	logoName	filename/description of logo (from blob).

Returns

Type	Description
Void

Examples

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

SetOfflineFields(Integer)

Declaration

Void SetOfflineFields(Integer offlineFields)

Parameters

Type	Name	Description
Integer	offlineFields	Required field when creating a ticket in offline mode. See WidgetRequiredFields

Examples

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

SetOfflineHeader(String)

Declaration

Void SetOfflineHeader(String offlineHeader)

Parameters

Type	Name	Description
String	offlineHeader	Offline text shown in widget header.

Returns

Type	Description
Void

Examples

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

SetOfflineMessage(String)

Declaration

Void SetOfflineMessage(String offlineMessage)

Parameters

Type	Name	Description
String	offlineMessage	Offline message shown in widget.

Returns

Type	Description
Void

Examples

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

SetPostFormEnabled(Bool)

Declaration

Void SetPostFormEnabled(Bool postFormEnabled)

Parameters

Type	Name	Description
Bool	postFormEnabled	Enable post chat form.

Returns

Type	Description
Void

Examples

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

SetPostFormHeader(String)

Declaration

Void SetPostFormHeader(String postFormHeader)

Parameters

Type	Name	Description
String	postFormHeader	Header text to show in post chat form.

Returns

Type	Description
Void

Examples

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

SetPostFormMessage(String)

Declaration

Void SetPostFormMessage(String postFormMessage)

Parameters

Type	Name	Description
String	postFormMessage	Message text to show in post chat form.

Returns

Type	Description
Void

Examples

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

SetPostTranscriptEnabled(Bool)

Declaration

Void SetPostTranscriptEnabled(Bool postTranscriptEnabled)

Parameters

Type	Name	Description
Bool	postTranscriptEnabled	Enable transcript of chat session.

Returns

Type	Description
Void

Examples

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

SetPreFormEnabled(Bool)

Declaration

Void SetPreFormEnabled(Bool preFormEnabled)

Parameters

Type	Name	Description
Bool	preFormEnabled	Enable pre-chat form for anonymous users.

Returns

Type	Description
Void

Examples

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

SetPreFormMessage(String)

Declaration

Void SetPreFormMessage(String preFormMessage)

Parameters

Type	Name	Description
String	preFormMessage	Message to be shown in a pre-chat.

Returns

Type	Description
Void

Examples

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

SetRequiredFields(Integer)

Declaration

Void SetRequiredFields(Integer requiredFields)

Parameters

Type	Name	Description
Integer	requiredFields	Fields required to start a chat. See WidgetRequiredFields.

Returns

Type	Description
Void

Examples

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

SetShowAgentPhoto(Bool)

Declaration

Void SetShowAgentPhoto(Bool showAgentPhoto)

Parameters

Type	Name	Description
Bool	showAgentPhoto	Use agent photo and name when chatting.

Returns

Type	Description
Void

Examples

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

SetSize(Integer)

Declaration

Void SetSize(Integer size)

Parameters

Type	Name	Description
Integer	size	Chat widget size - normal or large. See ChatWidgetSize.

Returns

Type	Description
Void

Examples

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

SetTheme(Integer)

Declaration

Void SetTheme(Integer theme)

Parameters

Type	Name	Description
Integer	theme	Predefined themes for the chat widget. See WidgetTheme.

Returns

Type	Description
Void

Examples

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

SetWelcomeMessage(String)

Declaration

Void SetWelcomeMessage(String welcomeMessage)

Parameters

Type	Name	Description
String	welcomeMessage	Short message displayed as long as the request is in queue or active.

Returns

Type	Description
Void

Examples

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

SetWelcomeTitle(String)

Declaration

Void SetWelcomeTitle(String welcomeTitle)

Parameters

Type	Name	Description
String	welcomeTitle	Short welcome message when user initiates a chat.

Returns

Type	Description
Void

Examples

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