|
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.requests.agentmanagement.RequestAgentLogin
public abstract class RequestAgentLogin
With this request, an agent application asks to log in to a primary Interaction Server.
Direction: From agent application to Interaction Server
It is possible to set 'InviteMode' and 'DisconnectMode' keys inside the Extension
attribute.
They control aspects of behavior when multiple agent clients connect using the same agent.
The key 'InviteMode' will be interpreted the following way:
EventInvite
will be sent to the connection that issued RequestAgentLogin with that key.EventInvite
will be sent to this connection.EventInvite
for the media that is associated with connection (see above) will be sent. This is the default setting.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestAgentLogin |
create()
Creates instance of RequestAgentLogin with no parameters set. |
static RequestAgentLogin |
create(java.lang.Integer proxyClientId,
KeyValueCollection extension,
java.lang.Integer tenantId,
java.lang.String placeId,
java.lang.String agentId,
java.lang.Boolean donotDisturb,
KeyValueCollection mediaList,
ReasonInfo reason)
Creates instance of RequestAgentLogin with all parameters set. |
static RequestAgentLogin |
create(java.lang.Integer tenantId,
java.lang.String placeId,
ReasonInfo reason)
Creates instance of RequestAgentLogin with required 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 |
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 ReasonInfo |
getReason()
This property has been deprecated in all events. |
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 |
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 |
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. |
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 RequestAgentLogin create()
public static RequestAgentLogin create(java.lang.Integer proxyClientId, KeyValueCollection extension, java.lang.Integer tenantId, java.lang.String placeId, java.lang.String agentId, java.lang.Boolean donotDisturb, KeyValueCollection mediaList, ReasonInfo reason)
proxyClientId
- The identifier of the client of proxy.extension
- Extensions.tenantId
- Tenant identifier of the party (dbid from the configuration).placeId
- Place identifier of the resource, if party is a resource.agentId
- Agent identifier of the resource, if party is a resource and if resource logged in with agent identifier specified.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.reason
- Reason.
public static RequestAgentLogin create(java.lang.Integer tenantId, java.lang.String placeId, ReasonInfo reason)
tenantId
- Tenant identifier of the party (dbid from the configuration).placeId
- Place identifier of the resource, if party is a resource.reason
- Reason.
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 getExtension()
public abstract void setExtension(KeyValueCollection extension)
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 getPlaceId()
public abstract void setPlaceId(java.lang.String placeId)
public abstract java.lang.String getAgentId()
public abstract void setAgentId(java.lang.String agentId)
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 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 |