Platform SDK Java 8.5 API Reference

com.genesyslab.platform.voice.protocol.tserver.requests.voicemail
Class RequestCollectDigits

java.lang.Object
  extended by com.genesyslab.platform.commons.protocol.DataObject
      extended by com.genesyslab.platform.commons.protocol.Message
          extended by com.genesyslab.platform.voice.protocol.tserver.requests.voicemail.RequestCollectDigits
All Implemented Interfaces:
ProtocolDescriptionSupport

public abstract class RequestCollectDigits
extends Message

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

ID

public static final int ID
See Also:
Constant Field Values

NAME

public static final java.lang.String NAME
See Also:
Constant Field Values
Method Detail

create

public static RequestCollectDigits create()
Creates instance of RequestCollectDigits with no parameters set.

Returns:
instance of 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)
Creates instance of RequestCollectDigits with all parameters set.

Parameters:
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.
Returns:
instance of RequestCollectDigits

create

public 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.

Parameters:
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.
Returns:
instance of RequestCollectDigits

getConnID

public abstract ConnectionId getConnID()
Connection identifier of the current call handled by the DN.


setConnID

public abstract void setConnID(ConnectionId connID)
Connection identifier of the current call handled by the DN.


getReferenceID

public abstract java.lang.Integer getReferenceID()
Reference ID of the related request. In event objects, this reference ID indicates to which request the event refers to.


setReferenceID

public abstract void setReferenceID(java.lang.Integer referenceID)
Reference ID of the related request. In event objects, this reference ID indicates to which request the event refers to.


setReferenceID

public abstract void setReferenceID(int referenceID)
Reference ID of the related request. In event objects, this reference ID indicates to which request the event refers to.


getThisDN

public abstract java.lang.String getThisDN()
The Directory Number (which your application registered) involved in this request or event.


setThisDN

public abstract void setThisDN(java.lang.String thisDN)
The Directory Number (which your application registered) involved in this request or event.


getNumberOfDigits

public abstract java.lang.Integer getNumberOfDigits()
Number of digits to be collected.

Returns:
property value

setNumberOfDigits

public abstract void setNumberOfDigits(java.lang.Integer numberOfDigits)
Number of digits to be collected.

Parameters:
numberOfDigits - new value of the property

setNumberOfDigits

public abstract void setNumberOfDigits(int numberOfDigits)
Number of digits to be collected.

Parameters:
numberOfDigits - new value of the property

getVoiceCFlag

public abstract java.lang.Integer getVoiceCFlag()
Clear flag indicating whether previously gathered information should be cleared before playback starts.

Returns:
property value

setVoiceCFlag

public abstract void setVoiceCFlag(java.lang.Integer voiceCFlag)
Clear flag indicating whether previously gathered information should be cleared before playback starts.

Parameters:
voiceCFlag - new value of the property

setVoiceCFlag

public abstract void setVoiceCFlag(int voiceCFlag)
Clear flag indicating whether previously gathered information should be cleared before playback starts.

Parameters:
voiceCFlag - new value of the property

getTimeout

public abstract java.lang.Integer getTimeout()
Time interval, in seconds.

Returns:
property value

setTimeout

public abstract void setTimeout(java.lang.Integer timeout)
Time interval, in seconds.

Parameters:
timeout - new value of the property

setTimeout

public abstract void setTimeout(int timeout)
Time interval, in seconds.

Parameters:
timeout - new value of the property

getTerminateDigits

public abstract java.lang.String getTerminateDigits()
The symbol(s) that marks the end of input.

Returns:
property value

setTerminateDigits

public abstract void setTerminateDigits(java.lang.String terminateDigits)
The symbol(s) that marks the end of input.

Parameters:
terminateDigits - new value of the property

getReasons

public abstract KeyValueCollection getReasons()
Additional data intended to specify reasons for and results of actions taken by the user.

Returns:
property value

setReasons

public abstract void setReasons(KeyValueCollection reasons)
Additional data intended to specify reasons for and results of actions taken by the user.

Parameters:
reasons - new value of the property

getExtensions

public 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.

Returns:
property value

setExtensions

public 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.

Parameters:
extensions - new value of the property

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.