Revision as of 11:22, August 11, 2015

Media Namespace

The Media namespace includes the following methods:

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

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.

The Media namespace includes the following object types:

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.

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.

@@ Line 9: / Line 9: @@
 {|
 ! Signature
-| <static> getMediaList() → {Array.<object>}
+| <static> getMediaList() → {Array.<[[MediaNamespace#State|media.Media]]>}
 |-
 ! Description
@@ Line 15: / Line 15: @@
 |-
 ! Returns
-| list[] (Type: Array.<object>) &mdash; an array of all the media with the following attributes:
+| Array.<[[MediaNamespace#State|media.Media]]>
-* list[].media (Type: string) &mdash; The media name.
-* list[].state (Type: [[MediaNamespace#State|media.State]]) &mdash; The media state object.
 |}