Class ChatTopicEntity
Namespace: SuperOffice.WebApi.Data
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.
Inheritance
object ←
Carrier ←
ChatTopicEntity
Inherited Members
Carrier.TableRight,
Carrier.FieldProperties,
object.ToString(),
object.Equals(object),
object.Equals(object, object),
object.ReferenceEquals(object, object),
object.GetHashCode(),
object.GetType(),
object.MemberwiseClone()
Examples
Get ChatTopicEntity 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new ChatAgent(configuration);
var chatTopicEntity = agent.GetChatTopicEntity( 123 );
Use :
Sessions: “ChatSession”
with restriction “chatTopic/chatTopicId eq ” + id
.
Constructors
ChatTopicEntity()
Default constructor - defaults any enum props to 0.
Properties
AlertRecipient
The recipient(s) for the alert template
Property Value
string
AlertTemplate
Template to use for alerts.
Property Value
ReplyTemplate
The badge header of the chat topic
Property Value
string
BotEnabled
Enable chatbot on this topic. Run the trigger scripts on bot events.
Property Value
bool
BotSettings
Settings for chatbot: trigger script ids to run on bot events
Property Value
ChatBotSettings
ChatTopicId
The primary key (auto-incremented)
Property Value
int
CollectConsent
Collect consent to store from user
Property Value
bool
CustomQueueText
A text to be used in the queue message in the chat widget. Usage is controlled by the flags field, bit number 3
Property Value
string
CustomQueueTextEnabled
Use the custom queue message text
Property Value
bool
Description
The descriptiong for this topic.
Property Value
string
Language
Customer language used in this topic. Optional.
Property Value
CustomerLanguage
LastAccept
The last time a session was accepted from the inside for this topic.
Property Value
DateTime
Name
The name of this chat topic
Property Value
string
OfflineCollectConsent
Collect offline consent to store from user
Property Value
bool
The number of customers in the queue before the offline form is available
Property Value
int
The number of minutes in the queue before the offline form is available
Property Value
int
OpeningHours
Opening hours settings
Property Value
ChatOpeningHours
OpeningHoursEnabled
Whether to use opening hours or not.
Property Value
bool
SecondsPrAccept
The average number of seconds per accept for this topic.
Property Value
int
TicketCategory
Category on ticket created from off-line request
Property Value
TicketCategory
TicketEnabled
Enable ticket submission in offline mode
Property Value
bool
TicketPriority
Priority on ticket created from off-line request
Property Value
TicketPriority
Use offline form capability from chat queue
Property Value
bool
WarnChatMessageMinutes
Contains the user notify time in minutes for new chat messages
Property Value
int
WarnManagerChatMessageMinutes
Contains the manager notify time in minutes for new chat messages
Property Value
int
WarnManagerNewChatMinutes
Contains the manager notify time in minutes
Property Value
int
WarnNewChatMinutes
Contains the user notify time in minutes
Property Value
int
WelcomeMessage
The welcome message sent to the customer when the chat session starts.
Property Value
string
Settings for the chat widget
Property Value
ChatWidgetSettings
Enable rating functionality in the chat widgte
Property Value
bool
WidgetRatingText
The text to be displayed in the widget next to the rating stars
Property Value
string
See Also
ChatAgent,
ArchiveAgent,
