Platform SDK Java 8.5 API Reference

com.genesyslab.platform.voice.protocol.tserver.requests.agent
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.voice.protocol.tserver.requests.agent.RequestAgentLogin
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestAgentLogin
extends Message

Logs in the agent agent_id.
Note: Set the thisQueue parameter with the value of the ACD group.
If the login request is successful, your application receives the event EventAgentLogin.


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.String thisDN, AgentWorkMode agentWorkMode)
          Creates instance of RequestAgentLogin with required parameters set.
static RequestAgentLogin create(java.lang.String thisDN, AgentWorkMode agentWorkMode, java.lang.String thisQueue, java.lang.String agentID, java.lang.String password, KeyValueCollection reasons, KeyValueCollection extensions)
          Creates instance of RequestAgentLogin with all parameters set.
abstract  java.lang.String getAgentID()
          The agent identifier specified by PBX or ACD.
abstract  AgentWorkMode getAgentWorkMode()
          The Agent workmode.
abstract  KeyValueCollection getExtensions()
          An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data.
abstract  java.lang.String getPassword()
          The password to get logged in.
abstract  KeyValueCollection getReasons()
          Additional data intended to specify reasons for and results of actions taken by the user.
abstract  java.lang.Integer getReferenceID()
          Reference ID of the related request.
abstract  java.lang.String getThisDN()
          The Directory Number (which your application registered) involved in this request or event.
abstract  java.lang.String getThisQueue()
          The queue related to ThisDN
abstract  void setAgentID(java.lang.String agentID)
          The agent identifier specified by PBX or ACD.
abstract  void setAgentWorkMode(AgentWorkMode agentWorkMode)
          The Agent workmode.
abstract  void setExtensions(KeyValueCollection extensions)
          An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data.
abstract  void setPassword(java.lang.String password)
          The password to get logged in.
abstract  void setReasons(KeyValueCollection reasons)
          Additional data intended to specify reasons for and results of actions taken by the user.
abstract  void setReferenceID(int referenceID)
          Reference ID of the related request.
abstract  void setReferenceID(java.lang.Integer referenceID)
          Reference ID of the related request.
abstract  void setThisDN(java.lang.String thisDN)
          The Directory Number (which your application registered) involved in this request or event.
abstract  void setThisQueue(java.lang.String thisQueue)
          The queue related to ThisDN
 
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.String thisDN,
                                       AgentWorkMode agentWorkMode,
                                       java.lang.String thisQueue,
                                       java.lang.String agentID,
                                       java.lang.String password,
                                       KeyValueCollection reasons,
                                       KeyValueCollection extensions)
Creates instance of RequestAgentLogin with all parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
agentWorkMode - The current work mode of the agent in question.
thisQueue - The queue related to ThisDN
agentID - The agent identifier specified by PBX or ACD.
password - Password that allows the agent to be logged in.
reasons - Additional data intended to specify reasons for and results of actions taken by the user.
extensions - An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data.
Returns:
instance of RequestAgentLogin

create

public static RequestAgentLogin create(java.lang.String thisDN,
                                       AgentWorkMode agentWorkMode)
Creates instance of RequestAgentLogin with required parameters set.

Parameters:
thisDN - DN of the controlling agent or Route Point.
agentWorkMode - The current work mode of the agent in question.
Returns:
instance of RequestAgentLogin

getReferenceID

public abstract java.lang.Integer getReferenceID()
Reference ID of the related request. In event objects, this reference ID indicates to which request the event refers to.


setReferenceID

public abstract void setReferenceID(java.lang.Integer referenceID)
Reference ID of the related request. In event objects, this reference ID indicates to which request the event refers to.


setReferenceID

public abstract void setReferenceID(int referenceID)
Reference ID of the related request. In event objects, this reference ID indicates to which request the event refers to.


getThisDN

public abstract java.lang.String getThisDN()
The Directory Number (which your application registered) involved in this request or event.


setThisDN

public abstract void setThisDN(java.lang.String thisDN)
The Directory Number (which your application registered) involved in this request or event.


getAgentWorkMode

public abstract AgentWorkMode getAgentWorkMode()
The Agent workmode. See Genesyslab.Platform.Voice.Protocols.TServer.CallState.AgentWorkMode.


setAgentWorkMode

public abstract void setAgentWorkMode(AgentWorkMode agentWorkMode)
The Agent workmode. See Genesyslab.Platform.Voice.Protocols.TServer.CallState.AgentWorkMode.


getThisQueue

public abstract java.lang.String getThisQueue()
The queue related to ThisDN

Returns:
property value

setThisQueue

public abstract void setThisQueue(java.lang.String thisQueue)
The queue related to ThisDN

Parameters:
thisQueue - new value of the property

getAgentID

public abstract java.lang.String getAgentID()
The agent identifier specified by PBX or ACD.

Returns:
property value

setAgentID

public abstract void setAgentID(java.lang.String agentID)
The agent identifier specified by PBX or ACD.

Parameters:
agentID - new value of the property

getPassword

public abstract java.lang.String getPassword()
The password to get logged in.


setPassword

public abstract void setPassword(java.lang.String password)
The password to get logged in.


getReasons

public abstract KeyValueCollection getReasons()
Additional data intended to specify reasons for and results of actions taken by the user.

Returns:
property value

setReasons

public abstract void setReasons(KeyValueCollection reasons)
Additional data intended to specify reasons for and results of actions taken by the user.

Parameters:
reasons - new value of the property

getExtensions

public abstract KeyValueCollection getExtensions()
An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data.

Returns:
property value

setExtensions

public abstract void setExtensions(KeyValueCollection extensions)
An additional data structure intended to take account of switch-specific features that cannot be described by other parameters or in the original structure of user data.

Parameters:
extensions - new value of the property

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.