> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# NSChatWidgetSettings

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

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

## Constructors

### NSChatWidgetSettings()

```crmscript theme={null}
NSChatWidgetSettings
```

Initializes a new instance of the NSChatWidgetSettings class.

## Methods

## GetAutoFaqCategory()

```crmscript theme={null}
NSKbCategory GetAutoFaqCategory()
```

**Returns:** [CRMScript.NetServer.NSKbCategory](CRMScript.NetServer.NSKbCategory) - Root folder for FAQ suggestions.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
NSKbCategory autoFaqCategory = thing.GetAutoFaqCategory();
```

## GetAutoFaqEnabled()

```crmscript theme={null}
Bool GetAutoFaqEnabled()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Enable automatic FAQ suggestions.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Bool autoFaqEnabled = thing.GetAutoFaqEnabled();
```

## GetColor()

```crmscript theme={null}
String GetColor()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The base color of the widget.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String color = thing.GetColor();
```

## GetFont()

```crmscript theme={null}
String GetFont()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The font used in the widget.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String font = thing.GetFont();
```

## GetLanguageIsoCode()

```crmscript theme={null}
String GetLanguageIsoCode()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The language ISO code for the widget language.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String languageIsoCode = thing.GetLanguageIsoCode();
```

## GetLogoBlobId()

```crmscript theme={null}
Integer GetLogoBlobId()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Blob ID that contains logo image.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Integer logoBlobId = thing.GetLogoBlobId();
```

## GetLogoEnabled()

```crmscript theme={null}
Bool GetLogoEnabled()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Indicates if the logo should be shown in the widget.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Bool logoEnabled = thing.GetLogoEnabled();
```

## GetLogoName()

```crmscript theme={null}
String GetLogoName()
```

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

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String logoName = thing.GetLogoName();
```

## GetOfflineFields()

```crmscript theme={null}
Integer GetOfflineFields()
```

