NSChatSessionEntity - SuperOffice

Chat sessions belong to a chat topic, and contain messages to/from users. Carrier object for ChatSessionEntity.

Constructors

NSChatSessionEntity()

NSChatSessionEntity

Initializes a new instance of the NSChatSessionEntity class.

Methods

GetAlertLevel()

Integer GetAlertLevel()

Returns: CRMScript.Global.Integer - The alert level for this chat session. Example:

NSChatSessionEntity thing;
Integer alertLevel = thing.GetAlertLevel();

GetChatbotIsActive()

Bool GetChatbotIsActive()

Returns: CRMScript.Global.Bool - 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. Example:

NSChatSessionEntity thing;
Bool chatbotIsActive = thing.GetChatbotIsActive();

GetChatSessionId()

Integer GetChatSessionId()

Returns: CRMScript.Global.Integer - The primary key (auto-incremented). Example:

NSChatSessionEntity thing;
Integer chatSessionId = thing.GetChatSessionId();

GetContact()

NSContact GetContact()

Returns: CRMScript.NetServer.NSContact - Contact this session is connected to. Could be empty if we don’t know exactly. Example:

NSChatSessionEntity thing;
NSContact contact = thing.GetContact();

GetCustomerAlias()

String GetCustomerAlias()

Returns: CRMScript.Global.String - The alias for the customer. Example:

NSChatSessionEntity thing;
String customerAlias = thing.GetCustomerAlias();

GetCustomerCompanyName()

String GetCustomerCompanyName()

Returns: CRMScript.Global.String - The name of the customers company, if provided. Example:

NSChatSessionEntity thing;
String customerCompanyName = thing.GetCustomerCompanyName();

GetCustomerConsented()

Bool GetCustomerConsented()

Returns: CRMScript.Global.Bool - The customer consented when starting the session. Example:

NSChatSessionEntity thing;
Bool customerConsented = thing.GetCustomerConsented();

GetCustomerEmail()

String GetCustomerEmail()

Returns: CRMScript.Global.String - The email address of the customer, if provided. Example:

NSChatSessionEntity thing;
String customerEmail = thing.GetCustomerEmail();

GetCustomerHost()

String GetCustomerHost()

Returns: CRMScript.Global.String - The hostname or IP address for the customer. Example:

NSChatSessionEntity thing;
String customerHost = thing.GetCustomerHost();

GetCustomerName()

String GetCustomerName()

Returns: CRMScript.Global.String - The name of customer, if provided. Example:

NSChatSessionEntity thing;
String customerName = thing.GetCustomerName();

GetCustomerPhone()

String GetCustomerPhone()

Returns: CRMScript.Global.String - The phone number of the customer, if provided. Example:

NSChatSessionEntity thing;
String customerPhone = thing.GetCustomerPhone();

GetFirstMessage()

String GetFirstMessage()

Returns: CRMScript.Global.String - A copy of the first message in the chat session. Example:

NSChatSessionEntity thing;
String firstMessage = thing.GetFirstMessage();

GetFlags()

Integer GetFlags()

Returns: CRMScript.Global.Integer - Various flags for the chat session. See <xref href=“CRMScript.NetServer.ChatSessionFlags” data-throw-if-not-resolved=“false”></xref>. Example:

NSChatSessionEntity thing;
Integer flags = thing.GetFlags();

GetInitialQueuePos()

Integer GetInitialQueuePos()

Returns: CRMScript.Global.Integer - The initial queue pos (the number of pending sessions + 1) when the session was requested. Example:

NSChatSessionEntity thing;
Integer initialQueuePos = thing.GetInitialQueuePos();

GetLastMessage()

String GetLastMessage()

Returns: CRMScript.Global.String - A copy of the last message in the chat session. Example:

NSChatSessionEntity thing;
String lastMessage = thing.GetLastMessage();

GetPerson()

NSPerson GetPerson()

Returns: CRMScript.NetServer.NSPerson - Customer person in this session. Could be empty if we don’t know exactly. Example:

NSChatSessionEntity thing;
NSPerson person = thing.GetPerson();

GetProject()

NSProject GetProject()

Returns: CRMScript.NetServer.NSProject - Project the session is connected to. Could be empty if we don’t know exactly. Example:

NSChatSessionEntity thing;
NSProject project = thing.GetProject();

GetRank()

Integer GetRank()

Returns: CRMScript.Global.Integer - Lowest possible unique number for active sessions for user. User for color index. Starting at 1. Example:

NSChatSessionEntity thing;
Integer rank = thing.GetRank();

GetSale()

NSSale GetSale()

Returns: CRMScript.NetServer.NSSale - Sale the session is connected to. Could be empty if we don’t know exactly. Example:

NSChatSessionEntity thing;
NSSale sale = thing.GetSale();

GetSessionKey()

String GetSessionKey()

Returns: CRMScript.Global.String - Key used to authenticate the session. Example:

NSChatSessionEntity thing;
String sessionKey = thing.GetSessionKey();

GetStatus()

Integer GetStatus()

Returns: CRMScript.Global.Integer - The status for the session. See <xref href=“CRMScript.NetServer.ChatSessionStatus” data-throw-if-not-resolved=“false”></xref>. Example:

NSChatSessionEntity thing;
Integer status = thing.GetStatus();

GetTicket()

NSTicket GetTicket()

Returns: CRMScript.NetServer.NSTicket - Ticket the session is connected to. Could be empty if we don’t know exactly. Example:

NSChatSessionEntity thing;
NSTicket ticket = thing.GetTicket();

GetTopicId()

Integer GetTopicId()

Returns: CRMScript.Global.Integer - The reference to the associated chat topic. Example:

NSChatSessionEntity thing;
Integer topicId = thing.GetTopicId();

GetTransferTo()

NSAssociate GetTransferTo()

Returns: CRMScript.NetServer.NSAssociate - User agent that has a pending transfer of the chat session. Example:

NSChatSessionEntity thing;
NSAssociate transferTo = thing.GetTransferTo();

GetUser()

NSAssociate GetUser()

Returns: CRMScript.NetServer.NSAssociate - User agent handling this session. Example:

NSChatSessionEntity thing;
NSAssociate user = thing.GetUser();

GetWhenEnded()

DateTime GetWhenEnded()

Returns: CRMScript.Global.DateTime - When the session was ended. Example:

NSChatSessionEntity thing;
DateTime whenEnded = thing.GetWhenEnded();

GetWhenFetched()

DateTime GetWhenFetched()

Returns: CRMScript.Global.DateTime - The last time the customer’s client re-fetched the data. Used to detect dead session. Example:

NSChatSessionEntity thing;
DateTime whenFetched = thing.GetWhenFetched();

GetWhenIdle()

DateTime GetWhenIdle()

Returns: CRMScript.Global.DateTime - The last time anyone sent a message for this session. Example:

NSChatSessionEntity thing;
DateTime whenIdle = thing.GetWhenIdle();

GetWhenRequested()

DateTime GetWhenRequested()

Returns: CRMScript.Global.DateTime - When the session was requested by the customer. Example:

NSChatSessionEntity thing;
DateTime whenRequested = thing.GetWhenRequested();

GetWhenStarted()

DateTime GetWhenStarted()

Returns: CRMScript.Global.DateTime - When the session was accepted by a user. Example:

NSChatSessionEntity thing;
DateTime whenStarted = thing.GetWhenStarted();

SetAlertLevel(Integer)

Void SetAlertLevel(Integer alertLevel)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
Integer alertLevel;
thing.SetAlertLevel(alertLevel);

SetChatbotIsActive(Bool)

Void SetChatbotIsActive(Bool chatbotIsActive)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
Bool chatbotIsActive;
thing.SetChatbotIsActive(chatbotIsActive);

SetChatSessionId(Integer)

