Platform SDK Java 8.5 API Reference

com.genesyslab.platform.openmedia.protocol.interactionserver.requests.agentmanagement
Class RequestAgentLogin

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.openmedia.protocol.interactionserver.requests.agentmanagement.RequestAgentLogin
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestAgentLogin
extends Message

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:


The key 'DisconnectMode' will be interpreted the following way:


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

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

public static RequestAgentLogin create()
Creates instance of RequestAgentLogin with no parameters set.

Returns:
instance of 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)
Creates instance of RequestAgentLogin with all parameters set.

Parameters:
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.
Returns:
instance of RequestAgentLogin

create

public static RequestAgentLogin create(java.lang.Integer tenantId,
                                       java.lang.String placeId,
                                       ReasonInfo reason)
Creates instance of RequestAgentLogin with required parameters set.

Parameters:
tenantId - Tenant identifier of the party (dbid from the configuration).
placeId - Place identifier of the resource, if party is a resource.
reason - Reason.
Returns:
instance of RequestAgentLogin

getReferenceId

public abstract java.lang.Integer getReferenceId()
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(java.lang.Integer referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


setReferenceId

public abstract void setReferenceId(int referenceId)
Reference identifier of the request. It is the client's responsibility to generate the reference identifier and then tie the server response to the request.


getProxyClientId

public abstract java.lang.Integer getProxyClientId()
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(java.lang.Integer proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


setProxyClientId

public abstract void setProxyClientId(int proxyClientId)
Proxy client identifier. Mandatory if client connects via proxy.


getExtension

public abstract KeyValueCollection getExtension()
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


setExtension

public abstract void setExtension(KeyValueCollection extension)
A key-value list of extensions. For media servers the following extensions are defined, with values of type integer:


getTenantId

public abstract java.lang.Integer getTenantId()
Tenant identifier of the Party (database ID from the configuration).


setTenantId

public abstract void setTenantId(java.lang.Integer tenantId)
Tenant identifier of the Party (database ID from the configuration).


setTenantId

public abstract void setTenantId(int tenantId)
Tenant identifier of the Party (database ID from the configuration).


getPlaceId

public abstract java.lang.String getPlaceId()
Place identifier of the resource, if the Party is a resource.


setPlaceId

public abstract void setPlaceId(java.lang.String placeId)
Place identifier of the resource, if the Party is a resource.


getAgentId

public 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.


setAgentId

public 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.


getDonotDisturb

public abstract java.lang.Boolean getDonotDisturb()
'Do not disturb' mode indicator. 'True' value indicates that 'do not disturb' mode is on. 'False' is a default value and indicates that 'do not disturb' mode is off. Null means default value (i.e. the mode is off).


setDonotDisturb

public abstract void setDonotDisturb(java.lang.Boolean donotDisturb)
'Do not disturb' mode indicator. 'True' value indicates that 'do not disturb' mode is on. 'False' is a default value and indicates that 'do not disturb' mode is off. Null means default value (i.e. the mode is off).


getMediaList

public abstract KeyValueCollection getMediaList()
List of media types and their initial states. The key names are the system names of the media types that the resource supports. The values are integers that indicate the initial state of the media:


setMediaList

public abstract void setMediaList(KeyValueCollection mediaList)
List of media types and their initial states. The key names are the system names of the media types that the resource supports. The values are integers that indicate the initial state of the media:


getReason

public abstract ReasonInfo getReason()
This property has been deprecated in all events. In any messages sent to Interaction Server, this value must be left as 0 (the default value).


setReason

public abstract void setReason(ReasonInfo reason)
This property has been deprecated in all events. In any messages sent to Interaction Server, this value must be left as 0 (the default value).


Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.