Class ChatContext
Constructor Attributes | Constructor Name and Description |
---|---|
ChatContext(agtCommands)
Manager for the Chat context.
|
Field Attributes | Field Name and Description |
---|---|
- list of ContextActionAllowed for this context
|
|
- current state of Chat
|
|
- detail of the current state.
|
|
- textual representation for the ContextState
|
|
- time of the last context state change
|
|
- number of chat in the agent personal queue.
|
|
- number of chat in the agent primary queue.
|
|
- list of CQueue available on this context.
|
|
- number of chat in the agent secondary queue.
|
|
- list of ContextSectionsAllowed available on the context.
|
|
- list of ChatSession running for this context.
|
Method Attributes | Method Name and Description |
---|---|
ActionIsReady(action)
Used to know if an action is authorized on the context
|
|
ChangeActiveSession(sessionId)
Notify which chat session is the active one.
|
|
Request to get the list of callbacks for the current hour on the context.
|
|
GetSession(sessionId)
Return the running session with the given id
|
|
StartListeningQueueForProductionStatistics(queueId, group_filter, activeQueueFilter)
Request to start receiving the production statistics informations on the context.
|
|
Request to stop receiving the production statistics informations on the context
|
Class Detail
ChatContext(agtCommands)
Manager for the Chat context. Instanciate by the AgentLinkClass object.
- Parameters:
- agtCommands
Field Detail
{COMArray}
ActionsAllowed
- list of ContextActionAllowed for this context
{ContextStates}
ContextState
- current state of Chat
{number}
ContextStateDetail
- detail of the current state. Enum to use depends of the ContextState.
{string}
ContextStateLabel
- textual representation for the ContextState
{number}
ContextStateTime
- time of the last context state change
{number}
PersonalQueueSize
- number of chat in the agent personal queue.
{number}
PrimaryQueueSize
- number of chat in the agent primary queue.
{COMArray}
Queues
- list of CQueue available on this context.
{number}
SecondaryQueueSize
- number of chat in the agent secondary queue.
{COMArray}
SectionsAllowed
- list of ContextSectionsAllowed available on the context.
{COMArray}
Sessions
- list of ChatSession running for this context.
Method Detail
ActionIsReady(action)
Used to know if an action is authorized on the context
if (agentlink.Chat.ActionIsReady(ContextActionAllowed.EnableContext)) { //agent can start the chat context }
- Parameters:
- {ContextActionAllowed} action
- - The action to test
- Returns:
- true if the action is currently authorized
ChangeActiveSession(sessionId)
Notify which chat session is the active one.
Agent can works on multiple chat session at a time, but only one has focus at a time.
Agent can works on multiple chat session at a time, but only one has focus at a time.
- Parameters:
- sessionId
CountNextCallbacks()
Request to get the list of callbacks for the current hour on the context.
Will fire the "OnCountCallbacksComplete" event.
Will fire the "OnCountCallbacksComplete" event.
{ChatSession}
GetSession(sessionId)
Return the running session with the given id
- Parameters:
- {string} sessionId
- - id of the Chat session to retrieve
- Returns:
- {ChatSession} . Return null if the id is not found on active sessions list
StartListeningQueueForProductionStatistics(queueId, group_filter, activeQueueFilter)
Request to start receiving the production statistics informations on the context.
Will fire the event "OnSupervisionDatasReceived".
Will fire the event "OnSupervisionDatasReceived".
- Parameters:
- {number} queueId
- - queue id to monitor. "0" to monitor all queues for this context
- {string} group_filter
- - "true" to filter on agent supervising group, "false" to not filter statistics on supervising group
- {string} activeQueueFilter
- - "true" to filter on active queue, "false" to not filter statistics on active queues
StopListeningForProductionStatistics()
Request to stop receiving the production statistics informations on the context