Void SetChatSessionId(Integer chatSessionId)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
Integer chatSessionId;
thing.SetChatSessionId(chatSessionId);

SetContact(NSContact)

Void SetContact(NSContact contact)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
NSContact contact;
thing.SetContact(contact);

SetCustomerAlias(String)

Void SetCustomerAlias(String customerAlias)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
String customerAlias;
thing.SetCustomerAlias(customerAlias);

SetCustomerCompanyName(String)

Void SetCustomerCompanyName(String customerCompanyName)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
String customerCompanyName;
thing.SetCustomerCompanyName(customerCompanyName);

SetCustomerConsented(Bool)

Void SetCustomerConsented(Bool customerConsented)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
Bool customerConsented;
thing.SetCustomerConsented(customerConsented);

SetCustomerEmail(String)

Void SetCustomerEmail(String customerEmail)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
String customerEmail;
thing.SetCustomerEmail(customerEmail);

SetCustomerHost(String)

Void SetCustomerHost(String customerHost)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
String customerHost;
thing.SetCustomerHost(customerHost);

SetCustomerName(String)

Void SetCustomerName(String customerName)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
String customerName;
thing.SetCustomerName(customerName);

SetCustomerPhone(String)

Void SetCustomerPhone(String customerPhone)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
String customerPhone;
thing.SetCustomerPhone(customerPhone);

SetFirstMessage(String)

Void SetFirstMessage(String firstMessage)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
String firstMessage;
thing.SetFirstMessage(firstMessage);

SetFlags(Integer)

Void SetFlags(Integer flags)

Returns: CRMScript.Global.Void

Example:

NSChatSessionEntity thing;
Integer flags;
thing.SetFlags(flags);

SetInitialQueuePos(Integer)

Void SetInitialQueuePos(Integer initialQueuePos)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
Integer initialQueuePos;
thing.SetInitialQueuePos(initialQueuePos);

SetLastMessage(String)

Void SetLastMessage(String lastMessage)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
String lastMessage;
thing.SetLastMessage(lastMessage);

SetPerson(NSPerson)

Void SetPerson(NSPerson person)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
NSPerson person;
thing.SetPerson(person);

SetProject(NSProject)

Void SetProject(NSProject project)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
NSProject project;
thing.SetProject(project);

SetRank(Integer)

Void SetRank(Integer rank)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
Integer rank;
thing.SetRank(rank);

SetSale(NSSale)

Void SetSale(NSSale sale)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
NSSale sale;
thing.SetSale(sale);

SetSessionKey(String)

Void SetSessionKey(String sessionKey)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
String sessionKey;
thing.SetSessionKey(sessionKey);

SetStatus(Integer)

Void SetStatus(Integer status)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
Integer status;
thing.SetStatus(status);

SetTicket(NSTicket)

Void SetTicket(NSTicket ticket)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
NSTicket ticket;
thing.SetTicket(ticket);

SetTopicId(Integer)

Void SetTopicId(Integer topicId)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
Integer topicId;
thing.SetTopicId(topicId);

SetTransferTo(NSAssociate)

Void SetTransferTo(NSAssociate transferTo)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
NSAssociate transferTo;
thing.SetTransferTo(transferTo);

SetUser(NSAssociate)

Void SetUser(NSAssociate user)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
NSAssociate user;
thing.SetUser(user);

SetWhenEnded(DateTime)

Void SetWhenEnded(DateTime whenEnded)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
DateTime whenEnded;
thing.SetWhenEnded(whenEnded);

SetWhenFetched(DateTime)

Void SetWhenFetched(DateTime whenFetched)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
DateTime whenFetched;
thing.SetWhenFetched(whenFetched);

SetWhenIdle(DateTime)

Void SetWhenIdle(DateTime whenIdle)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
DateTime whenIdle;
thing.SetWhenIdle(whenIdle);

SetWhenRequested(DateTime)

Void SetWhenRequested(DateTime whenRequested)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
DateTime whenRequested;
thing.SetWhenRequested(whenRequested);

