|
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.RequestCollectDigits
public abstract class RequestCollectDigits
Collects digits from the caller.
Field Summary | |
---|---|
static int |
ID
|
static java.lang.String |
NAME
|
Method Summary | |
---|---|
static RequestCollectDigits |
create()
Creates instance of RequestCollectDigits with no parameters set. |
static RequestCollectDigits |
create(ConnectionId connID,
java.lang.String thisDN,
java.lang.Integer numberOfDigits,
java.lang.Integer voiceCFlag,
java.lang.Integer timeout)
Creates instance of RequestCollectDigits with required parameters set. |
static RequestCollectDigits |
create(ConnectionId connID,
java.lang.String thisDN,
java.lang.Integer numberOfDigits,
java.lang.Integer voiceCFlag,
java.lang.Integer timeout,
java.lang.String terminateDigits,
KeyValueCollection reasons,
KeyValueCollection extensions)
Creates instance of RequestCollectDigits 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 |
getNumberOfDigits()
Number of digits to be collected. |
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 |
getTerminateDigits()
The symbol(s) that marks the end of input. |
abstract java.lang.String |
getThisDN()
The Directory Number (which your application registered) involved in this request or event. |
abstract java.lang.Integer |
getTimeout()
Time interval, in seconds. |
abstract java.lang.Integer |
getVoiceCFlag()
Clear flag indicating whether previously gathered information should be cleared before playback starts. |
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 |
setNumberOfDigits(int numberOfDigits)
Number of digits to be collected. |
abstract void |
setNumberOfDigits(java.lang.Integer numberOfDigits)
Number of digits to be collected. |
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 |
setTerminateDigits(java.lang.String terminateDigits)
The symbol(s) that marks the end of input. |
abstract void |
setThisDN(java.lang.String thisDN)
The Directory Number (which your application registered) involved in this request or event. |
abstract void |
setTimeout(int timeout)
Time interval, in seconds. |
abstract void |
setTimeout(java.lang.Integer timeout)
Time interval, in seconds. |
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. |
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 RequestCollectDigits create()
public static RequestCollectDigits create(ConnectionId connID, java.lang.String thisDN, java.lang.Integer numberOfDigits, java.lang.Integer voiceCFlag, java.lang.Integer timeout, java.lang.String terminateDigits, KeyValueCollection reasons, KeyValueCollection extensions)
connID
- Connection identifier of the current call handled by the DN.thisDN
- DN of the controlling agent or Route Point.numberOfDigits
- Number of digits to be collected.voiceCFlag
- Clear flag indicating whether previously gathered information should be cleared before playback starts.timeout
- Time interval, in seconds.terminateDigits
- The symbol(s) that marks the end of input.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 RequestCollectDigits create(ConnectionId connID, java.lang.String thisDN, java.lang.Integer numberOfDigits, java.lang.Integer voiceCFlag, java.lang.Integer timeout)
connID
- Connection identifier of the current call handled by the DN.thisDN
- DN of the controlling agent or Route Point.numberOfDigits
- Number of digits to be collected.voiceCFlag
- Clear flag indicating whether previously gathered information should be cleared before playback starts.timeout
- Time interval, in seconds.
public abstract ConnectionId getConnID()
public abstract void setConnID(ConnectionId connID)
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 getNumberOfDigits()
public abstract void setNumberOfDigits(java.lang.Integer numberOfDigits)
numberOfDigits
- new value of the propertypublic abstract void setNumberOfDigits(int numberOfDigits)
numberOfDigits
- 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.Integer getTimeout()
public abstract void setTimeout(java.lang.Integer timeout)
timeout
- new value of the propertypublic abstract void setTimeout(int timeout)
timeout
- new value of the propertypublic abstract java.lang.String getTerminateDigits()
public abstract void setTerminateDigits(java.lang.String terminateDigits)
terminateDigits
- 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 |