|
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.EventPlaceAgentState
public abstract class EventPlaceAgentState
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static 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)
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 timestampmediaListEx
- 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 changeeventTime
- Date and time of the event.actor
- Actorextension
- Extensions.
public static EventPlaceAgentState create(java.lang.Integer doNotDisturb, java.lang.Integer monitored, KeyValueCollection mediaList, KeyValueCollection interactions, ActorInfo actor)
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
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 java.lang.Integer getDoNotDisturb()
public abstract void setDoNotDisturb(java.lang.Integer doNotDisturb)
public abstract void setDoNotDisturb(int doNotDisturb)
public abstract java.lang.Integer getMonitored()
public abstract void setMonitored(java.lang.Integer monitored)
public abstract void setMonitored(int monitored)
public abstract KeyValueCollection getMediaList()
public abstract void setMediaList(KeyValueCollection mediaList)
public abstract KeyValueCollection getInteractions()
public abstract void setInteractions(KeyValueCollection interactions)
public abstract java.lang.String getAgentLoginSessionId()
public abstract void setAgentLoginSessionId(java.lang.String agentLoginSessionId)
public abstract java.util.Date getLoggedInAt()
public abstract void setLoggedInAt(java.util.Date loggedInAt)
public abstract java.util.Date getDndChangedAt()
public abstract void setDndChangedAt(java.util.Date dndChangedAt)
public abstract KeyValueCollection getMediaListEx()
public abstract void setMediaListEx(KeyValueCollection mediaListEx)
public abstract java.util.Date getEventTime()
public abstract void setEventTime(java.util.Date eventTime)
public abstract ActorInfo getActor()
public abstract void setActor(ActorInfo actor)
public abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |