User Class Methods
The following are the User class methods.
Syntax
ctiBusyUq(busy, subtractcost, task)
Description
Flip ctiBusy flag, reduce cost of a CTI task from an agent's workload, or both. If the task is the same as the agent's assigned task, then the task's cost will be used. In case they do not match, the task type is checked and the default cost of the task is used to recalculate the workload.
Parameters
|
Field or Control |
Definition |
|---|---|
| busy |
The ctibusy flag that can have a value of 0 or 1. |
| subtractcost |
Flag to reduce cost of the cti task from the agent's workload. It can be set to 0 or 1. |
| task |
The task object. |
Returns
Request number.
Syntax
disableMedia(group, mediaType, extension, reason)
Description
Disable a media channel for an agent on a group/queue.
Parameters
|
Field or Control |
Definition |
|---|---|
| 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
Request number.
Syntax
enableMedia(group, mediaType, extension, reason)
Description
Enable a media channel for an agent on a group/queue.
Parameters
|
Field or Control |
Definition |
|---|---|
| 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
Request number.
Syntax
isMediaEnabled(mediaType, group)
Description
Determines if the specified media type is enabled.
Parameters
|
Field or Control |
Definition |
|---|---|
| mediaType |
Enter the media type. |
| group |
Enter the group. |
Returns
Returns true if the media type is enabled.
Syntax
login(group, extension, reason)
Description
Log the user in to a queue.
Parameters
|
Field or Control |
Definition |
|---|---|
| group |
The group to which the user will log in. |
| extension |
The extension. |
| reason |
The reason for the login. |
Returns
Request number.
Syntax
loginUq(group)
Description
Log a user in to a UQ server queue.
Parameters
|
Field or Control |
Definition |
|---|---|
| group |
The group (queue) to which the user will login. |
Returns
Request number.
Syntax
logout(group, extension, reason)
Description
Log the user out of the specified group (queue).
Parameters
|
Field or Control |
Definition |
|---|---|
| group |
The group from which the user will log out. |
| extension |
The extension. |
| reason |
The reason for the log out. |
Returns
Request number.
Syntax
logoutUq(group)
Description
Log the user out from the UQ server queue.
Parameters
|
Field or Control |
Definition |
|---|---|
| group |
The group (queue) from which to log the user out. |
Returns
Request number.
Syntax
register(extension, reason)
Description
Register an extension for the user.
Parameters
|
Field or Control |
Definition |
|---|---|
| extension |
The extension to be registered. |
| reason |
The reason to register the extension. |
Returns
Request number.
Syntax
setNotReady(group, presence, extension, reason)
Description
Set the user state as not ready.
Parameters
|
Field or Control |
Definition |
|---|---|
| group |
The group on which the user is changing state. |
| presence |
The presence in the new state. |
| extension |
The extension with which the user is changing state. |
| reason |
The reason to set not ready. |
Returns
Request number.
Syntax
setPresence(group, presence, extension, reason)
Description
Set the presence for the current state.
Parameters
|
Field or Control |
Definition |
|---|---|
| group |
The group on which the user is changing presence. |
| presence |
The presence for the state. |
| extension |
The extension with which the user is changing presence. |
| reason |
The reason to set the presence. |
Returns
Request number.
Syntax
setPresenceUq(group, presenceText, reason)
Description
Set the Presence for UQ servers.
Parameters
|
Field or Control |
Definition |
|---|---|
| group |
The group (queue) on which the user is changing his or her presence. |
| presenceText |
The new presence. |
| reason |
The reason to set the new presence. |
Returns
Request number.
Syntax
setReady(group, presence, extension, reason)
Description
Set the user state as ready.
Parameters
|
Field or Control |
Definition |
|---|---|
| group |
The group on which the user is changing state. |
| presence |
The presence for the state. |
| extension |
The extension with which the user is changing state. |
| reason |
The reason to set the state. |
Returns
Request number.
Syntax
setWorkNotReady(group, presence, extension, reason)
Description
Set the user state as work not ready.
Parameters
|
Field or Control |
Definition |
|---|---|
| group |
The group on which the user is changing state. |
| presence |
The presence for the state. |
| extension |
The extension with which the user is changing state. |
| reason |
The reason to set work not ready. |
Returns
Request number.
Syntax
setWorkReady(group, presence, extension, reason)
Description
Set the user state as work ready.
Parameters
|
Field or Control |
Definition |
|---|---|
| group |
The group on which the user is changing state. |
| presence |
The presence for the state. |
| extension |
The extension with which the user is changing state. |
| reason |
The reason to set work ready. |
Returns
Request number.
Syntax
unregister(extension, reason)
Description
Unregister an extension for the user.
Parameters
|
Field or Control |
Definition |
|---|---|
| extension |
The extension to be unregistered. |
| reason |
The reason to unregister the extension. |
Returns
Request number.