Class ChatTopicEntity

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

Carrier object for ChatTopicEntity. Services for the ChatTopicEntity Carrier is available from the Chat Agent.
Inheritance
object
ChatTopicEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.9.0.0")]
public class ChatTopicEntity : Carrier
Examples

Get ChatTopicEntity 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new ChatAgent();
   var chatTopicEntity = agent.GetChatTopicEntity( 123 );
}

Find all ChatTopicEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var sessions = archive.GetArchiveListByColumns2("ChatSession", "...", null, "chatTopic/chatTopicId eq 123", null, 0, 100 );

Constructors

ChatTopicEntity()

Default constructor

Declaration
public ChatTopicEntity()
See Also

Properties

AlertRecipient

The recipient(s) for the alert template

Declaration
[DataMember]
public virtual string AlertRecipient { get; set; }
Property Value
Type Description
string
See Also

AlertTemplate

Template to use for alerts.

Declaration
[DataMember]
public virtual ReplyTemplate AlertTemplate { get; set; }
Property Value
Type Description
ReplyTemplate
See Also

BadgeHeader

The badge header of the chat topic

Declaration
[DataMember]
public virtual string BadgeHeader { get; set; }
Property Value
Type Description
string
See Also

BotEnabled

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

Declaration
[DataMember]
public virtual bool BotEnabled { get; set; }
Property Value
Type Description
bool
See Also

BotSettings

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

Declaration
[DataMember]
public virtual ChatBotSettings BotSettings { get; set; }
Property Value
Type Description
ChatBotSettings
See Also

ChatTopicId

The primary key (auto-incremented)

Declaration
[DataMember]
public virtual int ChatTopicId { get; set; }
Property Value
Type Description
int
See Also

CollectConsent

Collect consent to store from user

Declaration
[DataMember]
public virtual bool CollectConsent { get; set; }
Property Value
Type Description
bool
See Also

CustomQueueText

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

Declaration
[DataMember]
public virtual string CustomQueueText { get; set; }
Property Value
Type Description
string
See Also

CustomQueueTextEnabled

Use the custom queue message text

Declaration
[DataMember]
public virtual bool CustomQueueTextEnabled { get; set; }
Property Value
Type Description
bool
See Also

Description

The descriptiong for this topic.

Declaration
[DataMember]
public virtual string Description { get; set; }
Property Value
Type Description
string
See Also

Language

Customer language used in this topic. Optional.

Declaration
[DataMember]
public virtual CustomerLanguage Language { get; set; }
Property Value
Type Description
CustomerLanguage
See Also

LastAccept

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

Declaration
[DataMember]
public virtual DateTime LastAccept { get; set; }
Property Value
Type Description
DateTime
See Also

Name

The name of this chat topic

Declaration
[DataMember]
public virtual string Name { get; set; }
Property Value
Type Description
string
See Also

OfflineCollectConsent

Collect offline consent to store from user

Declaration
[DataMember]
public virtual bool OfflineCollectConsent { get; set; }
Property Value
Type Description
bool
See Also

OfflineFormQueueLength

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

Declaration
[DataMember]
public virtual int OfflineFormQueueLength { get; set; }
Property Value
Type Description
int
See Also

OfflineFormTimeLimit

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

Declaration
[DataMember]
public virtual int OfflineFormTimeLimit { get; set; }
Property Value
Type Description
int
See Also

OpeningHours

Opening hours settings

Declaration
[DataMember]
public virtual ChatOpeningHours OpeningHours { get; set; }
Property Value
Type Description
ChatOpeningHours
See Also

OpeningHoursEnabled

Whether to use opening hours or not.

Declaration
[DataMember]
public virtual bool OpeningHoursEnabled { get; set; }
Property Value
Type Description
bool
See Also

SecondsPrAccept

The average number of seconds per accept for this topic.

Declaration
[DataMember]
public virtual int SecondsPrAccept { get; set; }
Property Value
Type Description
int
See Also

TicketCategory

Category on ticket created from off-line request

Declaration
[DataMember]
public virtual TicketCategory TicketCategory { get; set; }
Property Value
Type Description
TicketCategory
See Also

TicketEnabled

Enable ticket submission in offline mode

Declaration
[DataMember]
public virtual bool TicketEnabled { get; set; }
Property Value
Type Description
bool
See Also

TicketPriority

Priority on ticket created from off-line request

Declaration
[DataMember]
public virtual TicketPriority TicketPriority { get; set; }
Property Value
Type Description
TicketPriority
See Also

UseQueueOfflineForm

Use offline form capability from chat queue

Declaration
[DataMember]
public virtual bool UseQueueOfflineForm { get; set; }
Property Value
Type Description
bool
See Also

WarnChatMessageMinutes

Contains the user notify time in minutes for new chat messages

Declaration
[DataMember]
public virtual int WarnChatMessageMinutes { get; set; }
Property Value
Type Description
int
See Also

WarnManagerChatMessageMinutes

Contains the manager notify time in minutes for new chat messages

Declaration
[DataMember]
public virtual int WarnManagerChatMessageMinutes { get; set; }
Property Value
Type Description
int
See Also

WarnManagerNewChatMinutes

Contains the manager notify time in minutes

Declaration
[DataMember]
public virtual int WarnManagerNewChatMinutes { get; set; }
Property Value
Type Description
int
See Also

WarnNewChatMinutes

Contains the user notify time in minutes

Declaration
[DataMember]
public virtual int WarnNewChatMinutes { get; set; }
Property Value
Type Description
int
See Also

WelcomeMessage

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

Declaration
[DataMember]
public virtual string WelcomeMessage { get; set; }
Property Value
Type Description
string
See Also

Widget

Settings for the chat widget

Declaration
[DataMember]
public virtual ChatWidgetSettings Widget { get; set; }
Property Value
Type Description
ChatWidgetSettings
See Also

WidgetEnableRating

Enable rating functionality in the chat widgte

Declaration
[DataMember]
public virtual bool WidgetEnableRating { get; set; }
Property Value
Type Description
bool
See Also

WidgetRatingText

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

Declaration
[DataMember]
public virtual string WidgetRatingText { get; set; }
Property Value
Type Description
string
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.
See Also

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)
Returns
Type Description
string

The carrier contents.
See Also

See Also