Class ChatSessionEntity

Chat sessions belong to a chat topic, and contain messages to/from users

Carrier object for ChatSessionEntity. Services for the ChatSessionEntity Carrier is available from the IChatAgent.
Inheritance
Object
ChatSessionEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class ChatSessionEntity : Carrier
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );

Constructors

ChatSessionEntity()

Default constructor

Declaration
public ChatSessionEntity()
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

Properties

AlertLevel

The alert level for this chat session.

Declaration
public virtual int AlertLevel { get; set; }
Property Value
Type Description
Int32
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

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.

Declaration
public virtual bool ChatbotIsActive { get; set; }
Property Value
Type Description
Boolean
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

ChatSessionId

The primary key (auto-incremented)

Declaration
public virtual int ChatSessionId { get; set; }
Property Value
Type Description
Int32
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

Contact

Contact this session is connected to - could be empty if we don't know exactly.

Declaration
public virtual Contact Contact { get; set; }
Property Value
Type Description
Contact
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

CustomerAlias

The alias for the customer.

Declaration
public virtual string CustomerAlias { get; set; }
Property Value
Type Description
String
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

CustomerCompanyName

The name of the customers company, if provided

Declaration
public virtual string CustomerCompanyName { get; set; }
Property Value
Type Description
String
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

CustomerConsented

The customer consented when starting the session

Declaration
public virtual bool CustomerConsented { get; set; }
Property Value
Type Description
Boolean
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

CustomerEmail

The email address of the customer, if provided

Declaration
public virtual string CustomerEmail { get; set; }
Property Value
Type Description
String
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

CustomerHost

The hostname or IP address for the customer.

Declaration
public virtual string CustomerHost { get; set; }
Property Value
Type Description
String
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

CustomerName

The name of customer, if provided

Declaration
public virtual string CustomerName { get; set; }
Property Value
Type Description
String
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

CustomerPhone

The phone number of the customer, if provided

Declaration
public virtual string CustomerPhone { get; set; }
Property Value
Type Description
String
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

FirstMessage

A copy of the first message in the chat session

Declaration
public virtual string FirstMessage { get; set; }
Property Value
Type Description
String
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

Flags

Various flags for the chat session

Declaration
public virtual ChatSessionFlags Flags { get; set; }
Property Value
Type Description
ChatSessionFlags
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

InitialQueuePos

The initial queue pos (i.e. the number of pending sessions + 1) when the session was requested.

Declaration
public virtual int InitialQueuePos { get; set; }
Property Value
Type Description
Int32
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

LastMessage

A copy of the last message in the chat session

Declaration
public virtual string LastMessage { get; set; }
Property Value
Type Description
String
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

Person

Customer person in this session - could be empty if we don't know exactly.

Declaration
public virtual Person Person { get; set; }
Property Value
Type Description
Person
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

Project

Project the session is connectedto - could be empty if we don't know exactly.

Declaration
public virtual Project Project { get; set; }
Property Value
Type Description
Project
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

Rank

Lowest possible unique number for active sessions for user. User for color index. Starting at 1.

Declaration
public virtual int Rank { get; set; }
Property Value
Type Description
Int32
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

Rating

Rating of this chat conversation given by the customer

Declaration
public virtual int Rating { get; set; }
Property Value
Type Description
Int32
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

Sale

Sale the session is connected to - could be empty if we don't know exactly.

Declaration
public virtual Sale Sale { get; set; }
Property Value
Type Description
Sale
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

SessionKey

Key used to authenticate the session.

Declaration
public virtual string SessionKey { get; set; }
Property Value
Type Description
String
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

Status

Enum indicating the status for the session (pending, active, closed, etc).

Declaration
public virtual ChatSessionStatus Status { get; set; }
Property Value
Type Description
ChatSessionStatus
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

Ticket

Ticket the session is connected to - could be empty if we don't know exactly.

Declaration
public virtual Ticket Ticket { get; set; }
Property Value
Type Description
Ticket
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

TopicId

The reference to the associated chat topic.

Declaration
public virtual int TopicId { get; set; }
Property Value
Type Description
Int32
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

TransferTo

User agent that has a pending transfer of the chat session

Declaration
public virtual Associate TransferTo { get; set; }
Property Value
Type Description
Associate
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

User

User agent handling this session

Declaration
public virtual Associate User { get; set; }
Property Value
Type Description
Associate
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

WhenEnded

When the session was ended.

Declaration
public virtual DateTime WhenEnded { get; set; }
Property Value
Type Description
DateTime
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

WhenFetched

The last time the customer's client refetched the data. Used to detect 'dead' session.

Declaration
public virtual DateTime WhenFetched { get; set; }
Property Value
Type Description
DateTime
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

WhenIdle

The last time anyone sent a message for this session.

Declaration
public virtual DateTime WhenIdle { get; set; }
Property Value
Type Description
DateTime
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

WhenRequested

When the session was requested by the customer.

Declaration
public virtual DateTime WhenRequested { get; set; }
Property Value
Type Description
DateTime
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

WhenStarted

When the session was accepted by a user.

Declaration
public virtual DateTime WhenStarted { get; set; }
Property Value
Type Description
DateTime
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
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.
Examples

Get ChatSessionEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Find all ChatSessionEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("ChatSession", "...", null, "getAllRows eq 1", null, 0, 100 );
See Also

See Also