|
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.party.RequestInitiateTransfer
public abstract class RequestInitiateTransfer
Initiates a two-step transfer. Holds the current call (ConnId
) and dials a consultation call with another agent. To complete the transfer, your application must send a RequestCompleteTransfer
request which has the same ConnId
.
If the initiate request is successful, your application receives the event EventHeld
for the ConnId
current call, and the EventDialing
and EventEstablished
events for the consultation call.
Note: This request does not allow callbacks.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestInitiateTransfer |
create()
Creates instance of RequestInitiateTransfer with no parameters set. |
static RequestInitiateTransfer |
create(java.lang.String thisDN,
ConnectionId connID,
java.lang.String otherDN)
Creates instance of RequestInitiateTransfer with required parameters set. |
static RequestInitiateTransfer |
create(java.lang.String thisDN,
ConnectionId connID,
java.lang.String otherDN,
java.lang.String location,
KeyValueCollection userData,
KeyValueCollection reasons,
KeyValueCollection extensions)
Creates instance of RequestInitiateTransfer with all parameters set. |
abstract ConnectionId |
getConnID()
Connection identifier of the current call handled by the DN. |
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 |
getLocation()
Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`. |
abstract java.lang.String |
getOtherDN()
The other main Directory Number (which your application did not register) involved in this request or event. |
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 KeyValueCollection |
getUserData()
Call-related user data. |
abstract void |
setConnID(ConnectionId connID)
Connection identifier of the current call handled by the DN. |
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 |
setLocation(java.lang.String location)
Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`. |
abstract void |
setOtherDN(java.lang.String otherDN)
The other main Directory Number (which your application did not register) involved in this request or event. |
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 |
setUserData(KeyValueCollection userData)
Call-related user data. |
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 RequestInitiateTransfer create()
public static RequestInitiateTransfer create(java.lang.String thisDN, ConnectionId connID, java.lang.String otherDN, java.lang.String location, KeyValueCollection userData, KeyValueCollection reasons, KeyValueCollection extensions)
thisDN
- DN of the controlling agent or Route Point.connID
- Connection identifier of the current call handled by the DN.otherDN
- The directory number of the second most significant telephony object (except an ACD group or trunk group) with respect to the event in question. The application does not have to be registered to this directory number to receive the event in question.location
- Name of the remote location in the form of `SwitchName` or `T-ServerApplicationName`@`SwitchName`.userData
- Call-related user data.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 RequestInitiateTransfer create(java.lang.String thisDN, ConnectionId connID, java.lang.String otherDN)
thisDN
- DN of the controlling agent or Route Point.connID
- Connection identifier of the current call handled by the DN.otherDN
- The directory number of the second most significant telephony object (except an ACD group or trunk group) with respect to the event in question. The application does not have to be registered to this directory number to receive the event 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 ConnectionId getConnID()
public abstract void setConnID(ConnectionId connID)
public abstract java.lang.String getOtherDN()
public abstract void setOtherDN(java.lang.String otherDN)
public abstract java.lang.String getLocation()
public abstract void setLocation(java.lang.String location)
location
- new value of the propertypublic abstract KeyValueCollection getUserData()
public abstract void setUserData(KeyValueCollection userData)
userData
- new value of the propertypublic 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 |