Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.events
Class EventPlaceAgentState

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.openmedia.protocol.interactionserver.events.EventPlaceAgentState
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventPlaceAgentState
extends Message

Interaction Server generates this event after the reporting engine registers for a specified resource. This event indicates the current state of that resource, including media states and a list of the interactions being handled.


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventPlaceAgentState create()
          Creates instance of EventPlaceAgentState with no parameters set.
static EventPlaceAgentState create(java.lang.Integer proxyClientId, java.lang.Integer doNotDisturb, java.lang.Integer monitored, KeyValueCollection mediaList, KeyValueCollection interactions, java.lang.String agentLoginSessionId, java.util.Date loggedInAt, java.util.Date dndChangedAt, KeyValueCollection mediaListEx, java.util.Date eventTime, ActorInfo actor, KeyValueCollection extension)
          Creates instance of EventPlaceAgentState with all parameters set.
static EventPlaceAgentState create(java.lang.Integer doNotDisturb, java.lang.Integer monitored, KeyValueCollection mediaList, KeyValueCollection interactions, ActorInfo actor)
          Creates instance of EventPlaceAgentState with required parameters set.
abstract  ActorInfo getActor()
           
abstract  java.lang.String getAgentLoginSessionId()
          Unique identifier of the login session.
abstract  java.util.Date getDndChangedAt()
          Time of the last change in do not disturb state.
abstract  java.lang.Integer getDoNotDisturb()
          The default value 0 (zero) indicates that do not disturb mode is off.
abstract  java.util.Date getEventTime()
          Date and time of the event.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  KeyValueCollection getInteractions()
          List containing interaction data.
abstract  java.util.Date getLoggedInAt()
          Time of login.
abstract  KeyValueCollection getMediaList()
          List of media types and their initial states.
abstract  KeyValueCollection getMediaListEx()
          Extended information on media types.
abstract  java.lang.Integer getMonitored()
          Reserved for future use.
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  void setActor(ActorInfo actor)
           
abstract  void setAgentLoginSessionId(java.lang.String agentLoginSessionId)
          Unique identifier of the login session.
abstract  void setDndChangedAt(java.util.Date dndChangedAt)
          Time of the last change in do not disturb state.
abstract  void setDoNotDisturb(int doNotDisturb)
          The default value 0 (zero) indicates that do not disturb mode is off.
abstract  void setDoNotDisturb(java.lang.Integer doNotDisturb)
          The default value 0 (zero) indicates that do not disturb mode is off.
abstract  void setEventTime(java.util.Date eventTime)
          Date and time of the event.
abstract  void setExtension(KeyValueCollection extension)
          A key-value list of extensions.
abstract  void setInteractions(KeyValueCollection interactions)
          List containing interaction data.
abstract  void setLoggedInAt(java.util.Date loggedInAt)
          Time of login.
abstract  void setMediaList(KeyValueCollection mediaList)
          List of media types and their initial states.
abstract  void setMediaListEx(KeyValueCollection mediaListEx)
          Extended information on media types.
abstract  void setMonitored(int monitored)
          Reserved for future use.
abstract  void setMonitored(java.lang.Integer monitored)
          Reserved for future use.
abstract  void setProxyClientId(int proxyClientId)
          Proxy client identifier.
abstract  void setProxyClientId(java.lang.Integer proxyClientId)
          Proxy client identifier.
abstract  void setReferenceId(int referenceId)
          Reference identifier of the request.
abstract  void setReferenceId(java.lang.Integer referenceId)
          Reference identifier of the request.
 
Methods inherited from class com.genesyslab.platform.commons.protocol.Message
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription
 
Methods inherited from class com.genesyslab.platform.commons.protocol.DataObject
equals, hashCode, toString, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

public static EventPlaceAgentState create()
Creates instance of EventPlaceAgentState with no parameters set.

Returns:
instance of EventPlaceAgentState

create

public static EventPlaceAgentState create(java.lang.Integer proxyClientId,
                                          java.lang.Integer doNotDisturb,
                                          java.lang.Integer monitored,
                                          KeyValueCollection mediaList,
                                          KeyValueCollection interactions,
                                          java.lang.String agentLoginSessionId,
                                          java.util.Date loggedInAt,
                                          java.util.Date dndChangedAt,
                                          KeyValueCollection mediaListEx,
                                          java.util.Date eventTime,
                                          ActorInfo actor,
                                          KeyValueCollection extension)
