PlayCollectContext (MGCP2 5.2.0.37 API)

java.lang.Object
- org.mobicents.media.control.mgcp.pkg.au.pc.PlayCollectContext

public class PlayCollectContext
extends Object

Author:: Henrique Rosa (henrique.rosa@telestax.com)

Constructor Summary

Constructors
Constructor and Description
`PlayCollectContext(DtmfDetector detector, DtmfDetectorListener detectorListener, Map<String,String> parameters)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clearCollectedDigits()`
`void`	`collectDigit(char digit)`
`int`	`countCollectedDigits()`
`int`	`getAttempt()`
`boolean`	`getClearDigitBuffer()` If set to true, clears the digit buffer before playing the initial prompt.
`String`	`getCollectedDigits()`
`String`	`getDigitPattern()` A legal digit map as described in section 7.1.14 of the MEGACO protocol using the DTMF mappings associated with the Megaco DTMF Detection Package described in the Megaco protocol document.
`char`	`getEndInputKey()` Specifies a key that signals the end of digit collection or voice recording.
`int`	`getExtraDigitTimer()` The amount of time to wait for a user to enter a final digit once the maximum expected amount of digits have been entered.
`Playlist`	`getFailureAnnouncement()`
`int`	`getFirstDigitTimer()` The amount of time allowed for the user to enter the first digit.
`boolean`	`getIncludeEndInputKey()` By default the End Input Key is not included in the collected digits returned to the call agent.
`Playlist`	`getInitialPrompt()`
`int`	`getInterDigitTimer()` The amount of time allowed for the user to enter each subsequent digit.
`long`	`getLastCollectedDigitOn()`
`char`	`getLastTone()`
`int`	`getMaximumDigits()` The maximum number of digits to collect.
`int`	`getMinimumDigits()` The minimum number of digits to collect.
`Playlist`	`getNoDigitsReprompt()`
`boolean`	`getNonInterruptibleAudio()` If set to true, initial prompt is not interruptible by either voice or digits.
`int`	`getNumberOfAttempts()` The number of attempts the user needed to enter a valid digit pattern or to make a recording.
`char`	`getPositionKey()` Defines a key with the following action.
`char`	`getReinputKey()` Defines a key sequence consisting of a command key optionally followed by zero or more keys.
`Playlist`	`getReprompt()`
`char`	`getRestartKey()` Defines a key sequence consisting of a command key optionally followed by zero or more keys.
`int`	`getReturnCode()`
`char`	`getReturnKey()` Defines a key sequence consisting of a command key optionally followed by zero or more keys.
`String`	`getStartInputKeys()` Defines a set of keys that are acceptable as the first digit collected.
`char`	`getStopKey()` Defines a key with the following action.
`Playlist`	`getSuccessAnnouncement()`
`boolean`	`hasDigitPattern()`
`boolean`	`hasFailureAnnouncement()`
`boolean`	`hasMoreAttempts()`
`boolean`	`hasSuccessAnnouncement()`
`protected void`	`newAttempt()` Resets the collected digits and increments the attempts counter.
`void`	`setLastTone(char lastTone)`
`protected void`	`setReturnCode(int returnCode)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PlayCollectContext
```
public PlayCollectContext(DtmfDetector detector,
                  DtmfDetectorListener detectorListener,
                  Map<String,String> parameters)
