Media Namespace
Methods
The Media namespace includes the following methods:
getMediaList
| Signature
|
<static> getMediaList() → {Array.<object>}
|
| Description
|
Get the media attributes.
|
| Returns
|
list[] (Type: Array.<object>) — an array of all the media with the following attributes:
- list[].media (Type: string) — The media name.
- list[].state (Type: media.State) — The media state object.
|
setState
| Signature
|
<static> setState(name, stateOperationName)
|
| Description
|
Sets the media state.
|
| Parameters
|
| Name
|
Type
|
Description
|
| name
|
string
|
The media name.
|
| stateOperationName
|
string
|
An operation name from the agent states list.
|
|
Type Definitions
The Media namespace includes the following object types:
State
| Description
|
Represents the JSON structure of a media state.
|
| Type
|
Object
|
| Properties
|
| Name
|
Type
|
Description
|
| type
|
string
|
The type of the operation. Possible values are: LOGOUT, READY, PARTIAL_READY, NOT_READY, NOT_READY_ACTION_CODE, NOT_READY_AFTER_CALLWORK, NOT_READY_AFTER_CALLWORK_ACTION_CODE, DND_ON, OUT_OF_SERVICE, LOGOUT_DND_ON, and UNKNOWN.
|
| displayName
|
string
|
The display name of the state.
|
| operationName
|
string
|
The operation name to use with agent.setState and setState.
|
|
