Class NSChatAgent

NSChatAgent()

Chat functions. Manage chat channels, sessions, and messages.

Declaration

NSChatAgent

NSChatAgent agent;
agent.callMethod(arg1, arg2);

AcceptChatSessionTransfer(Integer)

Accept the transfer: assign the session to the user. If the session is not being transferred, nothing happens.

Declaration

NSChatSessionEntity AcceptChatSessionTransfer(Integer chatSessionId)

NSChatAgent agent;
Integer chatSessionId;
NSChatSessionEntity res = agent.AcceptChatSessionTransfer(chatSessionId);

Parameters

Returns

AddChatMessage(Integer,NSChatMessage)

Adds a new message to a chat session

Declaration

NSChatMessage AddChatMessage(Integer chatSessionId, NSChatMessage message)

NSChatAgent agent;
Integer chatSessionId;
NSChatMessage message;
NSChatMessage res = agent.AddChatMessage(chatSessionId, message);

Parameters

Returns

AddChatTopicUserAgent(Integer,NSChatTopicAgent)

Adds a user to a chat topic

Declaration

NSChatTopicAgent AddChatTopicUserAgent(Integer chatTopicId, NSChatTopicAgent useragent)

NSChatAgent agent;
Integer chatTopicId;
NSChatTopicAgent useragent;
NSChatTopicAgent res = agent.AddChatTopicUserAgent(chatTopicId, useragent);

Parameters

Returns

ChatSessionsForUser()

Gets all chat sessions which this user is a member of.

Declaration

NSChatSessionEntity[] ChatSessionsForUser()

NSChatAgent agent;
NSChatSessionEntity[] res = agent.ChatSessionsForUser();

Returns

ChatTopicsForUser()

Gets all chat topics which this user is a member of.nd, Notifications, Listen or Manager.

Declaration

NSChatTopicEntity[] ChatTopicsForUser()

NSChatAgent agent;
NSChatTopicEntity[] res = agent.ChatTopicsForUser();

Returns

CreateChatSessionForTopic(Integer)

Creates a new session on a chat topic

Declaration

NSChatSessionEntity CreateChatSessionForTopic(Integer chatTopicId)

NSChatAgent agent;
Integer chatTopicId;
NSChatSessionEntity res = agent.CreateChatSessionForTopic(chatTopicId);

Parameters

Returns

CreateDefaultChatSessionEntity()

Sets default values into a new NSChatSessionEntity.

Declaration

NSChatSessionEntity CreateDefaultChatSessionEntity()

NSChatAgent agent;
NSChatSessionEntity thing = agent.CreateDefaultChatSessionEntity();
thing = agent.SaveChatSessionEntity(thing);

Returns

CreateDefaultChatTopicAgent()

Sets default values into a new NSChatTopicAgent.

Declaration

NSChatTopicAgent CreateDefaultChatTopicAgent()

NSChatAgent agent;
NSChatTopicAgent thing = agent.CreateDefaultChatTopicAgent();
thing = agent.SaveChatTopicAgent(thing);

Returns

CreateDefaultChatTopicEntity()

Sets default values into a new NSChatTopicEntity.

Declaration

NSChatTopicEntity CreateDefaultChatTopicEntity()

NSChatAgent agent;
NSChatTopicEntity thing = agent.CreateDefaultChatTopicEntity();
thing = agent.SaveChatTopicEntity(thing);

Returns

DeleteChatSessionEntity(Integer)

Deletes the NSChatSessionEntity

Declaration

Void DeleteChatSessionEntity(Integer chatSessionEntity)

NSChatAgent agent;
agent.DeleteChatSessionEntity(123);

Parameters

Returns

DeleteChatTopicEntity(Integer)

Deletes the NSChatTopicEntity

Declaration

Void DeleteChatTopicEntity(Integer chatTopicEntity)

NSChatAgent agent;
agent.DeleteChatTopicEntity(123);

Parameters

Returns

DeleteChatTopicUserAgent(Integer,String)

Removes a user from a topic

Declaration

Void DeleteChatTopicUserAgent(Integer chatTopicId, String username)

NSChatAgent agent;
Integer chatTopicId;
String username;
agent.DeleteChatTopicUserAgent(chatTopicId, username);

Parameters

Returns

GetChatMessages(Integer,Integer)

Gets all or some of the messages in a chat session

Declaration

NSChatMessage[] GetChatMessages(Integer chatSessionId, Integer after)

NSChatAgent agent;
Integer chatSessionId;
Integer after;
NSChatMessage[] res = agent.GetChatMessages(chatSessionId, after);

Parameters

Returns

GetChatPresence()

Gets the chat presence status for all chat users.

Declaration

NSChatPresence[] GetChatPresence()

NSChatAgent agent;
NSChatPresence[] res = agent.GetChatPresence();

Returns

GetChatSessionEntity(Integer)

Gets an NSChatSessionEntity object.

Declaration

NSChatSessionEntity GetChatSessionEntity(Integer chatSessionEntityId)

NSChatAgent agent;
NSChatSessionEntity thing = agent.GetChatSessionEntity(123);

Parameters

Returns

GetChatTopicEntity(Integer)

Gets an NSChatTopicEntity object.

Declaration

NSChatTopicEntity GetChatTopicEntity(Integer chatTopicEntityId)

NSChatAgent agent;
NSChatTopicEntity thing = agent.GetChatTopicEntity(123);

Parameters

Returns

GetChatTopicUserAgent(Integer,String)

Gets a user assigned to a topic

Declaration

NSChatTopicAgent GetChatTopicUserAgent(Integer chatTopicId, String username)

