|
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.RequestPlayVoiceFile
public abstract class RequestPlayVoiceFile
Plays the voice message contained in the file specified by the parameter file_handle for the telephony object specified by the parameter dn.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestPlayVoiceFile |
create()
Creates instance of RequestPlayVoiceFile with no parameters set. |
static RequestPlayVoiceFile |
create(java.lang.String thisDN,
ConnectionId connID,
java.lang.Integer fileHandle,
java.lang.Integer voiceIFlag,
java.lang.Integer voiceCFlag)
Creates instance of RequestPlayVoiceFile with required parameters set. |
static RequestPlayVoiceFile |
create(java.lang.String thisDN,
ConnectionId connID,
java.lang.Integer fileHandle,
java.lang.Integer voiceIFlag,
java.lang.Integer voiceCFlag,
java.lang.String voiceSegment,
KeyValueCollection reasons,
KeyValueCollection extensions)
Creates instance of RequestPlayVoiceFile 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.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 java.lang.Integer |
getVoiceCFlag()
Clear flag indicating whether previously gathered information should be cleared before playback starts. |
abstract java.lang.Integer |
getVoiceIFlag()
Interrupt flag indicating whether playback should be interrupted whenever a touchtone button is pressed. |
abstract java.lang.String |
getVoiceSegment()
The prerecorded speech segment to play. |
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 |
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. |
abstract void |
setVoiceCFlag(int voiceCFlag)
Clear flag indicating whether previously gathered information should be cleared before playback starts. |
abstract void |
setVoiceCFlag(java.lang.Integer voiceCFlag)
Clear flag indicating whether previously gathered information should be cleared before playback starts. |
abstract void |
setVoiceIFlag(int voiceIFlag)
Interrupt flag indicating whether playback should be interrupted whenever a touchtone button is pressed. |
abstract void |
setVoiceIFlag(java.lang.Integer voiceIFlag)
Interrupt flag indicating whether playback should be interrupted whenever a touchtone button is pressed. |
abstract void |
setVoiceSegment(java.lang.String voiceSegment)
The prerecorded speech segment to play. |
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 RequestPlayVoiceFile create()
public static RequestPlayVoiceFile create(java.lang.String thisDN, ConnectionId connID, java.lang.Integer fileHandle, java.lang.Integer voiceIFlag, java.lang.Integer voiceCFlag, java.lang.String voiceSegment, KeyValueCollection reasons, KeyValueCollection extensions)
thisDN
- DN of the controlling agent or Route Point.connID
- Connection identifier of the current call handled by the DN.fileHandle
- The handle of the voice file in question.voiceIFlag
- Interrupt flag indicating whether playback should be interrupted whenever a touchtone button is pressed.voiceCFlag
- Clear flag indicating whether previously gathered information should be cleared before playback starts.voiceSegment
- The prerecorded speech segment that is to be played.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 RequestPlayVoiceFile create(java.lang.String thisDN, ConnectionId connID, java.lang.Integer fileHandle, java.lang.Integer voiceIFlag, java.lang.Integer voiceCFlag)
thisDN
- DN of the controlling agent or Route Point.connID
- Connection identifier of the current call handled by the DN.fileHandle
- The handle of the voice file in question.voiceIFlag
- Interrupt flag indicating whether playback should be interrupted whenever a touchtone button is pressed.voiceCFlag
- Clear flag indicating whether previously gathered information should be cleared before playback starts.
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.Integer getFileHandle()
public abstract void setFileHandle(java.lang.Integer fileHandle)
public abstract void setFileHandle(int fileHandle)
public abstract java.lang.Integer getVoiceIFlag()
public abstract void setVoiceIFlag(java.lang.Integer voiceIFlag)
voiceIFlag
- new value of the propertypublic abstract void setVoiceIFlag(int voiceIFlag)
voiceIFlag
- new value of the propertypublic abstract java.lang.Integer getVoiceCFlag()
public abstract void setVoiceCFlag(java.lang.Integer voiceCFlag)
voiceCFlag
- new value of the propertypublic abstract void setVoiceCFlag(int voiceCFlag)
voiceCFlag
- new value of the propertypublic abstract java.lang.String getVoiceSegment()
public abstract void setVoiceSegment(java.lang.String voiceSegment)
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 |