```
- Method Detail
  - getInitialPrompt
```
public Playlist getInitialPrompt()
```
  - getReprompt
```
public Playlist getReprompt()
```
  - getNoDigitsReprompt
```
public Playlist getNoDigitsReprompt()
```
  - getFailureAnnouncement
```
public Playlist getFailureAnnouncement()
```
  - hasFailureAnnouncement
```
public boolean hasFailureAnnouncement()
```
  - getSuccessAnnouncement
```
public Playlist getSuccessAnnouncement()
```
  - hasSuccessAnnouncement
```
public boolean hasSuccessAnnouncement()
```
  - getNonInterruptibleAudio
```
public boolean getNonInterruptibleAudio()
```
    If set to true, initial prompt is not interruptible by either voice or digits.
    Defaults to false. Valid values are the text strings "true" and "false".
    
    Returns:
  - getClearDigitBuffer
```
public boolean getClearDigitBuffer()
```
    If set to true, clears the digit buffer before playing the initial prompt.
    Defaults to false. Valid values are the text strings "true" and "false".
    
    Returns:
  - getMinimumDigits
```
public int getMinimumDigits()
```
    The minimum number of digits to collect.
    Defaults to one. This parameter should not be specified if the Digit Pattern parameter is present.
    
    Returns:
  - getMaximumDigits
```
public int getMaximumDigits()
```
    The maximum number of digits to collect.
    Defaults to one. This parameter should not be specified if the Digit Pattern parameter is present.
    
    Returns:
  - getDigitPattern
```
public String getDigitPattern()
```
    A legal digit map as described in section 7.1.14 of the MEGACO protocol using the DTMF mappings associated with the Megaco DTMF Detection Package described in the Megaco protocol document.
    This parameter should not be specified if one or both of the Minimum # Of Digits parameter and the Maximum Number Of Digits parameter is present.
    
    Returns:
    The digit pattern or an empty String if not specified.
  - hasDigitPattern
```
public boolean hasDigitPattern()
```
  - getFirstDigitTimer
```
public int getFirstDigitTimer()
```
    The amount of time allowed for the user to enter the first digit.
    Specified in units of 100 milliseconds. Defaults to 50 (5 seconds).
    
    Returns:
  - getInterDigitTimer
```
public int getInterDigitTimer()
```
    The amount of time allowed for the user to enter each subsequent digit.
    Specified units of 100 milliseconds seconds. Defaults to 30 (3 seconds).
    
    Returns:
  - getExtraDigitTimer
```
public int getExtraDigitTimer()
```
    The amount of time to wait for a user to enter a final digit once the maximum expected amount of digits have been entered.
    Typically this timer is used to wait for a terminating key in applications where a specific key has been defined to terminate input.
    
    Specified in units of 100 milliseconds. If not specified, this timer is not activated.
    
    Returns:
  - getRestartKey
```
public char getRestartKey()
```
    Defines a key sequence consisting of a command key optionally followed by zero or more keys. This key sequence has the following action: discard any digits collected or recording in progress, replay the prompt, and resume digit collection or recording.
    No default. An application that defines more than one command key sequence, will typically use the same command key for all command key sequences.
    If more than one command key sequence is defined, then all key sequences must consist of a command key plus at least one other key.
    
    Returns:
  - getReinputKey
```
public char getReinputKey()
```
    Defines a key sequence consisting of a command key optionally followed by zero or more keys. This key sequence has the following action: discard any digits collected or recordings in progress and resume digit collection or recording.
    No default.
    An application that defines more than one command key sequence, will typically use the same command key for all command key sequences.
    
    If more than one command key sequence is defined, then all key sequences must consist of a command key plus at least one other key.
    
    Returns:
  - getReturnKey
```
public char getReturnKey()
```
    Defines a key sequence consisting of a command key optionally followed by zero or more keys. This key sequence has the following action: terminate the current event and any queued event and return the terminating key sequence to the call processing agent.
    No default. An application that defines more than one command key sequence, will typically use the same command key for all command key sequences.
    If more than one command key sequence is defined, then all key sequences must consist of a command key plus at least one other key.
    
    Returns:
  - getPositionKey
```
public char getPositionKey()
```
    Defines a key with the following action. Stop playing the current announcement and resume playing at the beginning of the first, last, previous, next, or the current segment of the announcement.
    No default. The actions for the position key are fst, lst, prv, nxt, and cur.
    
    Returns:
  - getStopKey
```
public char getStopKey()
```
    Defines a key with the following action. Terminate playback of the announcement.
    No default.
    
    Returns:
  - getStartInputKeys
```
public String getStartInputKeys()
```
    Defines a set of keys that are acceptable as the first digit collected. This set of keys can be specified to interrupt a playing announcement or to not interrupt a playing announcement.
    The default key set is 0-9. The default behavior is to interrupt a playing announcement when a Start Input Key is pressed.
    
    This behavior can be overidden for the initial prompt only by using the ni (Non-Interruptible Play) parameter. Specification is a list of keys with no separators, e.g. 123456789#.
    
    Returns:
  - getEndInputKey
```
public char getEndInputKey()
```
    Specifies a key that signals the end of digit collection or voice recording.
    The default end input key is the # key. To specify that no End Input Key be used the parameter is set to the string "null".
    The default behavior not to return the End Input Key in the digits returned to the call agent. This behavior can be overridden by the Include End Input Key (eik) parameter.
    
    Returns:
  - getIncludeEndInputKey
```
public boolean getIncludeEndInputKey()
```
    By default the End Input Key is not included in the collected digits returned to the call agent. If this parameter is set to "true" then the End Input Key will be returned with the collected digits returned to the call agent.
    Default is "false".
    
    Returns:
  - getNumberOfAttempts
```
public int getNumberOfAttempts()
```
    The number of attempts the user needed to enter a valid digit pattern or to make a recording.
    Defaults to 1. Also used as a return parameter to indicate the number of attempts the user made.
    
    Returns:
  - collectDigit
```
public void collectDigit(char digit)
```
  - clearCollectedDigits
```
public void clearCollectedDigits()
```
  - getCollectedDigits
```
public String getCollectedDigits()
```
  - countCollectedDigits
```
public int countCollectedDigits()
```
  - getLastCollectedDigitOn
```
public long getLastCollectedDigitOn()
```
  - getLastTone
```
public char getLastTone()
```
  - setLastTone
```
public void setLastTone(char lastTone)
```
  - getAttempt
```
public int getAttempt()
```
  - hasMoreAttempts
```
public boolean hasMoreAttempts()
```
  - getReturnCode
```
public int getReturnCode()
```
  - setReturnCode
```
protected void setReturnCode(int returnCode)
```
  - newAttempt
```
protected void newAttempt()
```
    Resets the collected digits and increments the attempts counter.

Class PlayCollectContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PlayCollectContext

Method Detail

getInitialPrompt

getReprompt

getNoDigitsReprompt

getFailureAnnouncement

hasFailureAnnouncement

getSuccessAnnouncement

hasSuccessAnnouncement

getNonInterruptibleAudio

getClearDigitBuffer

getMinimumDigits

getMaximumDigits

getDigitPattern

hasDigitPattern

getFirstDigitTimer

getInterDigitTimer

getExtraDigitTimer

getRestartKey

getReinputKey

getReturnKey

getPositionKey

getStopKey

getStartInputKeys

getEndInputKey

getIncludeEndInputKey

getNumberOfAttempts

collectDigit

clearCollectedDigits

getCollectedDigits

countCollectedDigits

getLastCollectedDigitOn

getLastTone

setLastTone

getAttempt

hasMoreAttempts

getReturnCode

setReturnCode

newAttempt