Platform SDK Java 8.5 API Reference

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

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.EventForcedAgentStateChange
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class EventForcedAgentStateChange
extends Message

This event provides the means to notify agent applications of agent state changes that have been made by Interaction Server or another component other than the agent application itself. For example, Interaction Server sends this event in the following situations:

Direction: From Interaction Server to agent application


Field Summary
static int ID
           
static java.lang.String NAME
           
 
Method Summary
static EventForcedAgentStateChange create()
          Creates instance of EventForcedAgentStateChange with no parameters set.
static EventForcedAgentStateChange create(java.lang.Integer proxyClientId, KeyValueCollection mediaList, java.lang.Boolean donotDisturb, AgentStateChangeOperation agentStateChangeOperation, java.lang.String mediaTypeName, java.util.Date eventTime, KeyValueCollection extension, PartyInfo party, ReasonInfo reason)
          Creates instance of EventForcedAgentStateChange with all parameters set.
static EventForcedAgentStateChange create(PartyInfo party)
          Creates instance of EventForcedAgentStateChange with required parameters set.
abstract  AgentStateChangeOperation getAgentStateChangeOperation()
          Values: 0-The event is not a result of the immediate state change (reserved) 1-Agent is made not ready for media 2-Agent is made ready for media 3-Media removed 4-Media added.
abstract  java.lang.Boolean getDonotDisturb()
          'Do not disturb' mode indicator.
abstract  java.util.Date getEventTime()
          Date and time of the event.
abstract  KeyValueCollection getExtension()
          A key-value list of extensions.
abstract  KeyValueCollection getMediaList()
          List of media types and their initial states.
abstract  java.lang.String getMediaTypeName()
          Media type name.
abstract  PartyInfo getParty()
           
abstract  java.lang.Integer getProxyClientId()
          Proxy client identifier.
abstract  ReasonInfo getReason()
          This property has been deprecated in all events.
abstract  java.lang.Integer getReferenceId()
          Reference identifier of the request.
abstract  void setAgentStateChangeOperation(AgentStateChangeOperation agentStateChangeOperation)
          Values: 0-The event is not a result of the immediate state change (reserved) 1-Agent is made not ready for media 2-Agent is made ready for media 3-Media removed 4-Media added.
abstract  void setDonotDisturb(java.lang.Boolean donotDisturb)
          'Do not disturb' mode indicator.
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 setMediaList(KeyValueCollection mediaList)
          List of media types and their initial states.
abstract  void setMediaTypeName(java.lang.String mediaTypeName)
          Media type name.
abstract  void setParty(PartyInfo party)
           
abstract  void setProxyClientId(int proxyClientId)
          Proxy client identifier.
abstract  void setProxyClientId(java.lang.Integer proxyClientId)
          Proxy client identifier.
abstract  void setReason(ReasonInfo reason)
          This property has been deprecated in all events.
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 EventForcedAgentStateChange create()
Creates instance of EventForcedAgentStateChange with no parameters set.

Returns:
instance of EventForcedAgentStateChange

create

public static EventForcedAgentStateChange create(java.lang.Integer proxyClientId,
                                                 KeyValueCollection mediaList,
                                                 java.lang.Boolean donotDisturb,
                                                 AgentStateChangeOperation agentStateChangeOperation,
                                                 java.lang.String mediaTypeName,
                                                 java.util.Date eventTime,
                                                 KeyValueCollection extension,
                                                 PartyInfo party,
                                                 ReasonInfo reason)
Creates instance of EventForcedAgentStateChange with all parameters set.

Parameters:
proxyClientId - The identifier of the client of proxy.
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.
donotDisturb - Default value is 'false'. 'True' value indicates that initially 'do not disturb' mode is ON.
agentStateChangeOperation -
mediaTypeName - Name of the new media added.
eventTime - Date and time of the event.
extension - Extensions.
party - Party
reason - Reason.
Returns:
instance of EventForcedAgentStateChange

create

public static EventForcedAgentStateChange create(PartyInfo party)
Creates instance of EventForcedAgentStateChange with required parameters set.

Parameters:
party - Party
Returns:
instance of EventForcedAgentStateChange

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.


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:


getDonotDisturb

public abstract java.lang.Boolean getDonotDisturb()
'Do not disturb' mode indicator. 'True' value indicates that 'do not disturb' mode is on. 'False' is a default value and indicates that 'do not disturb' mode is off. Null means default value (i.e. the mode is off).


setDonotDisturb

public abstract void setDonotDisturb(java.lang.Boolean donotDisturb)
'Do not disturb' mode indicator. 'True' value indicates that 'do not disturb' mode is on. 'False' is a default value and indicates that 'do not disturb' mode is off. Null means default value (i.e. the mode is off).


getAgentStateChangeOperation

public abstract AgentStateChangeOperation getAgentStateChangeOperation()
Values:


setAgentStateChangeOperation

public abstract void setAgentStateChangeOperation(AgentStateChangeOperation agentStateChangeOperation)
Values:


getMediaTypeName

public abstract java.lang.String getMediaTypeName()
Media type name.


setMediaTypeName

public abstract void setMediaTypeName(java.lang.String mediaTypeName)
Media type name.


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.


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:


getParty

public abstract PartyInfo getParty()

setParty

public abstract void setParty(PartyInfo party)

getReason

public abstract ReasonInfo getReason()
This property has been deprecated in all events. In any messages sent to Interaction Server, this value must be left as 0 (the default value).


setReason

public abstract void setReason(ReasonInfo reason)
This property has been deprecated in all events. In any messages sent to Interaction Server, this value must be left as 0 (the default value).


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.