|
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.voice.protocol.tserver.requests.agent.RequestAgentLogin
public abstract class RequestAgentLogin
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 |
---|
public static final int ID
public static final java.lang.String NAME
Method Detail |
---|
public static 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)
thisDN
- DN of the controlling agent or Route Point.agentWorkMode
- The current work mode of the agent in question.thisQueue
- The queue related to ThisDNagentID
- 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.
public static RequestAgentLogin create(java.lang.String thisDN, AgentWorkMode agentWorkMode)
thisDN
- DN of the controlling agent or Route Point.agentWorkMode
- The current work mode of the agent in question.
public abstract java.lang.Integer getReferenceID()
public abstract void setReferenceID(java.lang.Integer referenceID)
public abstract void setReferenceID(int referenceID)
public abstract java.lang.String getThisDN()
public abstract void setThisDN(java.lang.String thisDN)
public abstract AgentWorkMode getAgentWorkMode()
Genesyslab.Platform.Voice.Protocols.TServer.CallState.AgentWorkMode
.
public abstract void setAgentWorkMode(AgentWorkMode agentWorkMode)
Genesyslab.Platform.Voice.Protocols.TServer.CallState.AgentWorkMode
.
public abstract java.lang.String getThisQueue()
public abstract void setThisQueue(java.lang.String thisQueue)
thisQueue
- new value of the propertypublic abstract java.lang.String getAgentID()
public abstract void setAgentID(java.lang.String agentID)
agentID
- new value of the propertypublic abstract java.lang.String getPassword()
public abstract void setPassword(java.lang.String password)
public abstract KeyValueCollection getReasons()
public abstract void setReasons(KeyValueCollection reasons)
reasons
- new value of the propertypublic abstract KeyValueCollection getExtensions()
public abstract void setExtensions(KeyValueCollection extensions)
extensions
- new value of the property
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |