Jump to: navigation, search
(→‎setState)
(→‎State)
Line 93: Line 93:
 
*LOGOUT
 
*LOGOUT
 
*READY
 
*READY
−
*PARTIAL_READY
+
*PARTIAL_READY *
 
*NOT_READY
 
*NOT_READY
 
*NOT_READY_ACTION_CODE
 
*NOT_READY_ACTION_CODE
Line 99: Line 99:
 
*NOT_READY_AFTER_CALLWORK_ACTION_CODE
 
*NOT_READY_AFTER_CALLWORK_ACTION_CODE
 
*DND_ON
 
*DND_ON
−
*OUT_OF_SERVICE
+
*OUT_OF_SERVICE *
−
*LOGOUT_DND_ON
+
*LOGOUT_DND_ON *
−
*UNKNOWN
+
*UNKNOWN *
 
|-
 
|-
 
| displayName
 
| displayName
Line 112: Line 112:
 
|}
 
|}
 
|}
 
|}
 +
''* States that are limited to an event and can't be applied by code''
  
  
 
[[Category:V:HTCC:8.5.2DRAFT]]
 
[[Category:V:HTCC:8.5.2DRAFT]]

Revision as of 16:07, August 19, 2015

Media Namespace

Methods

The Media namespace includes the following methods:

getMediaList

Signature <static> getMediaList() → {Array.<media.Media>}
Description Get the media attributes.
Returns Array.<media.Media>

setState

Signature <static> setState(name, stateOperationName)
Description Sets the media state.
Parameters
Name Type Description
name string The media name.
stateOperationName string An operationName from the agent states list. See State.

Type Definitions

The Media namespace includes the following object types:

Media

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 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.

* States that are limited to an event and can't be applied by code

Comments or questions about this documentation? Contact us for support!