SetWhenStarted(DateTime)

Void SetWhenStarted(DateTime whenStarted)

Returns: CRMScript.Global.Void Example:

NSChatSessionEntity thing;
DateTime whenStarted;
thing.SetWhenStarted(whenStarted);

​Constructors

​NSChatSessionEntity()

​Methods

​GetAlertLevel()

​GetChatbotIsActive()

​GetChatSessionId()

​GetContact()

​GetCustomerAlias()

​GetCustomerCompanyName()

​GetCustomerConsented()

​GetCustomerEmail()

​GetCustomerHost()

​GetCustomerName()

​GetCustomerPhone()

​GetFirstMessage()

​GetFlags()

​GetInitialQueuePos()

​GetLastMessage()

​GetPerson()

​GetProject()

​GetRank()

​GetSale()

​GetSessionKey()

​GetStatus()

​GetTicket()

​GetTopicId()

​GetTransferTo()

​GetUser()

​GetWhenEnded()

​GetWhenFetched()

​GetWhenIdle()

​GetWhenRequested()

​GetWhenStarted()

​SetAlertLevel(Integer)

​SetChatbotIsActive(Bool)

​SetChatSessionId(Integer)

​SetContact(NSContact)

​SetCustomerAlias(String)

​SetCustomerCompanyName(String)

​SetCustomerConsented(Bool)

​SetCustomerEmail(String)

​SetCustomerHost(String)

​SetCustomerName(String)

​SetCustomerPhone(String)

​SetFirstMessage(String)

​SetFlags(Integer)

​SetInitialQueuePos(Integer)

​SetLastMessage(String)

​SetPerson(NSPerson)

​SetProject(NSProject)

​SetRank(Integer)

​SetSale(NSSale)

​SetSessionKey(String)

​SetStatus(Integer)

​SetTicket(NSTicket)

​SetTopicId(Integer)

​SetTransferTo(NSAssociate)

​SetUser(NSAssociate)

​SetWhenEnded(DateTime)

​SetWhenFetched(DateTime)

​SetWhenIdle(DateTime)

​SetWhenRequested(DateTime)

​SetWhenStarted(DateTime)

Constructors

NSChatSessionEntity()

Methods

GetAlertLevel()

GetChatbotIsActive()

GetChatSessionId()

GetContact()

GetCustomerAlias()

GetCustomerCompanyName()

GetCustomerConsented()

GetCustomerEmail()

GetCustomerHost()

GetCustomerName()

GetCustomerPhone()

GetFirstMessage()

GetFlags()

GetInitialQueuePos()

GetLastMessage()

GetPerson()

GetProject()

GetRank()

GetSale()

GetSessionKey()

GetStatus()

GetTicket()

GetTopicId()

GetTransferTo()

GetUser()

GetWhenEnded()

GetWhenFetched()

GetWhenIdle()

GetWhenRequested()

GetWhenStarted()

SetAlertLevel(Integer)

SetChatbotIsActive(Bool)

SetChatSessionId(Integer)

SetContact(NSContact)

SetCustomerAlias(String)

SetCustomerCompanyName(String)

SetCustomerConsented(Bool)

SetCustomerEmail(String)

SetCustomerHost(String)

SetCustomerName(String)

SetCustomerPhone(String)

SetFirstMessage(String)

SetFlags(Integer)

SetInitialQueuePos(Integer)

SetLastMessage(String)

SetPerson(NSPerson)

SetProject(NSProject)

SetRank(Integer)

SetSale(NSSale)

SetSessionKey(String)

SetStatus(Integer)

SetTicket(NSTicket)

SetTopicId(Integer)

SetTransferTo(NSAssociate)

SetUser(NSAssociate)

SetWhenEnded(DateTime)

SetWhenFetched(DateTime)

SetWhenIdle(DateTime)

SetWhenRequested(DateTime)

SetWhenStarted(DateTime)