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

# <a id="SuperOffice_WebApi_Data_ChatTopicEntity" /> Class ChatTopicEntity

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

Carrier object for ChatTopicEntity.
Chat topics define who is assigned, when the channel is open for business, and look of the chat widget.

```csharp theme={null}
public class ChatTopicEntity : Carrier
```

#### Inheritance

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

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[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)

## Examples

Get ChatTopicEntity 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new ChatAgent(configuration);
var chatTopicEntity = agent.GetChatTopicEntity( 123 );</code></pre>

## Remarks

Use <xref href="SuperOffice.CRM.Services.ArchiveAgent?text=Archive+agent" data-throw-if-not-resolved="false" />:
Sessions: <pre><code class="lang-csharp">"ChatSession"</code></pre> with restriction <pre><code class="lang-csharp">"chatTopic/chatTopicId eq " + id</code></pre>.

## Constructors

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity__ctor" /> ChatTopicEntity()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_AlertRecipient" /> AlertRecipient

The recipient(s) for the alert template

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_AlertTemplate" /> AlertTemplate

Template to use for alerts.

```csharp theme={null}
public virtual ReplyTemplate AlertTemplate { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_BadgeHeader" /> BadgeHeader

The badge header of the chat topic

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_BotEnabled" /> BotEnabled

Enable chatbot on this topic. Run the trigger scripts on bot events.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_BotSettings" /> BotSettings

Settings for chatbot: trigger script ids to run on bot events

```csharp theme={null}
public virtual ChatBotSettings BotSettings { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_ChatTopicId" /> ChatTopicId

The primary key (auto-incremented)

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_CollectConsent" /> CollectConsent

Collect consent to store from user

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_CustomQueueText" /> CustomQueueText

A text to be used in the queue message in the chat widget. Usage is controlled by the flags field, bit number 3

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_CustomQueueTextEnabled" /> CustomQueueTextEnabled

Use the custom queue message text

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_Description" /> Description

The descriptiong for this topic.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_Language" /> Language

Customer language used in this topic. Optional.

```csharp theme={null}
public virtual CustomerLanguage Language { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_LastAccept" /> LastAccept

The last time a session was accepted from the inside for this topic.

```csharp theme={null}
public virtual DateTime LastAccept { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_Name" /> Name

The name of this chat topic

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_OfflineCollectConsent" /> OfflineCollectConsent

Collect offline consent to store from user

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_OfflineFormQueueLength" /> OfflineFormQueueLength

The number of customers in the queue before the offline form is available

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_OfflineFormTimeLimit" /> OfflineFormTimeLimit

The number of minutes in the queue before the offline form is available

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_OpeningHours" /> OpeningHours

Opening hours settings

```csharp theme={null}
public virtual ChatOpeningHours OpeningHours { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_OpeningHoursEnabled" /> OpeningHoursEnabled

Whether to use opening hours or not.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_SecondsPrAccept" /> SecondsPrAccept

The average number of seconds per accept for this topic.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_TicketCategory" /> TicketCategory

Category on ticket created from off-line request

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_TicketEnabled" /> TicketEnabled

Enable ticket submission in offline mode

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_TicketPriority" /> TicketPriority

Priority on ticket created from off-line request

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_UseQueueOfflineForm" /> UseQueueOfflineForm

Use offline form capability from chat queue

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_WarnChatMessageMinutes" /> WarnChatMessageMinutes

Contains the user notify time in minutes for new chat messages

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_WarnManagerChatMessageMinutes" /> WarnManagerChatMessageMinutes

Contains the manager notify time in minutes for new chat messages

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_WarnManagerNewChatMinutes" /> WarnManagerNewChatMinutes

Contains the manager notify time in minutes

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_WarnNewChatMinutes" /> WarnNewChatMinutes

Contains the user notify time in minutes

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

#### Property Value

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

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

The welcome message sent to the customer when the chat session starts.

```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_ChatTopicEntity_Widget" /> Widget

Settings for the chat widget

```csharp theme={null}
public virtual ChatWidgetSettings Widget { get; set; }
```

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_WidgetEnableRating" /> WidgetEnableRating

Enable rating functionality in the chat widgte

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatTopicEntity_WidgetRatingText" /> WidgetRatingText

The text to be displayed in the widget next to the rating stars

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

#### Property Value

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

## See Also

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


## Related topics

- [SuperOffice.WebApi.Agents.ChatAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ChatAgent.md)
- [SuperOffice.WebApi.Agents.IChatAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IChatAgent.md)
- [SuperOffice.WebApi.Data.ChatSessionEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.ChatSessionEntity.md)
- [SuperOffice.WebApi.Data.ChatTopicAgent](/en/api/reference/webapi/SuperOffice.WebApi.Data.ChatTopicAgent.md)
- [SuperOffice.WebApi.Data.Chat ChatTopicsForUserRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Chat_ChatTopicsForUserRequest.md)
- [SuperOffice.WebApi.Data.Chat CreateChatSessionForTopicRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Chat_CreateChatSessionForTopicRequest.md)