Class ChatSessionEntity
Namespace: SuperOffice.WebApi.Data
Assembly: SuperOffice.WebApi.dll
Carrier object for ChatSessionEntity.
Chat sessions belong to a chat topic, and contain messages to/from users
Inheritance
object ←
Carrier ←
ChatSessionEntity
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 ChatSessionEntity 123 using the WebApi client:
var configuration = new WebApiConfiguration(url);
var agent = new ChatAgent(configuration);
var chatSessionEntity = agent.GetChatSessionEntity( 123 );
Use :
All ChatSessionEntity: “ChatSession”
Constructors
ChatSessionEntity()
Default constructor - defaults any enum props to 0.
Properties
AlertLevel
The alert level for this chat session.
Property Value
int
ChatSessionId
The primary key (auto-incremented)
Property Value
int
ChatbotIsActive
Indicates that a chatbot is active on the session. This will cause bot triggers to fire. Set to 0 when bot hands off to user.
Property Value
bool
Contact this session is connected to - could be empty if we don’t know exactly.
Property Value
Contact
CustomerAlias
The alias for the customer.
Property Value
string
CustomerCompanyName
The name of the customers company, if provided
Property Value
string
CustomerConsented
The customer consented when starting the session
Property Value
bool
CustomerEmail
The email address of the customer, if provided
Property Value
string
CustomerHost
The hostname or IP address for the customer.
Property Value
string
CustomerName
The name of customer, if provided
Property Value
string
CustomerPhone
The phone number of the customer, if provided
Property Value
string
FirstMessage
A copy of the first message in the chat session
Property Value
string
Flags
Various flags for the chat session
NULL if unknown enum value.
Property Value
ChatSessionFlags?
See Also
ChatSessionEntity.Flags_String
Flags_String
Various flags for the chat session
Raw string enum value.
Property Value
string
See Also
ChatSessionEntity.Flags
InitialQueuePos
The initial queue pos (i.e. the number of pending sessions + 1) when the session was requested.
Property Value
int
LastMessage
A copy of the last message in the chat session
Property Value
string
Person
Customer person in this session - could be empty if we don’t know exactly.
Property Value
Person
Project
Project the session is connectedto - could be empty if we don’t know exactly.
Property Value
Project
Rank
Lowest possible unique number for active sessions for user. User for color index. Starting at 1.
Property Value
int
Rating
Rating of this chat conversation given by the customer
Property Value
int
Sale
Sale the session is connected to - could be empty if we don’t know exactly.
Property Value
Sale
SessionKey
Key used to authenticate the session.
Property Value
string
Status
Enum indicating the status for the session (pending, active, closed, etc).
NULL if unknown enum value.
Property Value
ChatSessionStatus?
See Also
ChatSessionEntity.Status_String
Status_String
Enum indicating the status for the session (pending, active, closed, etc).
Raw string enum value.
Property Value
string
See Also
ChatSessionEntity.Status
Ticket
Ticket the session is connected to - could be empty if we don’t know exactly.
Property Value
Ticket
TopicId
The reference to the associated chat topic.
Property Value
int
TransferTo
User agent that has a pending transfer of the chat session
Property Value
Associate
User
User agent handling this session
Property Value
Associate
WhenEnded
When the session was ended.
Property Value
DateTime
WhenFetched
The last time the customer's client refetched the data. Used to detect 'dead' session.
Property Value
DateTime
WhenIdle
The last time anyone sent a message for this session.
Property Value
DateTime
WhenRequested
When the session was requested by the customer.
Property Value
DateTime
WhenStarted
When the session was accepted by a user.
Property Value
DateTime
See Also
ChatAgent,
ArchiveAgent,
