|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.commons.protocol.DataObject
com.genesyslab.platform.commons.protocol.Message
com.genesyslab.platform.openmedia.protocol.interactionserver.events.EventForcedAgentStateChange
public abstract class EventForcedAgentStateChange
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:
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static 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)
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
- Partyreason
- Reason.
public static EventForcedAgentStateChange create(PartyInfo party)
party
- Party
public abstract java.lang.Integer getReferenceId()
public abstract void setReferenceId(java.lang.Integer referenceId)
public abstract void setReferenceId(int referenceId)
public abstract java.lang.Integer getProxyClientId()
public abstract void setProxyClientId(java.lang.Integer proxyClientId)
public abstract void setProxyClientId(int proxyClientId)
public abstract KeyValueCollection getMediaList()
public abstract void setMediaList(KeyValueCollection mediaList)
public abstract java.lang.Boolean getDonotDisturb()
public abstract void setDonotDisturb(java.lang.Boolean donotDisturb)
public abstract AgentStateChangeOperation getAgentStateChangeOperation()
public abstract void setAgentStateChangeOperation(AgentStateChangeOperation agentStateChangeOperation)
public abstract java.lang.String getMediaTypeName()
public abstract void setMediaTypeName(java.lang.String mediaTypeName)
public abstract java.util.Date getEventTime()
public abstract void setEventTime(java.util.Date eventTime)
public abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
public abstract PartyInfo getParty()
public abstract void setParty(PartyInfo party)
public abstract ReasonInfo getReason()
public abstract void setReason(ReasonInfo reason)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |