> ## 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.

# SuperOffice.WebApi.Data.ChatWidgetSettings

# <a id="SuperOffice_WebApi_Data_ChatWidgetSettings" /> Class ChatWidgetSettings

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

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

```csharp theme={null}
public class ChatWidgetSettings
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[ChatWidgetSettings](SuperOffice.WebApi.Data.ChatWidgetSettings.md)

#### Inherited Members

[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Constructors

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings__ctor" /> ChatWidgetSettings()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public ChatWidgetSettings()
```

## Properties

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_AgentMsgColor" /> AgentMsgColor

Optional color for chat widget agent message

```csharp theme={null}
public virtual string AgentMsgColor { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_AgentMsgTextColor" /> AgentMsgTextColor

Optional color for chat widget agent message text

```csharp theme={null}
public virtual string AgentMsgTextColor { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_AutoFaqCategory" /> AutoFaqCategory

Root folder for FAQ suggestions

```csharp theme={null}
public virtual KbCategory AutoFaqCategory { get; set; }
```

#### Property Value

[KbCategory](SuperOffice.WebApi.Data.KbCategory.md)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_AutoFaqEnabled" /> AutoFaqEnabled

Enable automatic FAQ suggestions

```csharp theme={null}
public virtual bool AutoFaqEnabled { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_BadgeColor" /> BadgeColor

Optional color for chat widget badge

```csharp theme={null}
public virtual string BadgeColor { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_BadgeTextColor" /> BadgeTextColor

Optional color for chat widget badge text

```csharp theme={null}
public virtual string BadgeTextColor { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_ButtonColor" /> ButtonColor

Optional color for chat widget button

```csharp theme={null}
public virtual string ButtonColor { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_ButtonTextColor" /> ButtonTextColor

Optional color for chat widget button text

```csharp theme={null}
public virtual string ButtonTextColor { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_Color" /> Color

The base color of the widget

```csharp theme={null}
public virtual string Color { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_CustMsgColor" /> CustMsgColor

Optional color for chat widget customer message

```csharp theme={null}
public virtual string CustMsgColor { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_CustMsgTextColor" /> CustMsgTextColor

Optional color for chat widget customer message text

```csharp theme={null}
public virtual string CustMsgTextColor { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_Font" /> Font

The font used in the widget

```csharp theme={null}
public virtual string Font { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_FontSize" /> FontSize

Optional size for chat widget font

```csharp theme={null}
public virtual string FontSize { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_LanguageIsoCode" /> LanguageIsoCode

The language ISO code for the widget language

```csharp theme={null}
public virtual string LanguageIsoCode { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_LogoBlobId" /> LogoBlobId

Blob id that contains logo image

```csharp theme={null}
public virtual int LogoBlobId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_LogoEnabled" /> LogoEnabled

Indicates if the logo should be shown in the widget

```csharp theme={null}
public virtual bool LogoEnabled { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_LogoName" /> LogoName

filename/description of logo (from blob)

```csharp theme={null}
public virtual string LogoName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_OfflineFields" /> OfflineFields

Required field when creating ticket in offline mode
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public WidgetRequiredFields? OfflineFields { get; set; }
```

#### Property Value

[WidgetRequiredFields](SuperOffice.WebApi.Data.WidgetRequiredFields.md)?

#### See Also

[ChatWidgetSettings](SuperOffice.WebApi.Data.ChatWidgetSettings.md).[OfflineFields\_String](SuperOffice.WebApi.Data.ChatWidgetSettings.md#SuperOffice_WebApi_Data_ChatWidgetSettings_OfflineFields_String)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_OfflineFields_String" /> OfflineFields\_String

Required field when creating ticket in offline mode
Raw string enum value.

```csharp theme={null}
[JsonProperty("OfflineFields")]
public string OfflineFields_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[ChatWidgetSettings](SuperOffice.WebApi.Data.ChatWidgetSettings.md).[OfflineFields](SuperOffice.WebApi.Data.ChatWidgetSettings.md#SuperOffice_WebApi_Data_ChatWidgetSettings_OfflineFields)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_OfflineHeader" /> OfflineHeader

Offline text shown in widget header

```csharp theme={null}
public virtual string OfflineHeader { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_OfflineMessage" /> OfflineMessage

Offline message shown in widget

```csharp theme={null}
public virtual string OfflineMessage { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_PostFormEnabled" /> PostFormEnabled

Enable post chat form

```csharp theme={null}
public virtual bool PostFormEnabled { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_PostFormHeader" /> PostFormHeader

Header text to show in post chat form

```csharp theme={null}
public virtual string PostFormHeader { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_PostFormMessage" /> PostFormMessage

Message text to show in post chat form

```csharp theme={null}
public virtual string PostFormMessage { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_PostTranscriptEnabled" /> PostTranscriptEnabled

Enable transcript of chat session

```csharp theme={null}
public virtual bool PostTranscriptEnabled { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_PreFormEnabled" /> PreFormEnabled

Enable pre-chat form for anonymous users

```csharp theme={null}
public virtual bool PreFormEnabled { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_PreFormMessage" /> PreFormMessage

Message to be shown in a pre-chat

```csharp theme={null}
public virtual string PreFormMessage { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_RequiredFields" /> RequiredFields

Fields required to start a chat
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public WidgetRequiredFields? RequiredFields { get; set; }
```

#### Property Value

[WidgetRequiredFields](SuperOffice.WebApi.Data.WidgetRequiredFields.md)?

#### See Also

[ChatWidgetSettings](SuperOffice.WebApi.Data.ChatWidgetSettings.md).[RequiredFields\_String](SuperOffice.WebApi.Data.ChatWidgetSettings.md#SuperOffice_WebApi_Data_ChatWidgetSettings_RequiredFields_String)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_RequiredFields_String" /> RequiredFields\_String

Fields required to start a chat
Raw string enum value.

```csharp theme={null}
[JsonProperty("RequiredFields")]
public string RequiredFields_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[ChatWidgetSettings](SuperOffice.WebApi.Data.ChatWidgetSettings.md).[RequiredFields](SuperOffice.WebApi.Data.ChatWidgetSettings.md#SuperOffice_WebApi_Data_ChatWidgetSettings_RequiredFields)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_ShowAgentPhoto" /> ShowAgentPhoto

Use agent photo and name when chatting

```csharp theme={null}
public virtual bool ShowAgentPhoto { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_Size" /> Size

Chat widget size: normal or large.
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public ChatWidgetSize? Size { get; set; }
```

#### Property Value

[ChatWidgetSize](SuperOffice.WebApi.Data.ChatWidgetSize.md)?

#### See Also

[ChatWidgetSettings](SuperOffice.WebApi.Data.ChatWidgetSettings.md).[Size\_String](SuperOffice.WebApi.Data.ChatWidgetSettings.md#SuperOffice_WebApi_Data_ChatWidgetSettings_Size_String)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_Size_String" /> Size\_String

Chat widget size: normal or large.
Raw string enum value.

```csharp theme={null}
[JsonProperty("Size")]
public string Size_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[ChatWidgetSettings](SuperOffice.WebApi.Data.ChatWidgetSettings.md).[Size](SuperOffice.WebApi.Data.ChatWidgetSettings.md#SuperOffice_WebApi_Data_ChatWidgetSettings_Size)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_Theme" /> Theme

Predefined themes for the chat widget
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public WidgetTheme? Theme { get; set; }
```

#### Property Value

[WidgetTheme](SuperOffice.WebApi.Data.WidgetTheme.md)?

#### See Also

[ChatWidgetSettings](SuperOffice.WebApi.Data.ChatWidgetSettings.md).[Theme\_String](SuperOffice.WebApi.Data.ChatWidgetSettings.md#SuperOffice_WebApi_Data_ChatWidgetSettings_Theme_String)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_Theme_String" /> Theme\_String

Predefined themes for the chat widget
Raw string enum value.

```csharp theme={null}
[JsonProperty("Theme")]
public string Theme_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[ChatWidgetSettings](SuperOffice.WebApi.Data.ChatWidgetSettings.md).[Theme](SuperOffice.WebApi.Data.ChatWidgetSettings.md#SuperOffice_WebApi_Data_ChatWidgetSettings_Theme)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_UseAgentFirstname" /> UseAgentFirstname

Whether to use the firstname of the agent in the chat widget.

```csharp theme={null}
public virtual bool UseAgentFirstname { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_WelcomeMessage" /> WelcomeMessage

Short message displayed as long as the request is in queue or active

```csharp theme={null}
public virtual string WelcomeMessage { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatWidgetSettings_WelcomeTitle" /> WelcomeTitle

Short welcome message when user initiates a chat

```csharp theme={null}
public virtual string WelcomeTitle { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

## See Also

[ChatAgent](SuperOffice.WebApi.Agents.ChatAgent.md)


## Related topics

- [SuperOffice.WebApi.Data.ChatTopicEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.ChatTopicEntity.md)
- [SuperOffice.WebApi.Data.ChatWidgetSize](/en/api/reference/webapi/SuperOffice.WebApi.Data.ChatWidgetSize.md)
- [NSChatWidgetSettings](/en/automation/crmscript/reference/CRMScript.NetServer.NSChatWidgetSettings.md)
- [Namespace CRMScript.NetServer](/en/automation/crmscript/reference/CRMScript.NetServer.md)