JSMCAPI Classes

This chapter discusses the JavaScript MultiChannel Application Programming Interface (JSMCAPI) classes.

Understanding JSMCAPI

This section introduces the JSMCAPI, a JavaScript-based API used to build custom applications, such as MultiChannel consoles, or to enable MultiChannel functionality on the PeopleSoft Pure Internet Architecture page. The API is built upon the REN server JavaScript client and is a pure JavaScript API.

JSMCAPI is the interface with which the application developer accessess the JSMCAPI functionalities. JSMCAPI provides a set of objects such as User, Address, Group, and so on. The psmc, a global object, provides all those methods called to send agent requests to the server; it also provides an event handler callback method for the PeopleSoft MultiChannel Application Programming Interface (PSMCAPI) call backs for events coming from the CTI server.

The JSMCAPI communicates with the PSMCAPI through the REN server using MCP (Multi-Channel Protocol). MCP includes topic and event definition. In general, JSMCAPI:

Sends agent requests to the MultiChannel Server.

The requests can be agent state requests such as login, logout, set ready, and so on. Requests can also be call requests such as dial-out, answer the call, transfer/conference, and so on.
Receives PBX/Switch events from the CTI server.

Events can be the agent state change such as event ready, not ready, and so on. Events can also be call events such as incoming call, call released, call transferred, and so on.

_Address Class Hierarchy

The _Address class can be extended by other subclasses. The following flowchart shows the different subclasses, and how they interrelate.

Do not instantiate _Address or _UQAddress class objects. Instead, use the child classes.

_Address class hierarchy

See Also

_Address Class Constructor

_UQAddress Class Constructor

A2AChatAddress Class Constructor

Extension Class Constructor

ChatAddress Class Constructor

EmailAddress Class Constructor

GenericAddress Class Constructor

_Address Class Constructor

The following is the _Address class constructor.

_Address

Syntax

_Address()

Description

Creates an _Address object that describes the address.

Parameters

None.

Returns

An _Address object.

_Address Class Fields

In this section we discuss the JSMCAPI _Address class fields. These fields are described in alphabetical order.

caps

Description

The capacities of the address.

Type: object.

id

Description

The ID of the address.

Type: string.

_Address Class Callback Event Method

The following is the callback event method used with a JSMCAPI _Address object.

onError

Syntax

onError(event)

Description

Fires on the event of an address error.

_UQAddress Class Constructor

The following is the UQAddress class constructor.

_UQAddress

Syntax

_UQAddress()

Description

Creates a _UQAddress object, which is the base for the various addresses associated with the universal queue server.

Parameters

None

Returns

A universal queue address object.

_UQAddress Class Fields

The _UQAddress class inherits the following fields from the _Address class.

caps
id

See _Address Class Fields.

The following are the _UQAddress class fields.

Tasks

Description

The associative array of the tasks on the queue managed by the address.

_UQAddress Methods

The following are the _UQAddress methods.

acceptTask

Syntax

acceptTask(task, reason)

Description

Sends a request to the universal queue server to signal that the client has accepted the task.

Parameters

task	The task ID.
reason	The associated reason code.

Returns

None.

dequeueTask

Syntax

dequeueTask(task)

Description

Sends a request to the universal queue server to remove the task from its queue.

Parameters

task

The task ID.

Returns

None.

_UQAddress Class Callback Event Methods

The _UQAddress class inherits the onError callback event method from the _Address class.

See _Address Class Callback Event Method.

The following are the callback event methods used with a JSMCAPI universal queue address object. The callback event methods are described in alphabetical order.

onAccepted

Syntax

onAccepted(event)

Description

Fires when the task is accepted.

onAcceptingTask

Syntax

onAcceptingTask(event)

Description

Fires as the task is being accepted.

onDequeueingTask

Syntax

onDequeueingTask(event)

Description

Fires as the task is being dequeued.

onNotify

Syntax

onNotify(event)

Description

Fires on task notification.

onTaskAdded

Syntax

onTaskAdded(event)

Description

Fires when the task is added to the addressed queue.

onTaskRemoved

Syntax

onTaskRemoved(event)

Description

Fired when the task is removed

onUnassigned

Syntax

onUnassigned(event)

Description

Fired when the task is unassigned.

_User Class Hierarchy

The _User class can be extended by other subclasses. The following flowchart shows the different subclasses, and how they interrelate.

_User class hierarchy

See Also

Buddy Class Constructor

User Class Constructor

_User Class Constructor

The following is the _User class constructor.

_User

Syntax

_User()

Description

Describes the base class of user/agent.

Parameters

None.

Returns

A _User object.

_User Class Fields

The following are the fields associated with the JSMCAPI _User class. These fields are discussed in alphabetical order.

agentID

Description

The agent's agent ID.

Type: string.

caps

Description

The agent capabilities on each group.

Type: associative array.

id

Description

The agent's PeopleSoft user ID.

Type: string.

name

Description

The agent's user name.

Type: string.

presences

Description

The agent's presence on each group.

Type: associative array.

states

Description

Agent state on each group.

Type: associative array, including the constants beginning with ST_*.

These constants must be accessed from an instantiated object.

ST_LOGGEDIN

Description

The agent is logged in.

ST_LOGGEDOUT

Description

The agent is logged out.

ST_NOTREADY

Description

The agent is not ready.

ST_READY

Description

The agent is ready.

ST_UNKNOWN

Description

The agent's state is unknown.

ST_WORKNOTREADY

Description

The agent is in the work not ready state.

ST_WORKREADY

Description

The agent is in the work ready state.

statistics

Description

Agent statistics for CTI.

Type: AgentStatistics object.

See Also

AgentStatistics Class Constructor.

statistics1

Description

Agent statistics for the universal queue server.

Type: UserStatistics1 object.

See Also

UserStatistics1 Class Constructor.

statistics2

Description

Agent statistics for the universal queue server.

Type: UserStatistcs2 object.

See Also

UserStatistics2 Class Constructor.

A2AChat Class Constructor

The following is the A2AChat class constructor.

A2AChat

Syntax

A2AChat(event,address,chatType)

Description

Creates an agent-to-agent chat object.

The chat is related to the A2AChatAddress. It does not extend Task as it is not generated or tracked by the universal queue server. Construction occurs inside the A2AChatAddress.

Parameters

event	Specify the event associated with the agent-to-agent chat.
address	Specify the address from A2AChatAddress.
chatType	Specify the chat type.

Returns

An agent-to-agent chat object.

A2AChat Class Fields

The following are the A2AChat fields.

address

Description

The address containing the agent-to-agent chat.

Type: A2AChatAddress object.

See Also

A2AChatAddress Class Constructor

agentID

Description

The associated agent's ID.

Type: string.

agentName

Description

The associated agent's name.

Type: string.

appData

Description

The application data that is provided to the client with the notification event.

Type: AppData object.

See Also

AppData Class Constructor

chatType

Description

The type of chat, either A2AChat.TYPE_CONSULT or A2AChat.TYPE_ANSWER .

Type: string, with one of the following constants:

Value	Description
TYPE_ANSWER	The A2AChat type answer. This type is generated when another agent wants this agent to answer an A2AChat.
TYPE_CONSULT	The A2AChat type consult. This type is generated when this agent wants to consult another agent.

Example

The A2AChat.TYPE_* can only be accessed as in the following example:

var value = A2AChat.TYPE_CONSULT;

See Also

GLOBALS Class Fields

id

Description

The ID of this chat.

Type: string with PS_JR constant.

jr

Description

JournalRoute

Type: string.

type

Description

The task type, chat.

Type: string.

uniqueueId

Description

The unique ID.

Type: string.

A2AChat Class Method

The following is the A2AChat class method.

getURL

Syntax

getURL(defaultURL)

Description

Returns the URL for the given task.

Parameters

defaultURL

If not null, this value will override the generated base URL.

Returns

The URL associated with this task.

A2AChatAddress Class Constructor

The following is the A2AChatAddress constructor.

