Jump to: navigation, search
(→‎Type Definitions)
Line 47: Line 47:
 
==Type Definitions==
 
==Type Definitions==
 
The Media namespace includes the following object types:  
 
The Media namespace includes the following object types:  
 +
* [[MediaNamespace#Media|Media]]
 
* [[MediaNamespace#State|State]]
 
* [[MediaNamespace#State|State]]
 +
 +
===State===
 +
{|
 +
! Description
 +
| Represents the JSON structure of a media.
 +
|-
 +
! Type
 +
| Object
 +
|-
 +
! Properties
 +
|
 +
{|
 +
! Name
 +
! Type
 +
! Description
 +
|-
 +
| name
 +
| string
 +
| The media name.
 +
|-
 +
| state
 +
| [[MediaNamespace#State|media.State]]
 +
| The media state object.
 +
|}
 +
|}
  
 
===State===
 
===State===
Line 66: Line 92:
 
| type
 
| type
 
| string
 
| 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.
+
| 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
 +
*UNKNOWN
 
|-
 
|-
 
| displayName
 
| displayName
Line 74: Line 111:
 
| operationName
 
| operationName
 
| string
 
| string
−
| The operation name to use with [[AgentNamespace#setState|agent.setState]] and [[MediaNamespace#setState|setState]].
+
| The operation name to use with [[AgentNamespace#setState|agent.setState]] and [[MediaNamespace#setState|media.setState]].
 
|}
 
|}
 
|}
 
|}

Revision as of 13:20, July 31, 2015

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.
Type Object
Properties
Name Type Description
name string The media name.
state media.State The media state object.

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
  • UNKNOWN
displayName string The display name of the state.
operationName string The operation name to use with agent.setState and media.setState.
Comments or questions about this documentation? Contact us for support!