|
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.voicemail.RequestCloseVoiceFile
public abstract class RequestCloseVoiceFile
Closes the voice file specified by the parameter file_handle on behalf of the telephony object specified by the parameter dn, which earlier logged in to a mailbox using the function TLoginMailBox().
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestCloseVoiceFile |
create()
Creates instance of RequestCloseVoiceFile with no parameters set. |
static RequestCloseVoiceFile |
create(java.lang.String thisDN,
java.lang.Integer fileHandle)
Creates instance of RequestCloseVoiceFile with required parameters set. |
static RequestCloseVoiceFile |
create(java.lang.String thisDN,
java.lang.Integer fileHandle,
KeyValueCollection reasons,
KeyValueCollection extensions)
Creates instance of RequestCloseVoiceFile with all parameters set. |
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.Integer |
getFileHandle()
The handle of the voice file which is 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 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 |
setFileHandle(int fileHandle)
The handle of the voice file which is involved in this request or event. |
abstract void |
setFileHandle(java.lang.Integer fileHandle)
The handle of the voice file which is 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. |
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 RequestCloseVoiceFile create()
public static RequestCloseVoiceFile create(java.lang.String thisDN, java.lang.Integer fileHandle, KeyValueCollection reasons, KeyValueCollection extensions)
thisDN
- DN of the controlling agent or Route Point.fileHandle
- The handle of the voice file in question.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 RequestCloseVoiceFile create(java.lang.String thisDN, java.lang.Integer fileHandle)
thisDN
- DN of the controlling agent or Route Point.fileHandle
- The handle of the voice file 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 java.lang.Integer getFileHandle()
public abstract void setFileHandle(java.lang.Integer fileHandle)
public abstract void setFileHandle(int fileHandle)
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 |