Creates instance of EventPlaceAgentState with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
doNotDisturb - Agent DoNotDisturb status.
monitored - 'true'
mediaList - List of media types and their initial states. The key names are media type system names. The values should be of type integer. Non-zero value indicates that initial state for the media is READY.
interactions - Key-value list that contains interaction data. Each key in the list is an interaction identifier. Values are key-value lists that contain interaction properties.
agentLoginSessionId - Unique login session identifier.
loggedInAt - [optional] Agent login timestamp.
dndChangedAt - Last DND state change timestamp
mediaListEx - Extended media types information: each key is a media type name. Each value is a key-value list containing the following keys: 'MediaAddedAt' - timestamp when media was added, 'MediaStateChangedAt' - timestamp of the last media state change
eventTime - Date and time of the event.
actor - Actor
extension - Extensions.
Returns:
instance of EventPlaceAgentState

create

public static EventPlaceAgentState create(java.lang.Integer doNotDisturb,
                                          java.lang.Integer monitored,
                                          KeyValueCollection mediaList,
                                          KeyValueCollection interactions,
                                          ActorInfo actor)
Creates instance of EventPlaceAgentState with required parameters set.

Parameters:
doNotDisturb - Agent DoNotDisturb status.
monitored - 'true'
mediaList - List of media types and their initial states. The key names are media type system names. The values should be of type integer. Non-zero value indicates that initial state for the media is READY.
interactions - Key-value list that contains interaction data. Each key in the list is an interaction identifier. Values are key-value lists that contain interaction properties.
actor - Actor
Returns:
instance of EventPlaceAgentState

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


getProxyClientId

public abstract java.lang.Integer getProxyClientId()
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(java.lang.Integer proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(int proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


getDoNotDisturb

public abstract java.lang.Integer getDoNotDisturb()
The default value 0 (zero) indicates that do not disturb mode is off. A nonzero value indicates that do not disturb mode is on.


setDoNotDisturb

public abstract void setDoNotDisturb(java.lang.Integer doNotDisturb)
The default value 0 (zero) indicates that do not disturb mode is off. A nonzero value indicates that do not disturb mode is on.


setDoNotDisturb

public abstract void setDoNotDisturb(int doNotDisturb)
The default value 0 (zero) indicates that do not disturb mode is off. A nonzero value indicates that do not disturb mode is on.


getMonitored

public abstract java.lang.Integer getMonitored()
Reserved for future use.


setMonitored

public abstract void setMonitored(java.lang.Integer monitored)
Reserved for future use.


setMonitored

public abstract void setMonitored(int monitored)
Reserved for future use.


getMediaList

public abstract KeyValueCollection getMediaList()
List of media types and their initial states. The key names are the system names of the media types that the resource supports. The values are integers that indicate the initial state of the media:


setMediaList

public abstract void setMediaList(KeyValueCollection mediaList)
List of media types and their initial states. The key names are the system names of the media types that the resource supports. The values are integers that indicate the initial state of the media:


getInteractions

public abstract KeyValueCollection getInteractions()
List containing interaction data. Each key in the list is an interaction identifier. Values are key-value lists that contain interaction properties.


setInteractions

public abstract void setInteractions(KeyValueCollection interactions)
List containing interaction data. Each key in the list is an interaction identifier. Values are key-value lists that contain interaction properties.


getAgentLoginSessionId

public abstract java.lang.String getAgentLoginSessionId()
Unique identifier of the login session.


setAgentLoginSessionId

public abstract void setAgentLoginSessionId(java.lang.String agentLoginSessionId)
Unique identifier of the login session.


getLoggedInAt

public abstract java.util.Date getLoggedInAt()
Time of login.


setLoggedInAt

public abstract void setLoggedInAt(java.util.Date loggedInAt)
Time of login.


getDndChangedAt

public abstract java.util.Date getDndChangedAt()
Time of the last change in do not disturb state.


setDndChangedAt

public abstract void setDndChangedAt(java.util.Date dndChangedAt)
Time of the last change in do not disturb state.


getMediaListEx

public abstract KeyValueCollection getMediaListEx()
Extended information on media types. Each key is a media type name. Each value is a key-value list containing the following keys:


setMediaListEx

public abstract void setMediaListEx(KeyValueCollection mediaListEx)
Extended information on media types. Each key is a media type name. Each value is a key-value list containing the following keys:


getEventTime

public abstract java.util.Date getEventTime()
Date and time of the event.


setEventTime

public abstract void setEventTime(java.util.Date eventTime)
Date and time of the event.


getActor

public abstract ActorInfo getActor()

setActor

public abstract void setActor(ActorInfo actor)

getExtension

public abstract KeyValueCollection getExtension()
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


setExtension

public abstract void setExtension(KeyValueCollection extension)
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.