NSChatAgent agent;
Integer chatTopicId;
String username;
NSChatTopicAgent res = agent.GetChatTopicUserAgent(chatTopicId, username);

Parameters

Returns

GetChatTopicUserAgentList(Integer)

Gets a list of users assigned to a chat topic.

Declaration

NSChatTopicAgent[] GetChatTopicUserAgentList(Integer chatTopicId)

NSChatAgent agent;
Integer chatTopicId;
NSChatTopicAgent[] res = agent.GetChatTopicUserAgentList(chatTopicId);

Parameters

Returns

GetChatTranscript(Integer,Bool)

Gets the chat transcript, formatted as plain text or HTML.

Declaration

String GetChatTranscript(Integer chatSessionId, Bool html)

NSChatAgent agent;
Integer chatSessionId;
Bool html;
String res = agent.GetChatTranscript(chatSessionId, html);

Parameters

Returns

GetUserAgentList(Bool,Bool)

Gets list of users that can be assigned to chat topics.

Declaration

NSMDOListItem[] GetUserAgentList(Bool flat, Bool onlyPresent)

NSChatAgent agent;
Bool flat;
Bool onlyPresent;
NSMDOListItem[] res = agent.GetUserAgentList(flat, onlyPresent);

Parameters

Returns

IsWithinOpeningHours(Integer)

Checks if we are right now within the opening hours of the given topic. Will use timezones to calculate if configured.

Declaration

Bool IsWithinOpeningHours(Integer chatTopicId)

NSChatAgent agent;
Integer chatTopicId;
Bool res = agent.IsWithinOpeningHours(chatTopicId);

Parameters

Returns

PickUpChatSession(Integer)

Answer the session: assign the session to the user. The welcome message is sent to the customer.

Declaration

NSChatSessionEntity PickUpChatSession(Integer chatSessionId)

NSChatAgent agent;
Integer chatSessionId;
NSChatSessionEntity res = agent.PickUpChatSession(chatSessionId);

Parameters

Returns

PickUpFirstChatSession()

Answer the first available session from the queue: assign the session to the user. The welcome message is sent to the customer.

Declaration

NSChatSessionEntity PickUpFirstChatSession()

NSChatAgent agent;
NSChatSessionEntity res = agent.PickUpFirstChatSession();

Returns

RejectChatSessionTransfer(Integer)

Do not want. Deny the transfer to the user. If the session is not being transferred, nothing happens.

Declaration

NSChatSessionEntity RejectChatSessionTransfer(Integer chatSessionId)

NSChatAgent agent;
Integer chatSessionId;
NSChatSessionEntity res = agent.RejectChatSessionTransfer(chatSessionId);

Parameters

Returns

ResetChatSession(Integer)

Resets chat session, puts it back on the queue for pickup.

Declaration

NSChatSessionEntity ResetChatSession(Integer chatSessionId)

NSChatAgent agent;
Integer chatSessionId;
NSChatSessionEntity res = agent.ResetChatSession(chatSessionId);

Parameters

Returns

SaveChatPresence(NSChatPresence[])

Saves the chat presence for specified users

Declaration

Void SaveChatPresence(NSChatPresence[] chatPresence)

NSChatAgent agent;
NSChatPresence[] chatPresence;
agent.SaveChatPresence(chatPresence);

Parameters

Returns

SaveChatSessionEntity(NSChatSessionEntity)

Updates the existing NSChatSessionEntity or creates a new NSChatSessionEntity if the id parameter is 0

Declaration

NSChatSessionEntity SaveChatSessionEntity(NSChatSessionEntity chatSessionEntity)

NSChat  agent;
NSChatSessionEntity thing = agent.CreateDefaultChatSessionEntity();
thing = agent.SaveChatSessionEntity(thing);

Parameters

Returns

SaveChatTopicEntity(NSChatTopicEntity)

Updates the existing NSChatTopicEntity or creates a new NSChatTopicEntity if the id parameter is 0

Declaration

NSChatTopicEntity SaveChatTopicEntity(NSChatTopicEntity chatTopicEntity)

NSChat  agent;
NSChatTopicEntity thing = agent.CreateDefaultChatTopicEntity();
thing = agent.SaveChatTopicEntity(thing);

Parameters

Returns

TransferChatSession(Integer,String)

Requests to send the session to another user. If the session does not belong to the user, nothing happens.

Declaration

NSChatSessionEntity TransferChatSession(Integer chatSessionId, String toAssociate)

NSChatAgent agent;
Integer chatSessionId;
String toAssociate;
NSChatSessionEntity res = agent.TransferChatSession(chatSessionId, toAssociate);

Parameters

Returns

UpdateChatTopicUserAgent(Integer,String,NSChatTopicAgent)

Updates a user's role in a chat topic

Declaration

NSChatTopicAgent UpdateChatTopicUserAgent(Integer chatTopicId, String username, NSChatTopicAgent useragent)

NSChatAgent agent;
Integer chatTopicId;
String username;
NSChatTopicAgent useragent;
NSChatTopicAgent res = agent.UpdateChatTopicUserAgent(chatTopicId, username, useragent);

Parameters

Returns

UpdateChatTopicUserAgent(Integer,NSChatTopicAgent[])

Updates users roles in a chat topic

Declaration

NSChatTopicAgent[] UpdateChatTopicUserAgents(Integer chatTopicId, NSChatTopicAgent[] useragents)

NSChatAgent agent;
Integer chatTopicId;
NSChatTopicAgent[] useragents;
NSChatTopicAgent[] res = agent.UpdateChatTopicUserAgents(chatTopicId, useragents);

Parameters

Returns