ProtocolDescriptionSupport
@Generated(value="com.genesyslab.platform.commons.protocol.generator.Generator", date="2021-06-14T15:45:51.459-07:00") public abstract class RequestRetrieveCall extends Message
ConnId
call placed on hold. If the request is successful, your application receives the EventRetrieved
event for this ConnId
.Modifier and Type | Method | Description |
---|---|---|
static RequestRetrieveCall |
create() |
Creates instance of RequestRetrieveCall with no parameters set.
|
static RequestRetrieveCall |
create(java.lang.String thisDN,
ConnectionId connID) |
Creates instance of RequestRetrieveCall with required parameters set.
|
static RequestRetrieveCall |
create(java.lang.String thisDN,
ConnectionId connID,
KeyValueCollection reasons,
KeyValueCollection extensions) |
Creates instance of RequestRetrieveCall 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 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 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 |
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.
|
equals, hashCode, toString, toString
cloneMessage, getEndpoint, getMessageAttribute, getProtocolDescription, getProtocolId, messageId, messageName, setProtocolDescription
public static final int ID
public static final java.lang.String NAME
public static RequestRetrieveCall create()
public static RequestRetrieveCall create(java.lang.String thisDN, ConnectionId connID, KeyValueCollection reasons, KeyValueCollection extensions)
thisDN
- DN of the controlling agent or Route Point.connID
- Connection identifier of the current call handled by the DN.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 RequestRetrieveCall create(java.lang.String thisDN, ConnectionId connID)
thisDN
- DN of the controlling agent or Route Point.connID
- Connection identifier of the current call handled by the DN.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 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 propertySend comments on this topicTechpubs.webadmin@genesys.com.
Document version: 9.0.006.00
Copyright © 2006–2019 Genesys Telecommunications Laboratories, Inc. All rights reserved.