A2AChatAddress

Syntax

A2AChatAddress()

Description

Agent-to-agent chat address. Handles the creation of agent-to-agent chats for incoming and outgoing chat communication.

Parameters

None.

Returns

An A2AChatAddress object.

A2AChatAddress Class Fields

The A2AChatAddress class inherits the following fields from the _Address class:

id
caps

See _Address Class Fields.

The following are the fields associated with the A2AChatAddress class.

id

Description

The address ID.

Type: string.

tasks

Description

The associative array of A2AChats.

Type: associative array.

See Also

GLOBALS Class Fields

A2AChatAddress Class Method

The following is the A2AChatAddress class method:

initiateChat

Syntax

initiateChat(agentId)

Description

Initializes the A2AChatAddress by creating an A2AChat task.

Parameters

agentId

The ID of the agent you wish to chat with.

Returns

None.

A2AChatAddress Class Callback Event Methods

The A2AChatAddress class inherits the onError callback event method from the _Address class.

See _Address Class Callback Event Method.

The following are the A2AChatAddress class callback methods:

onChatEnded

Syntax

onChatEnded(event)

Description

Fires when an agent-to-agent chat is closed.

onInitiatingChat

Syntax

onInitiatingChat(event)

Description

Fires when initiating a chat.

onNotify

Syntax

onNotify(event)

Description

Fires when receiving the event notification.

AgentStatistics Class Constructor

The following is the AgentStatistics class constructor.

AgentStatistics

Syntax

AgentStatistics()

Description

The agent statistics information.

Parameters

None.

Returns

An AgentStatistics object.

AgentStatistics Class Fields

The following are the AgentStatistics class fields.

averageCallDuration

Description

The average call duration, in seconds, for an agent.

Type: string.

averageHoldDuration

Description

The average hold duration, in seconds, for an agent.

Type: string.

callsHandled

Description

The total number of calls handled by an agent.

Type: string.

data

Description

An associative array of key value pairs that includes all agent statistics.

Type: associative array.

unavailableDuration

Description

The total time for which an agent is unavailable.

Type: string.

waitDuration

Description

The total time an agent has to wait for a call.

Type: string.

AppData Class Constructor

The following is the AppData class constructor.

AppData

Syntax

AppData()

Description

The AppData object describes the key-value pairs of the data received on the agent-to-agent chat event.

Parameters

None.

Returns

Type: AppData object.

AppData Class Fields

The following are the AppData class fields.

data

Description

An associative array of the data in name value pairs.

Type: associative array.

groupId

Description

The group ID passed in by the notify event.

Type: string.

jr

Description

The JournalRoute.

Type: string.

question

Description

The question posed by the chat initiator.

Type: string.

strData

Description

The raw application data.

Type: string.

subject

Description

The subject of the chat.

Type: string.

uniqueId

Description

The unique ID.

Type: string.

url

Description

The URL passed in by the AppData.

Type: string with the following constant:

Value	Description
URL	The associated URL.

userId

Description

The agent's user ID.

Type: string.

username

Description

The agent's user name.

Type: string.

wizUrl

Description

The chat wizard URL.

Type: string.

AppData Class Method

The following is the AppData class method.

addKeyValue

Syntax

addKeyValue(kdy, value)

Description

Add the key value pair to the AppData object.

Parameters

key	The key.
value	The value.

Returns

None.

Buddy Class Constructor

The Buddy class extends the _User class.

See _User Class Constructor.

The following is the Buddy class constructor.

Buddy

Syntax

Buddy()

Description

Describes the buddy. An agent can register buddies and is notified of state changes.

Parameters

None.

Returns

A Buddy object.

Buddy Class Fields

The Buddy class inherits the following fields from the _User class:

agentID
caps
id
name
presences
states
statistics
statistics1
statistics2

See _User Class Constructor.

Buddy Class Callback Event Methods

The following are the Buddy class callback event methods.

onStat1

Syntax

onStat1(event)

Description

Fires when statistics1 is received.

onStat2

Syntax

onStat2(event)

Description

Fires when statistics2 is received.

onState

Syntax

onState(event)

Description

Fires when the state event is received.

Call Class Constructor

The Call class extends the Task class.

See Task Class Constructor.

The following is the Call class constructor.

Call

Syntax

Call(strCall)

Description

The Call object describes the call task information associated with the line.

Parameters

strCall

Specify the call to use with this object.

Returns

A Call object.

Call Class Fields

The Call class inherits the following fields from Task:

caseid
cost
customerid
group
id
onStat
priority
type
urlAbs
urlRel

See Task Class Fields.

The following are additional Call class fields.

line

Description

The line object that is associated with this call.

Type: line object.

See Also

Line Class Constructor

statistics

Description

Statistics associated with the call.

Type: CallStatistics object.

See Also

CallStatistics Class Constructor.

CallData Class Constructor

The following is the CallData class constructor.

CallData

Syntax

CallData()

Description

The CallData object describes the key-value pairs of the call data with the call object.

Parameters

None

Returns

A CallData object.

CallData Class Fields

The following are the CallData class fields:

ani

Description

The ANI caller id.

Type: string.

callId

Description

The call ID.

Type: string.

callType

Description

The call type.

Type: string.

data

Description

The call data.

Type: string.

dnis

Description

The DNIS callee ID.

Type: string.

CallData Class Method

The following is the CallData class method.

addKeyValue

Syntax

addKeyValue(key), value

Description

Add key value to the CallData object.

Parameters

key	The key.
value	The value.

Returns

None.

CallStatistics Class Constructor

The following is the CallStatistics class constructor.

CallStatistics

Syntax

CallStatistics()

Description

The call statistics information.

Parameters

None.

Returns

A CallStatistics object.

CallStatistics Class Fields

The following are the CallStatistics class fields.

data

Description

An associative array of key-value pairs that includes all statistics.

Type: associative array.

holdTime

Description

Duration that the call is on hold.

Type: string.

queueTime

Description

Duration that this call has been in the queue.

Type: string.

talkTime

Description

Duration that the call is established.

Type: string.

Chat Class Constructor

The Chat class extends the Task class.

See Task Class Constructor.

The following is the Chat class constructor.

Chat

Syntax

Chat(event, address)

Description

The Chat object describes the task information for tasks associated with the ChatAddress.

Parameters

event	The onNotify event.
address	The chat address.

Returns

A Chat object.

Chat Class Fields

The Chat class inherits the following fields from Task class:

caseid
cost
customerid
group
id
onStat
priority
type

The task type for chat that is Task.TYPE_CHAT.
urlAbs
urlRel

See Task Class Fields.

The following are the additional Chat class fields.

address

Description

The address containing the agent-to-agent chat.

Type: A2AChatAddress object.

See Also

A2AChatAddress Class Constructor

agentId

Description

The agent's ID.

Type: string.

appData

Description

The application data that is provided to the client with the notification event.

Type: AppData object.

See Also

AppData Class Constructor

customerName

Description

The customer username.

Type: string.

groupId

Description

The group ID.

Type: string.

question

Description

The question for this chat.

Type: string.

subject

Description

The subject of the chat.

Type: string.

Chat Class Method

The Chat class extends the Task class.

See Task Class Constructor.

The following is the Chat class method.

getUrl

Syntax

getUrl(defaultUrl)

Description

Returns the URL for the given Task

Parameters

defaultUrl

The default URL for this chat. If not null this value will override the generated base URL.

Returns

Returns the URL for the chat.

ChatAddress Class Constructor

The ChatAddress class extends the _UQAddress class.

See _UQAddress Class Constructor.

The following is the ChatAddress class constructor.

ChatAddress

Syntax

ChatAddress()

Description

Handles the creation of customer chat tasks.

Parameters

None.

Returns

A ChatAddress object.

ChatAddress Class Fields

The ChatAddress class inherits the following fields from the _Address class:

id

The address's ID is equal to Task.TYPE_CHAT.
caps

See _Address Class Fields.

The ChatAddress class inherits the following field from the _UQAddress class:

tasks

See _UQAddress Class Fields.

ChatAddress Class Methods

The ChatAddress class inherits the following methods from the _UQAddress class:

acceptTask
dequeueTask

See _UQAddress Methods.

ChatAddress Callback Event Methods

The ChatAddress class inherits the onError callback event method from the _Address class.

See _Address Class Callback Event Method.

The ChatAddress class inherits the following callback event methods from the _UQAddress class:

onAccepted
onAcceptingTask
onDequeueingTask
onNotify
onTaskAdded
onTaskRemoved
onUnassigned

See _UQAddress Class Fields.

Email Class Constructor

The Email class extends the Task class.

See Task Class Constructor.

The following is the email class constructor.

Email

Syntax

Email(event)

Description

The Email object describes the task information for tasks associated with the EmailAddress.

Parameters

event

The notification event.

Returns

Returns an Email object.

Email Class Fields

The Chat class inherits the following fields from Task class:

caseid
cost
customerid
group
id
onStat
priority
type

The task type is equal to Task.TYPE_EMAIL.
urlAbs
urlRel

See Task Class Fields.

The following are the additional Email class fields:

agentId

Description

The agent's ID.

appData

Description

The application data that is provided to the client with the notification event.

Type: AppData object.

See Also

Task Class Fields

Email Class Method

The following is the Email class method.

getUrl

Syntax

getURL(defaultUrl)

Description

Returns the URL for the given task.

Parameters

defaultUrl

If not null this value will override the generated base URL.

Returns

The URL associated with this task.

EmailAddress Class Constructor

The EmailAddress class extends the _UQAddress class.

See _UQAddress Class Constructor.

The following is the EmailAddress class constructor.

EmailAddress

Syntax

EmailAddress()

Description

Handles the creation of email tasks.

Parameters

None.

Returns

An EmailAddress object.

EmailAddress Class Fields

The EmailAddress class inherits the following fields from the _Address class:

id

The address's ID is equal to Task.TYPE_EMAIL.
caps

See _Address Class Fields.

The EmailAddress class inherits the tasks field from the _UQAddress class.

See _UQAddress Class Fields.

EmailAddress Class Methods

The EmailAddress class inherits the following fields from the _UQAddress class:

acceptTask
dequeueTask

See _UQAddress Methods.

EmailAddress Callback Event Methods

The EmailAddress class inherits the onError callback event method from the _Address class.

See _Address Class Callback Event Method.

The EmailAddress class inherits the following callback event methods from the _UQAddress class:

onAccepted
onAcceptingTask
onDequeueingTask
onNotify
onTaskAdded
onTaskRemoved
onUnassigned

See _UQAddress Class Callback Event Methods.

Extension Class Constructor

The Extension class extends the _Address class.

See _Address Class Constructor.

The following is the Extension class constructor.

Extension

Syntax

Extension(numOfLines)

Description

The Extension object describes the CTI address.

Parameters

numOfLines

Specify the number of lines for this extension.

Returns

An Extension object.

Extension Class Fields

The Extension class inherits the following fields from the _Address class:

caps
id

See _Address Class Fields.

The following are the Extension class fields.

forwardMode

Description

The forward mode of the extension.

Type: forwardMode object.

See Also

ForwardMode Class Constructor

isDnd

Description

Flag for Do Not Disturb.

Type: boolean.

lines

Description

An associative array of line objects.

Type: associative array.

numOfLines

Description

The number of lines for this extension.

Type: number.

Extension Class Methods

The Extension class inherits the onError method from the Address class.

The following are the Extension class methods.

cancelDnd

Syntax

cancelDnd(reason)

Description

Cancel the DND (do not disturb).

Parameters

reason

The reason for DND cancellation.

Returns

None.

cancelForwardSet

Syntax

cancelForwardSet(reason)

Description

Cancel the forward.

Parameters

reason

The reason for cancelling the forward.

Returns

None.

forwardSet

Syntax

forwardSet(number, mode, reason)

Description

Forward the call to another number/extension.

Parameters

mode	The forward mode.
number	The number to which all calls will be forwarded.
reason	The reason to forward.

Returns

None.

getDialingLine

Syntax

getDialingLine()

Description

Get the dialing line object.

Parameters

None

Returns

Returns a line object. Null if there is no dialing line.

See Also

Line Class Constructor

getFreeLine

Syntax

getFreeLine()

Description

Get the free line object. A line is free if there is no activity on this line.

Parameters

None

Returns

Returns a line object. Null if there is no free line.

getLineByConnectionId

Syntax

getLineByConnectionId(connectionID)

Description

Get the line object with the call.

Parameters

connectionId

The connection ID associated with a call.

Returns

Returns a Line object. Null if there is no line with that call.

See Also

Line Class Constructor

getOffHookLine

Syntax

getOffHookLine()

Description

Get the offhook line object.

Parameters

None.

Returns

Returns a Line object. Null if there is no offhook line.

See Also

Line Class Constructor

setDnd

Syntax

setDnd(event)

Description

Fires when setting DND (do not disturb).

Parameters

event

The event object.

Returns

None.

Extension Class Callback Event Methods

The following are the Extension class callback event methods.

onCancelingDnd

Syntax

onCancelingDnd(event)

Description

Fires when canceling DND (do not disturb).

onCancelingForward

Syntax

onCancelingForward(event)

Description

Fires when canceling forward.

onDnd

Syntax

onDnd(event)

Description

Fires when DND is selected.

onForwardCanceled

Syntax

onForwardCanceled(event)

Description

Fires on cancellation of forwarding.

onForwarded

Syntax

onForwarded(event)

Description

Fires when the extension is forwarded.

onForwarding

Syntax

onForwarding(event)

Description

Fires when forwarding.

onSettingDnd

Syntax

onSettingDnd(event)

Description

Fires when setting DND (do not disturb).

ExtensionCaps Class Constructor

The following is the Extension class constructor.

ExtensionCaps

Syntax

ExtensionCaps(strCaps)

Description

Describes the extension's capabilities.

Parameters

strCaps

A string comprising the extension's capabilities

Returns

An ExtensionCaps object.

ExtensionCaps Class Fields

The following are the Extension class fields.

canCancelDnd

Description

This extension can cancel DND (do not disturb).

Type: boolean.

canDial

Description

This extension can dial out.

Type: boolean.

canFwdBusy

Description

This extension can forward calls if busy.

Type: boolean.

canFwdBusyNoAnswer

Description

This extension can forward calls if busy/no answer.

Type: boolean.

canFwdCancelForward

Description

This extension can cancel forward.

Type: boolean.

canFwdDefault

Description

This extension can forward.

Type: boolean.

canFwdNoAnswer

Description

This extension can forward if no answer.

Type: boolean.

canFwdUnconditional

Description

This extension can forward unconditionally.

Type: boolean.

canRefreshState

Description

This extension can refresh state.

Type: boolean.

canSetDnd

Description

This extension can set DND (do not disturb).

Type: boolean.

ForwardMode Class Constructor

The following is the ForwardMode class constructor.

ForwardMode

Syntax

ForwardMode()

Description

Describes various forward modes that can be used while setting the forwarding mode for an Address.

Parameters

None.

Returns

A ForwardMode object.

ForwardMode Class Field

The following is the ForwardMode class field.

mode

Description

The current forwarding mode.

Type: string of the following constants.

Value	Description
BUSY	The BUSY forwarding mode.
BUSYNOANSWER	The BUSYNOANSWER forwarding mode.
DEFAULT	The DEFAULT forwarding mode.
NOANSWER	The NOANSWER forwarding mode.
NONE	No forwarding mode.
UNCONDITIONAL	The UNCONDITIONAL forwarding mode.

GenericAddress Class Constructor

The GenericAddress class extends the _UQAddress class.

The following is the GenericAddress class constructor.

GenericAddress

Syntax

GenericAddress()

Description

Handles the creation of generic tasks.

Parameters

None.

Returns

A GenericAddress object.

GenericAddress Class Fields

The GenericAddress class inherits the following fields from the _Address class.

caps
id

The address's ID is equal to Task.TYPE_GENERIC.

See _Address Class Fields.

The GenericAddress class inherits the tasks field from the _UQAddress class.

See _UQAddress Class Fields.

GenericAddress Class Methods

The GenericAddress class inherits the following methods from the _UQAddress class:

acceptTask
dequeueTask

See _UQAddress Methods.

GenericAddress Class Callback Event Methods

The GenericAddress class inherits the onError callback event method from the _Address class.

See _Address Class Callback Event Method.

The GenericAddress class inherits the following callback event methods from the _UQAddress class:

onAcceptingTask
onDequeueingTask
onTaskAdded
onTaskRemoved
onNotify
onAccepted
onUnassigned

See _UQAddress Class Callback Event Methods.

GenericTask Class Constructor

The GenericTask class extends the Task class.

The following is the GenericTask class constructor

GenericTask

Syntax

GenericTask(event)

Description

The GenericTask object describes the generic task information for tasks associated with the GenericAddress object.

Parameters

event

The triggering event.

Returns

A GenericTask object.

GenericTask Class Fields

The GenericTask class inherits the following fields from the Task class:

caseid
cost
customerid
group
id
onStat
priority
type

The task type for generic task that is Task.TYPE_GENERIC.
urlAbs
urlRel

See Task Class Fields.

The following are the additional GenericTask class fields.

agentId

Description

The agent's ID.

Returns a string.

appData

Description

The application data that is provided to the client with the notification event.

Type: AppData object.

See Also

AppData Class Constructor

customerName

Description

The customer username.

Type: string.

groupId

Description

The group ID.

Type: string.

question

Description

The question for this generic task.

Type: string.

subject

Description

The subject of the generic task.

Type: string.

GenericTask Class Method

The following is the GenericTask class method.

getUrl

Syntax

getUrl(defaultUrl)

Description

Returns the URL for the given task.

Parameters

If not null, this value will override the generated base URL.

Returns

Returns the URL for the given task.

GLOBALS Class Fields

The following are global fields, which may be accessed without instantiating an object. They are accessed as shown.

A2AChat.PS_JR

Description

The Journal Routing constant.

Example

A2AChat.PS_JR = "ps_jr";

A2AChat.TYPE_ANSWER

Description

The constant representing an A2AChat type of answer.

This type is generated when a different user wants this user to answer an A2AChat.

Example

A2AChat.TYPE_ANSWER = "answer";

A2AChat.TYPE_CONSULT

Description

The constant representing an A2AChat type of consult.

This type is generated when this user wants to consult a different user.

Example

A2AChat.TYPE_CONSULT = "consult";

Server.TYPE_CTI

Description

The constant representing a CTI server.

Example

Server.TYPE_CTI = "CTI";

Server.TYPE_UQ

Description

The UQ server type.

Example

Server.TYPE_UQ = "UQ";

Task.TYPE_A2ACHAT

Description

The constant representing an A2AChat.

Example

Task.TYPE_A2ACHAT = "A2ACHAT";

Task.TYPE_CHAT

Description

The constant representing a chat task.

Example

Task.TYPE_CHAT = "CHAT";

Task.TYPE_CTI

Description

The constant representing a CTI task.

Example

Task.TYPE_CTI = "CTI";

Task.TYPE_EMAIL

Description

The constant representing an email task

Example

Task.TYPE_EMAIL = "EMAIL";

Task.TYPE_GENERIC

Description

The constant representing a generic task

Example

Task.TYPE_GENERIC = "GENERIC";

GLOBALS Class Methods

The following are the GLOBALS class methods.

GLOBALS class methods

Syntax

initJSMCAPI()

Description

The initialization function of the JSMCAPI. This is the first function should be called by application.

Parameters

None.

Returns

None. Initializes JSMCAPI.

isValid

Syntax

isValid(obj)

Description

Obj can be any JavaScript object or literal. This method is a convenience method to check that an object is both not null and not undefined.

Parameters

obj

Obj can be any JavaScript object or literal.

Returns

Returns a boolean.

Returns true if an object is not undefined and not null.

Group Class Constructor

The following is the Group class constructor.

Group

Syntax

Group()

Description

The Group object describes the group information.

Parameters

None.

Returns

A Group object.

Group Class Fields

The following are the Group class fields.

id

Description

The group ID.

Type: string.

name

Description

The group name.

Type: string.

registered

Description

True if the Group is registered on the server.

Type: boolean.

statistics

Description

The group statistics for CTI.

Type: GroupStatistics object

See Also

GroupStatistics1 Class Constructor

statistics1

Description

The group statistics for UQ server.

Type: GroupStatistics1 object.

See Also

GroupStatistics1 Class Constructor

statistics2

Description

The group statistics for UQ server.

Type: GroupStatistics2 object.

See Also

GroupStatistics2 Class Constructor

Group Class Callback Event Methods

The following are the Group class callback event methods.

onStat

Syntax

onStat(event)

Description

Fires when there is new statistics going to this group.

onStat1

Syntax

onStat1(event)

Description

Fires when statistics1 is received.

onStat2

Syntax

onStat2(event)

Description

Fires when statistics2 is received.

onTaskAdded

Syntax

onTaskAdded(event)

Description

Fires when there is task added to this group.

onTaskRemoved

Syntax

onTaskRemoved(event)

Description

Fires when a task is removed from this group.

GroupStatistics Constructor

The following is the GroupStatistics class constructor.

GroupStatistics

Syntax

GroupStatistics()

Description

The group statistics information.

Parameters

None.

Returns

A GroupStatistics object.

GroupStatistics Fields

The following are the GroupStatistics class fields.

data

Description

Key value pairs that include all statistics.

numberOfAbandoned

Description

Number of tasks that are abandoned.

numberOfLoggedIn

Description

Number of agents that are logged in the queue.

numberOfQueued

Description

Number of tasks that are queued.

queuedWaitTime

Description

The average wait time, in seconds, of a queued task.

relativeQueueLoad

Description

Relative queue load.

GroupStatistics1 Class Constructor

The following is the GroupStatistics1 class constructor.

GroupStatistics1

Syntax

GroupStatistics1(data)

Description

UQ Group statistics sent on group refresh 1.

Parameters

data

Statistical data from the UQ server.

Returns

A GroupStatistics1 object.

GroupStatistics1 Class Fields

The following are the GroupStatistics1 class fields.

mostRecentTaskDone

Description

The most recently done task in the group.

Type: string.

mostRecentTaskDoneData

Description

The data for the most recent task done.

Type: string.

mostRecentTaskEnqueued

Description

The most recently enqueued task in the group.

Type: string.

mostRecentTaskEnqueuedData

Description

The data for the most recently enqueued task.

Type: string.

numAgentsAvailable

Description

Number of agents available in the group.

Type: string.

numAgentsLoggedIn

Description

Number of agents logged in on the group.

Type: string.

numEscalation

Description

Number of escalated tasks in the group.

Type: string.

numOverflow

Description

Number of overflowed tasks in the group.

Type: string.

numTaskAccepted

Description

Number of tasks accepted in the group.

Type: string.

numTaskDone

Description

Number of tasks done in the group.

Type: string.

numTaskQueued

Description

Number of tasks queued in the group.

Type: string.

reasonFlag

Description

The reason flag for this GroupStatistics event.

Type: string.

taskTotalTimeInSystem

Description

The total time in the system.

Type: string.

timeSinceStart

Description

The time since start.

Type: string.

GroupStatistics2 Class Constructor

The following is the GroupStatistics2 class constructor.

GroupStatistics2

Syntax

GroupStatistics2(data)

Description

UQ Group statistics sent on group refresh 2.

Parameters

data

UQ server statistical data.

Returns

A GroupStatistics2 object.

GroupStatistics2 Class Fields

The following are the GroupStatistics2 class fields.

averageTaskDuration

Description

The average task duration in the group.

Type: string.

averageWaitTime

Description

The average wait time in the group.

Type: string.

oldestTask

Description

The oldest task in the group.

Type: string.

recentTask

Description

The most recent task in the group.

Type: string.

timeElapsedOldestTask

Description

The time elapsed for the oldest task in the group.

Type: string.

timeElapsedRecentTask

Description

The time elapsed for the most recent task in the group.

Line Class Constructor

The following is the Line class constructor.

Line

Syntax

Line()

Description

The Line object describes the line of the extension. JSMCAPI only supports one extension with two lines and two extensions with one line in each.

Parameters

None.

Returns

A Line object.

Line Class Fields

The following are the Line class fields.

call

Description

The Call object on the line.

Type: Call object.

See Also

Call Class Constructor

caps

Description

The capabilities of the line.

Type: LineCaps object.

See Also

LineCaps Class Constructor

connectionid

Description

The call connection ID on the line.

Type: string.

id

Description

The line ID.

Type: string.

state

Description

The line state.

Type: string with the following constants:

Value	Description
ST_DIALING	The dialing state.
ST_DROPPED	The dropped state.
ST_HELD	The held state.
ST_IDLE	The idle state.
ST_OFFHOOK	The offhook state.
ST_RINGING	The ringing state.
ST_TALKING	The talking state.

Line Class Methods

The following are the Line class methods.

alternate

Syntax

alternate(reason)

Description

Alternate a call.

Parameters

reason

The reason to alternate a call.

Returns

None.

answer

Syntax

answer(reason)

Description

Answer a call.

Parameters

reason

The reason to answer a call.

Returns

None.

attachUserData

Syntax

attachUserDate(userdata, reason)

Description

Attach user data to a call.

Parameters

userdata	The user data to attach to the call.
reason	The reason to attach the user data.

Returns

None.

clear

Syntax

clear(reason)

Description

Clear a conference call.

Parameters

reason

The reason to clear the conference.

Returns

None.

complete

Syntax

complete(reason)

Description

Complete the two-step transfer/conference.

Parameters

reason

The reason to complete the two-step transfer/conference.

Returns

None.

conference

Syntax

conference(destination, reason, userdata, calldata)

Description

Conference a call.

Parameters

destination	The destination being invited into the conference.
reason	The reason to conference.
userdata	The user data to be attached.
calldata	The call data to be modified.

Returns

None.

conferenceSingle

Syntax

conferenceSingle(destination, reason, userdata, calldata)

Description

Single-step conference a call.

Parameters

destination	The destination being invited into the conference.
reason	The reason to conference.
userdata	The user data to be attached.
calldata	The call data to be modified.

Returns

None.

dial

Syntax

dial(number, reason, userdata)

Description

Dial out.

Parameters

destination	The destination being invited into the conference.
reason	The reason to conference.
userdata	The user data to be attached.

Returns

None.

dropParty

Syntax

dropParty(destination, reason)

Description

Drop a party in conference.

Parameters

destination	The destination being dropped from the conference.
reason	The reason to drop the party.

Returns

None.

getAni

Syntax

getAni()

Description

Get the ANI.

Parameters

None.

Returns

Returns a string representing the ANI.

getDescr

Syntax

getDescr()

Description

Get the description attached to the call on the line.

Parameters

None.

Returns

Returns a string.

getDnis

Syntax

getDnis()

Description

Get the DNIS.

Parameters

None.

Returns

Returns a string.

getReferenceId

Syntax

getReferenceId()

Description

Get the reference ID attached to the call on the line.

Parameters

None.

Returns

Returns a string.

getUrl

Syntax

getUrl(defaultUrl)

Description

Get the URL for screen popup.

Parameters

defaultUrl

The default popup URL.

Returns

Returns a string.

grabCall

Syntax

grabCall(destination, reason)

Description

Grab a call from the queue.

Parameters

destination	The destination to be grabbed.
reason	The reason for the grab.

Returns

None.

hold

Syntax

hold(reason)

Description

Hold a call.

Parameters

reason

The reason to hold the call.

Returns

None.

park

Syntax

park(destination, reason)

Description

Park a call.

Parameters

destination	The destination on which the call will be parked.
reason	The reason to park the call.

Returns

None.

reconnect

Syntax

reconnect(reason)

Description

Reconnect to the original party during two-step transfer/conference.

Parameters

reason

The reason to reconnect.

Returns

None.

release

Syntax

release(reason)

Description

Release a call.

Parameters

reason

The reason to release the call.

Returns

None.

retrieve

Syntax

retrieve(reason)

Description

Retrieve a held call.

Parameters

reason

The reason to retrieve the call.

Returns

None.

transfer

Syntax

transfer(destination, reason, userdata, calldata)

Description

Transfer a call.

Parameters

destination	The destination to which the call will be transferred.
reason	The reason to transfer.
userdata	The user data to be attached.
calldata	The call data to be modified.

Returns

None.

transferMute

Syntax

transferMute(destination, reason, userdata, calldata)

Description

Transfer mute a call.

Parameters

destination	The destination to which the call will be transferred.
reason	The reason to transfer.
userdata	The user data to be attached.
calldata	The call data to be modified.

Returns

None.

updateCallData

Syntax

updateCallData(calldata, reason)

Description

Update call data to a call.

Parameters

calldata	The call data to update.
reason	The reason to update.

Returns

None.

Line Class Callback Event Methods

The following are the Line class callback event methods.

onAlternating

Syntax

onAlternating(event)

Description

Fires when alternating the call.

onAnswering

Syntax

onAnswering(event)

Description

Fires when answering the call.

onAttachingUD

Syntax

onAttachingUD(event)

Description

Fires when attaching user data.

onCallDataChanged

Syntax

onCallDataChanged(event)

Description

Fires when the call data on the call is changed.

onCapabilitiesChanged

Syntax

onCapabilitiesChanged(event)

Description

Fires when the capabilities changed.

onClearing

Syntax

onClearing(event)

Description

Fires when clearing the conference.

onCompleting

Syntax

onCompleting(event)

Description

Fires when completing the two-step transfer/conference.

onConferencing

Syntax

onConferencing(event)

Description

Fires when conferencing the call.

onDialing

Syntax

onDialing(event)

Description

Fires when there is an outgoing call.

onDropped

Syntax

onDropped(event)

Description

Fires when the call is released.

onError

Syntax

onError(event)

Description

Fires when there is error.

onGrabbing

Syntax

onGrabbing(event)

Description

Fires when grabbing a call from a queue.

onHeld

Syntax

onHeld(event)

Description

Fires when the call is on hold.

onHolding

Syntax

onHolding(event)

Description

Fires when holding the call.

onOffHook

Syntax

onOffHook(event)

Description

Fires when the line is off hook.

onOnHook

Syntax

onOnHook(event)

Description

Fires when the line is on hook.

onParking

Syntax

onParking(event)

Description

Fires when parking the call.

onPartyAdded

Syntax

onPartyAdded(event)

Description

Fires when a new call party coming.

onPartyChanged

Syntax

onPartyChanged(event)

Description

Fires when the call party has changed.

onPartyRemoved

Syntax

onPartyRemoved(event)

Description

Fires when a call party is removed.

onReconnecting

Syntax

onReconnecting(event)

Description

Fires when reconnecting the call.

onReleasing

Syntax

onReleasing(event)

Description

Fires when releasing the call.

onRetrieving

Syntax

onRetrieving(event)

Description

Fires when retrieving the call.

onRinging

Syntax

onRinging(event)

Description

Fires when there is an incoming call.

onTalking

Syntax

onTalking(event)

Description

Fires when the call is established.

onTransfering

Syntax

onTransfering(event)

Description

Fires when transferring the call.

onUpdatingCD

Syntax

onUpdatingCD(event)

Description

Fires when updating the call data.

onUserDataChanged

Syntax

onUserDataChanged(event)

Description

Fires when the user data attached on the call is changed.

LineCaps Class Constructor

The following is the LineCaps class constructor.

LineCaps

Syntax

LineCaps(strCaps)

Description

Describes the line's capabilities.

Parameters

strCaps

The line's capabilities.

Returns

A LineCaps object.

LineCaps Class Fields

The following are the LineCaps class fields.

canAlternate

Description

The line has alternate capability.

Type: boolean.

canAnswer

Description

The line has answer capability.

Type: boolean.

canAttachUserDate

Description

The line has attach user data capability.

Type: boolean.

canClear

Description

The line has clear capability.

Type: boolean.

canComplete

Description

The line has complete capability.

Type: boolean.

canConference

Description

The line has conference capability.

Type: boolean.

canConferenceSingle

Description

The line has conference single capability.

Type: boolean.

canDropParty

Description

The line has drop party capability.

Type: boolean.

canHold

Description

The line has hold capability.

Type: boolean.

canPark

Description

The line has park capability.

Type: boolean.

canReconnect

Description

The line has reconnect capability.

Type: boolean.

canRelease

Description

The line has release capability.

Type: boolean.

canRetrieve

Description

The line has retrieve capability.

Type: boolean.

canTransfer

Description

The line has transfer capability.

Type: boolean.

canTransferMute

Description

The line has transfer mute capability.

Type: boolean.

canUpdateCallData

Description

The line has update call data capability.

Type: boolean.

MCEvent Class Constructor

The following is the MCEvent class constructor.

MCEvent

Syntax

MCEvent()

Description

The MCEvent will be passed to the application event handler.

Parameters

None

Returns

An MCEvent object.

MCEvent Class Fields

The following are the MCEvent class fields.

extension

Description

The extension associated with the event.

Type: Extension object.

See Also

Extension Class Constructor

group

Description

The group associated with the event.

Type: Group object.

See Also

Group Class Constructor

reason

Description

The reason associated with the event.

Type: Reason object.

See Also

Reason Class Constructor

user

Description

The user associated with the event.

Type: User object.

See Also

User Class Constructor

MediaType Class Constructor

The following is the MediaType class constructor.

MediaType

Syntax

MediaType()

Description

Distinguishes between email and CTI media types.

Parameters

None.

Returns

A MediaType object.

MediaType Class Field

The following is the MediaType field.

type

Description

The media type.

Type: string with the following constants:

Value	Description
MT_EMAIL	The email media type.
MT_VOICE	The voice media type (CTI).

PSMC Class Constructor

The following is the PSMC class constructor.

PSMC

Syntax

PSMC()

Description

The global object that the application can access.

Parameters

None.

Returns

A PSMC object.

PSMC Class Fields

The following are the PSMC class fields.

renserver

Description

The PSMC instance of the RenServer object.

Type: RenServer object.

See Also

RenServer Class Constructor

servers

Description

An associative array the different Servers objects, indexed by server ID.

Type: associative array.

See Also

Server Class Constructor

sessions

Description

An associative array that holds the different Session objects, indexed by server ID.

Type: associative array.

See Also

Session Class Constructor

PSMC Class Methods

The following are the PSMC class methods.

closeSession

Syntax

closeSession(id)

Description

Closes the specified Session and Server object and deletes them.

Parameters

id	The ID of the REN server cluster for a UQ server, or the server ID for a CTI server.

Returns

None.

getCallById

Syntax

getCallById(id)

Description

Retrieve the call object by the call ID.

Parameters

id	The call ID.

Returns

Type: Call object.

See Also

Call Class Constructor

getLineById

Syntax

getLineById(id)

Description

Retrieve the line object by the line ID.

Parameters

id	The line ID.

Returns

Type: Line object.

See Also

Line Class Constructor

openSession

Syntax

openSession(id)

Description

Creates the Session and Server objects for the PSMC.

Parameters

id	The ID of the REN server cluster for a UQ server, or the server ID for a CTI server.

Returns

None.

start

Syntax

start()

Description

Start the JSMCAPI.

Parameters

None.

Returns

None.

stop

Syntax

stop()

Description

Stop the JSMCAPI.

Parameters

None.

Returns

None.

Reason Class Constructor

The following is the Reason class constructor.

Reason

Syntax

reason(code, desc)

Description

The Reason object carries the reason code and reason description.

Parameters

code	The reason code.
desc	The reason description.

Returns

Type: Reason object.

Reason Class Fields

The following are the Reason class fields.

code

Description

The reason code.

Type: string.

desc

Description

The reason description.

Type: string.

RenServer Class Constructor

The following is the RenServer class constructor.

RenServer

Syntax

RenServer()

Description

The RenServer object describes the REN server cluster information.

Parameters

None.

Returns

A RenServer object.

RenServer Class Fields

The following are the RenServer class fields.

isRunning

Description

Flag containing the state of the REN server connection.

Type: boolean.

url

Description

The REN server URL.

Type: string.

RenServer Class Callback Event Methods

The following are the RenServer class callback event methods.

onDown

Syntax

onDown(event)

Description

Fires when the REN server is down.

onUp

Syntax

onUp(event)

Description

Fires when the REN server is up.

Server Class Constructor

The following is the Server class constructor.

Server

Syntax

Server(serverId)

Description

The Server object describes the server information.

Parameters

serverId

The ID of the REN server cluster for a UQ server, or the server ID for a CTI server.

Returns

A Server object.

Server Class Fields

The following are the Server class fields.

id

Description

The server ID.

Type: string.

info

Description

The server information string.

Type: string.

state

Description

The server state.

Type: string with the following constants.

Value	Description
ST_INSERVICE	The server is in service.
ST_OUTOFSERVICE	The server is out of service.

type

Description

The type of server, either CTI or UQ.

Type: string with the following constants.

Value	Description
TYPE_CTI	The server is a CTI server.
TYPE_UQ	The server is a UQ server.

Example

The TYPE_* fields are global fields, which may be accessed without instantiating an object. They are accessed as shown in this example:

Server.TYPE_UQ = "UQ";

See Also

GLOBALS Class Fields

Server Class Callback Event Methods

The following are the Server class callback event methods.

onBroadcast

Syntax

onBroadcast(event)

Description

Fires when there is broadcast message.

onHbLost

Syntax

onHbLost(event)

Description

Fires when the server's heartbeat is lost.

onHbRecovered

Syntax

onHbRecovered(event)

Description

Fires when the server's heartbeat is recovered.

onInService

Syntax

onInService(event)

Description

Fires when the server changes state to in service.

onOutOfService

Syntax

onOutOfService(event)

Description

Fires when the server changes state to out of service.

onRestart

Syntax

onRestart(event)

Description

Fires when server restarts.

Session Class Constructor

The following is the Session class constructor.

Session

Syntax

Session(serverId)

Description

The Session object describes the session with the server.

Parameters

serverId

The ID of the REN server cluster for a UQ server, or the server ID for a CTI server.

Returns

Returns a Session object.

Session Class Fields

The following are the Session class fields.

addresses

Description

The associative array of addresses that the session register.

Type: associative array.

buddies

Description

The buddy hash table in this session.

Type: associative array

groups

Description

The group hash table in this session.

Type: associative array.

id

Description

The session ID generated by the server.

Type: string.

serverId

Description

The serverId will be unique for every session. It is used to lookup the protocol objects.

Type: string.

state

Description

The session state.

Type: string with the following constants.

Value	Description
ST_ACTIVE	The session is in the active state.
ST_CLOSED	The session is in the closed state.
ST_CLOSING	The session is in the closing state.
ST_IDLE	The session is in the idle state.

user

Description

The current user for the session.

Type: User object.

See Also

User Class Constructor

Session Class Methods

The following are the Session class methods.

close

Syntax

close()

Description

Close the session with the server.

Parameters

None.

Returns

None.

open

Syntax

open()

Description

Open the session with the server.

Parameters

None.

Returns

None.

registerAddress

Syntax

registerAddress(address)

Description

Parameters

address

The address to be registered.

Returns

None.

registerBuddy

Syntax

registerBuddy(buddy)

Description

Parameters

buddy

The buddy to be registered.

Returns

None.

registerGroup

Syntax

registerGroup(group)

Description

Parameters

group

The group to be registered.

Returns

None.

registerUser

Syntax

registerUser(user)

Description

Parameters

user

The user to be registered.

Returns

None.

statPublish

Syntax

statPublish(userStat, groupStat)

Description

Sets the Statistics publishing levels for the UQ server.

Parameters

userStat

Either 0, 1, or 2 for UserStatistics publishing.

Specify 0 for no statistics publishing, 1 for Statistics1 publishing, and 2 for Statistics2 and Statistic1 publishing.

groupStat

Either 0, 1, or 2 for GroupStatistics publishing.

Specify 0 for no statistics publishing, 1 for Statistics1 publishing, and 2 for Statistics2 and Statistic1 publishing.

Returns

None.

unregisterAddress

Syntax

unRegisterAddress(address)

Description

Unregister the address from the server so that the server will not report any events about this address.

Parameters

address

The address to be unregistered.

Returns

None.

unregisterBuddy

Syntax

unregisterBuddy(buddy)

Description

Unregister the buddy from the JSMCAPI so that the JSMCAPI will not report any events about the buddy state change.

Parameters

buddy

The buddy to be unregistered.

Returns

unregisterGroup

Syntax

unregisterGroup(group)

Description

Unregister the group from the server so that the server will not report any events about this group.

Parameters

group

The group to be unregistered.

Returns

None.

unregisterUser

Syntax

unregisterUser(user)

Description

Unregister the user from the server so that the server will not report any events to this user.

Parameters

user

The user to be unregistered.

Returns

None.

Session Class Callback Event Methods

The following are the Session class callback event methods.

onAddressRegistered

Syntax

onAddressRegistered(event)

Description

Fires when the address is registered by the session.

onAddressUnregistered

Syntax

onAddressUnregistered(event)

Description

Fires when the address is unregistered by the session.

onBuddyRegistered

Syntax

onBuddyRegistered(event)

Description

Fires when the buddy is registered by the session.

onBuddyUnregistered

Syntax

onBuddyUnregistered(event)

Description

Fires when the buddy is unregistered by the session.

onClosed

Syntax

onClosed(event)

Description

Fires when the session is closed.

onError

Syntax

onError(event)

Description

Fires when there is a session error.

onGroupRegistered

Syntax

onGroupRegistered(event)

Description

Fires when a group is registered by the session.

onGroupUnregistered

Syntax

onGroupUnregistered(event)

Description

Fires when a group is unregistered by the session.

onInfo

Syntax

onInfo(event)

Description

Fires when there is a session information event, such as the user is already logged in.

onOpened

Syntax

onOpened(event)

Description

Fires when the session is opened.

onUserRegistered

Syntax

onUserRegistered(event)

Description

Fires when the user is registered by the session.

onUserUnregistered

Syntax

onUserUnregistered(event)

Description

Fires when the user gets unregistered by the session.

Task Class Hierarchy

The Task class can be extended by other subclasses. The following flowchart shows the different subclasses, and how they interrelate.

Task class hierarchy

See Also

Call Class Constructor

Chat Class Constructor

Email Class Constructor

GenericAddress Class Constructor

Task Class Constructor

The following is the Task class constructor.

Task

Syntax

Task()

Description

Task is an abstract base class.

Parameters

None.

Returns

Type: Task object.

Task Class Fields

The following are the Task class fields.

caseid

Description

The associated case ID.

Type: string.

cost

Description

The associated cost.

Type: string.

customerid

Description

The associated customer ID.

Type: string.

group

Description

The associated group.

Type: string.

id

Description

The associated ID.

Type: string.

onStat

Description

The associated onStat.

Type: string.

priority

Description

The associated priority.

Type: string.

type

Description

The associated type.

Type: string, one of the following:

Value	Description
TYPE_A2ACHAT	The A2AChat type.
TYPE_CHAT	The chat type
TYPE_CTI	The CTI type.
TYPE_EMAIL	The email type.
TYPE_GENERIC	The generic type.

Example

The TYPE_* fields are global fields, which may be accessed without instantiating an object. They are accessed as shown in this example:

Task.TYPE_GENERIC = "GENERIC";

See Also

GLOBALS Class Fields

urlAbs

Description

The associated absolute URL.

Type: urlAbs object.

urlRel

Description

The associated relative URL.

Type: urlRel object.

User Class Constructor

The User class extends the _User class.

See _User Class Constructor.

The following is the User class constructor.

User

Syntax

User(id, name, agentId, agentPassword)

Description

Describes the user/agent.

Parameters

id	The user ID.
name	The user name.
agentId	The agent ID.
agentPassword	The agent's password.

Returns

A User object.

User Class Fields

The User class inherits the following fields from the _User class:

agentId
caps
id
name
presences
ST_LOGGEDIN
ST_LOGGEDOUT
ST_NOTREADY
ST_READY
ST_UNKNOWN
ST_WORKNOTREADY
ST_WORKREADY
states
statistics
statistics1
statistics2

The following are the User class fields.

addresses

Description

The addresses associated with this agent.

Type: associative array.

agentPassword

Description

The password for this agent.

Type: string.

language

Description

The language for this agent.

Type: string.

registeredAddresses

Description

The registered addresses for this user.

Type: associative array.

User Class Methods

The following are the User class methods.

disableMedia

Syntax

disableMedia(group, mediaType, extension, reason)

Description

Disable a media channel for an agent on a group/queue.

Parameters

group	The group (queue) on which to disable the specified media type.
mediaType	The media type to disable.
extension	The extension on which to disable the specified media type.
reason	The reason for disabling this media type.

Returns

None.

enableMedia

Syntax

enableMedia(group, mediaType, extension, reason)

Description

Enable a media channel for an agent on a group/queue.

Parameters

group	The group (queue) on which to enable the specified media type.
mediaType	The media type to enable.
extension	The extension on which to enable the specified media type.
reason	The reason for enabling this media type.

Returns

None.

isMediaEnabled

Syntax

isMediaEnabled(mediaType, group)

Description

Determines if the specified media type is enabled.

Parameters

mediaType	Specify the media type.
group	Specify the group.

Returns

Returns true if the media type is enabled.

login

Syntax

login(group, extension, reason)

Description

Log the user in to a queue.

Parameters

group	The group to which the user will log in.
extension	The extension.
reason	The reason for the login.

Returns

None.

loginUq

Syntax

loginUq(group)

Description

Log a user in to a UQ server queue.

Parameters

group

The group (queue) to which the user will login.

Returns

None.

logout

Syntax

logout(group, extension, reason)

Description

Log the user out of the specified group (queue).

Parameters

group	The group from which the user will log out.
extension	The extension.
reason	The reason for the lout.

Returns

None.

logoutUq

Syntax

logoutUq(group)

Description

Log the user out from the UQ server queue.

Parameters

group

The group (queue) from which to log the user out.

Returns

None.

register

Syntax

register(extension, reason)

Description

Parameters

extension	The extension to be registered.
reason	The reason to register the extension.

Returns

None.

setNotReady

Syntax

setNotReady(group, presence, extension, reason)

Description

Set the user state as not ready.

Parameters

group	The group on which the user is changing state.
presence	The presence in the new state.
extension	The extension that the user is changing state with.
reason	The reason to set not ready.

Returns

None.

setPresence

Syntax

setPresence(group, presence, extension, reason)

Description

Set the presence for the current state.

Parameters

group	The group on which the user is changing presence.
presence	The presence for the state.
extension	The extension that the user is changing presence with.
reason	The reason to set the presence.

Returns

None.

setPresenceUq

Syntax

setPresenceUq(group, presenceText, reason)

Description

Set the Presence for UQ servers.

Parameters

group	The group (queue) the user is changing their presence on.
presenceText	The new presence.
reason	The reason to set the new presence.

Returns

None.

setReady

Syntax

setReady(group, presence, extension, reason)

Description

Set the user state as ready.

Parameters

group	The group on which the user is changing state.
presence	The presence for the state.
extension	The extension that the user is changing state with.
reason	The reason to set the state.

Returns

None.

setWorkNotReady

Syntax

setWorkNotReady(group, presence, extension, reason)

Description

Set the user state as work not ready.

Parameters

group	The group on which the user is changing state.
presence	The presence for the state.
extension	The extension that the user is changing state with.
reason	The reason to set work not ready.

Returns

None.

setWorkReady

Syntax

setWorkReady(group, presence, extension, reason)

Description

Set the user state as work ready.

Parameters

group	The group on which the user is changing state.
presence	The presence for the state.
extension	The extension that the user is changing state with.
reason	The reason to set work ready.

Returns

None.

unregister

Syntax

unregister(extension, reason)

Description

Unregister an extension for the user.

Parameters

extension	The extension to be unregistered.
reason	The reason to unregister the extension.

Returns

None.

User Class Callback Event Methods

The following are the User class callback event methods.

onCapabilitiesChanged

Syntax

onCapabilitiesChanged(event)

Description

Fires when capabilities changed.

onCtiBusy

Syntax

onCtiBusy(event)

Description

Fires when the UQ server is notified that the CTI is busy.

onCtiClear

Syntax

onCtiClear(event)

Description

Fires when the UQ server is notified that the CTI is clear.

onDropped

Syntax

onDropped(event)

Description

Fires when user is dropped.

onError

Syntax

onError(event)

Description

Fires when an error occurs.

onInfo

Syntax

onInfo(event)

Description

Fires when an information event occurs. Currently only used on UQ server.

onLoggedIn

Syntax

onLoggedIn(event)

Description

Fires when the user is logged in.

onLoggedOut

Syntax

onLoggedOut(event)

Description

Fires when the user is logged out.

onLoggingIn

Syntax

onLoggingIn(event)

Description

Fires when the user is logging in.

onLoggingOut

Syntax

onLoggingOut(event)

Description

Fires when the user is logging out.

onMediaDisabled

Syntax

onMediaDisabled(event)

Description

Fires when a media type is disabled.

onMediaEnabled

Syntax

onMediaEnabled(event)

Description

Fires when a media type is enabled.

onNotReady

Syntax

onNotReady(event)

Description

Fires when a user state changes to not ready.

onPresenceChanged

Syntax

onPresenceChanged(event)

Description

Fires when the user's presence is changed.

onReady

Syntax

onReady(event)

Description

Fires when the user's state changes to ready.

onRegistered

Syntax

onRegistered(event)

Description

Fires when the address is registered.

onRegistering

Syntax

onRegistering(event)

Description

Fires when registering the address.

onSettingNotReady

Syntax

onSettingNotReady(event)

Description

Fires when setting the user's state to not ready.

onSettingPresence

Syntax

(event)

onSettingPresence

Description

Fires when setting presence for the current state.

onSettingReady

Syntax

onSettingReady(event)

Description

Fires when setting the user's state to ready.

onSettingWorkNotReady

Syntax

onSettingWorkNotReady(event)

Description

Fires when setting the user's state to work not ready.

onSettingWorkReady

Syntax

onSettingWorkReady(event)

Description

Fires when setting the user's state to work ready.

onStat

Syntax

onStat(event)

Description

Fires when statistics are received.

onStat1

Syntax

onStat1(event)

Description

Fires when statistics1 is received.

onStat2

Syntax

onStat2(event)

Description

Fires when statistics2 received.

onUnknown

Syntax

onUnknown(event)

Description

Fires when the user's state changes to unknown.

onUnregistered

Syntax

onUnregistered(event)

Description

Fires when the address gets unregistered.

onUnregistering

Syntax

onUnregistering(event)

Description

Fires when unregistering the address.

onWorkNotReady

Syntax

onWorkNotReady(event)

Description

Fires when the user's state to changes work not ready.

onWorkReady

Syntax

onWorkReady(event)

Description

Fires when the user's state changes to work ready.

UserCaps Class Constructor

The following is the UserCaps class constructor.

UserCaps

Syntax

UserCaps(strCaps)

Description

The UserCaps object describes the user capabilities.

Parameters

strCaps

The user capabilities.

Returns

A UserCaps object.

UserCaps Class Fields

The following are the UserCaps class fields

canLogin

Description

Type: boolean.

canLogout

Description

Logout capability of the user.

Type: boolean.

canRefreshState

Description

The refreshState capability of the user.

Type: boolean.

canSetNotReady

Description

The setNotReady capability of the user.

Type: boolean.

canSetPresence

Description

The setPresence capability of the user.

Type: boolean.

canSetReady

Description

The setReady capability of the user.

Type: boolean.

canSetWorkNotReady

Description

The setWorkNotReady capability of the user.

Type: boolean.

canSetWorkReady

Description

The setWorkReady capability of the user.

Type: boolean.

UserData Class Constructor

The following is the UserData class constructor.

UserData

Syntax

UserData()

Description

The UserData object describes the key-value pairs of attached user data.

Parameters

None.

Returns

A UserData object.

UserData Class Fields

The following are the UserData class fields constants.

UserData Class Field Constants

Description

UserData class uses the following constants.

Value	Description
COMPONENT	The component.
DESCR	The description
ICSCRIPTPROGRAMNAME	The IC script program name.
ICTYPE	The IC type.
MARKET	The market.
MENU	The menu.
REFERENCEID	The reference ID
TARGET	The target.
URLABS	The absolute URL.
URLREL	The relative URL.

UserData Class Method

The following is the UserData class method.

addKeyValue

Syntax

addKeyValue(key, value)

Description

Add the key-value pair to the UserData object.

Parameters

key	The key.
value	The value.

Returns

None.

UserStatistics1 Class Constructor

The following is the UseStatistics1 class constructor.

UserStatistics1

Syntax

UserStatistics1()

Description

UQ User statistics sent on user refresh 1.

Parameters

None.

Returns

A UserStatistics1 object.

UserStatistics1 Class Fields

The following are the UserStatistics1 class fields.

availableCost

Description

The amount of unused work.

ctiBusy

Description

Flag indicating that a user is engaged on CTI task.

currentQueue

Description

Current queue/group the User last logged into.

Type: string.

mostRecentTaskData

Description

Most recent task's data.

Type: string.

mostRecentTaskId

Description

Most recent task's ID.

Type: string.

numTaskAccepted

Description

The number of tasks accepted by the user.

Type: string.

numTasksDone

Description

The number of tasks done by the user.

numTasksUnassigned

Description

The number of tasks unassigned by the user.

Type: string.

presenceText

Description

The presence text for the user.

Type: string.

reasonFlag

Description

The reason flag for this event.

Type: string.

state

Description

Current state of the User

Type: string.

timeInCurrentState

Description

Time in current state for the user.

Type: string.

timeSinceLoggedIn

Description

The time since the user logged in.

Type: string.

UserStatistics2 Class Constructor

The following is the UserStatistics2 class constructor.

UserStatistics2

Syntax

UserStatistics2()

Description

UQ User statistics sent on user refresh 2 event.

Parameters

None.

Returns

A UserStatistics2 object.

UserStatistics2 Class Fields

The following are the UserStatistics2 class fields.

currentQueue

Description

The current queue or group for the user.

Type: string.

timeIdle

Description

Idle time for the user.

Type: string.

timeInCurrentState

Description

The time in the current state for the user.

Type: string.

timeNotReady

Description

The time during which the user was in the not ready state.

Type: string.

timeSinceLogin

Description

The time since the user logged in.

Type: string.

totalTimeAvailable

Description

The total time during which the user has been in the available state.

Type: string.

totalTimeUnavailable

Description

The total time during which the user has been in the unavailable state.