**Returns:** [CRMScript.Global.Integer](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:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Integer offlineFields = thing.GetOfflineFields();
```

## GetOfflineHeader()

```crmscript theme={null}
String GetOfflineHeader()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Offline text shown in widget header.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String offlineHeader = thing.GetOfflineHeader();
```

## GetOfflineMessage()

```crmscript theme={null}
String GetOfflineMessage()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Offline message shown in widget.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String offlineMessage = thing.GetOfflineMessage();
```

## GetPostFormEnabled()

```crmscript theme={null}
Bool GetPostFormEnabled()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Enable post chat form.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Bool postFormEnabled = thing.GetPostFormEnabled();
```

## GetPostFormHeader()

```crmscript theme={null}
String GetPostFormHeader()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Header text to show in post chat form.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String postFormHeader = thing.GetPostFormHeader();
```

## GetPostFormMessage()

```crmscript theme={null}
String GetPostFormMessage()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Message text to show in post chat form.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String postFormMessage = thing.GetPostFormMessage();
```

## GetPostTranscriptEnabled()

```crmscript theme={null}
Bool GetPostTranscriptEnabled()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Enable transcript of chat session.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Bool postTranscriptEnabled = thing.GetPostTranscriptEnabled();
```

## GetPreFormEnabled()

```crmscript theme={null}
Bool GetPreFormEnabled()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Enable pre-chat form for anonymous users.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Bool preFormEnabled = thing.GetPreFormEnabled();
```

## GetPreFormMessage()

```crmscript theme={null}
String GetPreFormMessage()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Message to be shown in a pre-chat.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String preFormMessage = thing.GetPreFormMessage();
```

## GetRequiredFields()

```crmscript theme={null}
Integer GetRequiredFields()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Fields required to start a chat. See \<xref href="CRMScript.NetServer.WidgetRequiredFields" data-throw-if-not-resolved="false">\</xref>

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Integer requiredFields = thing.GetRequiredFields();
```

## GetShowAgentPhoto()

```crmscript theme={null}
Bool GetShowAgentPhoto()
```

**Returns:** [CRMScript.Global.Bool](CRMScript.Global.Bool) - Use agent photo and name when chatting.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Bool showAgentPhoto = thing.GetShowAgentPhoto();
```

## GetSize()

```crmscript theme={null}
Integer GetSize()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Chat widget size - normal or large. See \<xref href="CRMScript.NetServer.ChatWidgetSize" data-throw-if-not-resolved="false">\</xref>.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Integer size = thing.GetSize();
```

## GetTheme()

```crmscript theme={null}
Integer GetTheme()
```

**Returns:** [CRMScript.Global.Integer](CRMScript.Global.Integer) - Predefined themes for the chat widget. See \<xref href="CRMScript.NetServer.WidgetTheme" data-throw-if-not-resolved="false">\</xref>

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Integer theme = thing.GetTheme();
```

## GetWelcomeMessage()

```crmscript theme={null}
String GetWelcomeMessage()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Short message displayed as long as the request is in queue or active.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String welcomeMessage = thing.GetWelcomeMessage();
```

## GetWelcomeTitle()

```crmscript theme={null}
String GetWelcomeTitle()
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - Short welcome message when user initiates a chat.

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String welcomeTitle = thing.GetWelcomeTitle();
```

## SetAutoFaqCategory(NSKbCategory)

```crmscript theme={null}
Void SetAutoFaqCategory(NSKbCategory autoFaqCategory)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
NSKbCategory autoFaqCategory;
thing.SetAutoFaqCategory(autoFaqCategory);
```

## SetAutoFaqEnabled(Bool)

```crmscript theme={null}
Void SetAutoFaqEnabled(Bool autoFaqEnabled)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Bool autoFaqEnabled;
thing.SetAutoFaqEnabled(autoFaqEnabled);
```

## SetColor(String)

```crmscript theme={null}
Void SetColor(String color)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String color;
thing.SetColor(color);
```

## SetFont(String)

```crmscript theme={null}
Void SetFont(String font)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String font;
thing.SetFont(font);
```

## SetLanguageIsoCode(String)

```crmscript theme={null}
Void SetLanguageIsoCode(String languageIsoCode)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String languageIsoCode;
thing.SetLanguageIsoCode(languageIsoCode);
```

## SetLogoBlobId(Integer)

```crmscript theme={null}
Void SetLogoBlobId(Integer logoBlobId)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Integer logoBlobId;
thing.SetLogoBlobId(logoBlobId);
```

## SetLogoEnabled(Bool)

```crmscript theme={null}
Void SetLogoEnabled(Bool logoEnabled)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Bool logoEnabled;
thing.SetLogoEnabled(logoEnabled);
```

## SetLogoName(String)

```crmscript theme={null}
Void SetLogoName(String logoName)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String logoName;
thing.SetLogoName(logoName);
```

## SetOfflineFields(Integer)

```crmscript theme={null}
Void SetOfflineFields(Integer offlineFields)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Integer offlineFields;
thing.SetOfflineFields(offlineFields);
```

## SetOfflineHeader(String)

```crmscript theme={null}
Void SetOfflineHeader(String offlineHeader)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String offlineHeader;
thing.SetOfflineHeader(offlineHeader);
```

## SetOfflineMessage(String)

```crmscript theme={null}
Void SetOfflineMessage(String offlineMessage)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String offlineMessage;
thing.SetOfflineMessage(offlineMessage);
```

## SetPostFormEnabled(Bool)

```crmscript theme={null}
Void SetPostFormEnabled(Bool postFormEnabled)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Bool postFormEnabled;
thing.SetPostFormEnabled(postFormEnabled);
```

## SetPostFormHeader(String)

```crmscript theme={null}
Void SetPostFormHeader(String postFormHeader)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String postFormHeader;
thing.SetPostFormHeader(postFormHeader);
```

## SetPostFormMessage(String)

```crmscript theme={null}
Void SetPostFormMessage(String postFormMessage)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String postFormMessage;
thing.SetPostFormMessage(postFormMessage);
```

## SetPostTranscriptEnabled(Bool)

```crmscript theme={null}
Void SetPostTranscriptEnabled(Bool postTranscriptEnabled)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Bool postTranscriptEnabled;
thing.SetPostTranscriptEnabled(postTranscriptEnabled);
```

## SetPreFormEnabled(Bool)

```crmscript theme={null}
Void SetPreFormEnabled(Bool preFormEnabled)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Bool preFormEnabled;
thing.SetPreFormEnabled(preFormEnabled);
```

## SetPreFormMessage(String)

```crmscript theme={null}
Void SetPreFormMessage(String preFormMessage)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String preFormMessage;
thing.SetPreFormMessage(preFormMessage);
```

## SetRequiredFields(Integer)

```crmscript theme={null}
Void SetRequiredFields(Integer requiredFields)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Integer requiredFields;
thing.SetRequiredFields(requiredFields);
```

## SetShowAgentPhoto(Bool)

```crmscript theme={null}
Void SetShowAgentPhoto(Bool showAgentPhoto)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Bool showAgentPhoto;
thing.SetShowAgentPhoto(showAgentPhoto);
```

## SetSize(Integer)

```crmscript theme={null}
Void SetSize(Integer size)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Integer size;
thing.SetSize(size);
```

## SetTheme(Integer)

```crmscript theme={null}
Void SetTheme(Integer theme)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
Integer theme;
thing.SetTheme(theme);
```

## SetWelcomeMessage(String)

```crmscript theme={null}
Void SetWelcomeMessage(String welcomeMessage)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String welcomeMessage;
thing.SetWelcomeMessage(welcomeMessage);
```

## SetWelcomeTitle(String)

```crmscript theme={null}
Void SetWelcomeTitle(String welcomeTitle)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

**Example:**

```crmscript theme={null}
NSChatWidgetSettings thing;
String welcomeTitle;
thing.SetWelcomeTitle(welcomeTitle);
```


## Related topics

- [NSChatTopicEntity](/en/automation/crmscript/reference/CRMScript.NetServer.NSChatTopicEntity.md)
- [Namespace CRMScript.NetServer](/en/automation/crmscript/reference/CRMScript.NetServer.md)
- [SuperOffice.WebApi.Data.ChatWidgetSettings](/en/api/reference/webapi/SuperOffice.WebApi.Data.ChatWidgetSettings.md)
- [Create a chat channel](/en/chat/admin/channel-create.md)