|
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.EventAgentState
public abstract class EventAgentState
The purpose of this event is to provide agent state as known by Interaction Server in response to RequestAgentState. The request can be used by agent application to request its status after reconnect to Interaction Server (if delayed agent logout feature is enabled).
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static EventAgentState |
create()
Creates instance of EventAgentState with no parameters set. |
static EventAgentState |
create(java.lang.Integer proxyClientId,
KeyValueCollection extension,
java.lang.Integer tenantId,
java.lang.String agentId,
java.lang.String placeId,
java.lang.Boolean donotDisturb,
KeyValueCollection mediaList,
KeyValueCollection interactions)
Creates instance of EventAgentState with all parameters set. |
abstract java.lang.String |
getAgentId()
Agent identifier of the resource, if the Party is a resource and if the resource logged in with its agent identifier specified. |
abstract java.lang.Boolean |
getDonotDisturb()
'Do not disturb' mode indicator. |
abstract KeyValueCollection |
getExtension()
A key-value list of extensions. |
abstract KeyValueCollection |
getInteractions()
List containing interaction data. |
abstract KeyValueCollection |
getMediaList()
List of media types and their initial states. |
abstract java.lang.String |
getPlaceId()
Place identifier of the resource, if the Party is a resource. |
abstract java.lang.Integer |
getProxyClientId()
Proxy client identifier. |
abstract java.lang.Integer |
getReferenceId()
Reference identifier of the request. |
abstract java.lang.Integer |
getTenantId()
Tenant identifier of the Party (database ID from the configuration). |
abstract void |
setAgentId(java.lang.String agentId)
Agent identifier of the resource, if the Party is a resource and if the resource logged in with its agent identifier specified. |
abstract void |
setDonotDisturb(java.lang.Boolean donotDisturb)
'Do not disturb' mode indicator. |
abstract void |
setExtension(KeyValueCollection extension)
A key-value list of extensions. |
abstract void |
setInteractions(KeyValueCollection interactions)
List containing interaction data. |
abstract void |
setMediaList(KeyValueCollection mediaList)
List of media types and their initial states. |
abstract void |
setPlaceId(java.lang.String placeId)
Place identifier of the resource, if the Party is a resource. |
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. |
abstract void |
setTenantId(int tenantId)
Tenant identifier of the Party (database ID from the configuration). |
abstract void |
setTenantId(java.lang.Integer tenantId)
Tenant identifier of the Party (database ID from the configuration). |
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 EventAgentState create()
public static EventAgentState create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.Integer tenantId, java.lang.String agentId, java.lang.String placeId, java.lang.Boolean donotDisturb, KeyValueCollection mediaList, KeyValueCollection interactions)
proxyClientId
- The identifier of the client of proxy.extension
- Extensions.tenantId
- Tenant identifier of the party (dbid from the configuration).agentId
- Agent identifier of the resource, if party is a resource and if resource logged in with agent identifier specified.placeId
- Place identifier of the resource, if party is a resource.donotDisturb
- Default value is 'false'. 'True' value indicates that initially 'do not disturb' mode is ON.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.
public abstract java.lang.Integer getProxyClientId()
public abstract void setProxyClientId(java.lang.Integer proxyClientId)
public abstract void setProxyClientId(int proxyClientId)
public abstract KeyValueCollection getExtension()
public abstract void setExtension(KeyValueCollection extension)
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 getTenantId()
public abstract void setTenantId(java.lang.Integer tenantId)
public abstract void setTenantId(int tenantId)
public abstract java.lang.String getAgentId()
public abstract void setAgentId(java.lang.String agentId)
public abstract java.lang.String getPlaceId()
public abstract void setPlaceId(java.lang.String placeId)
public abstract java.lang.Boolean getDonotDisturb()
public abstract void setDonotDisturb(java.lang.Boolean donotDisturb)
public abstract KeyValueCollection getMediaList()
public abstract void setMediaList(KeyValueCollection mediaList)
public abstract KeyValueCollection getInteractions()
public abstract void setInteractions(KeyValueCollection interactions)
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |