|
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.EventAgentLogin
public abstract class EventAgentLogin
This event indicates that a resource has logged in. It specifies the supported media types, their initial states, and the initial do not disturb mode.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static EventAgentLogin |
create()
Creates instance of EventAgentLogin with no parameters set. |
static EventAgentLogin |
create(java.util.Date eventTime,
AgentDescription agentDescription,
ActorInfo actor)
Creates instance of EventAgentLogin with required parameters set. |
static EventAgentLogin |
create(java.lang.Integer proxyClientId,
java.lang.Boolean donotDisturb,
KeyValueCollection mediaList,
java.util.Date eventTime,
KeyValueCollection extension,
AgentDescription agentDescription,
ActorInfo actor,
ReasonInfo reason)
Creates instance of EventAgentLogin with all parameters set. |
abstract ActorInfo |
getActor()
|
abstract AgentDescription |
getAgentDescription()
|
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.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 |
setActor(ActorInfo actor)
|
abstract void |
setAgentDescription(AgentDescription agentDescription)
|
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 |
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 EventAgentLogin create()
public static EventAgentLogin create(java.lang.Integer proxyClientId, java.lang.Boolean donotDisturb, KeyValueCollection mediaList, java.util.Date eventTime, KeyValueCollection extension, AgentDescription agentDescription, ActorInfo actor, ReasonInfo reason)
proxyClientId
- The identifier of the client of proxy.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.eventTime
- Date and time of the event.extension
- Extensions.agentDescription
- AgentDescriptionactor
- Actorreason
- Reason.
public static EventAgentLogin create(java.util.Date eventTime, AgentDescription agentDescription, ActorInfo actor)
eventTime
- Date and time of the event.agentDescription
- AgentDescriptionactor
- 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.Boolean getDonotDisturb()
public abstract void setDonotDisturb(java.lang.Boolean donotDisturb)
public abstract KeyValueCollection getMediaList()
public abstract void setMediaList(KeyValueCollection mediaList)
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 AgentDescription getAgentDescription()
public abstract void setAgentDescription(AgentDescription agentDescription)
public abstract ActorInfo getActor()
public abstract void setActor(ActorInfo actor)
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 |