org.asteriskjava.fastagi.command

Class SayDigitsCommand

java.lang.Object

org.asteriskjava.fastagi.command.AbstractAgiCommand

org.asteriskjava.fastagi.command.SayDigitsCommand

All Implemented Interfaces:

Serializable, AgiCommand

public class SayDigitsCommand
extends AbstractAgiCommand

Say a given digit string, returning early if any of the given DTMF digits are received on the channel.

Returns 0 if playback completes without a digit being pressed, or the ASCII numerical value of the digit if one was pressed or -1 on error/hangup.

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SayDigitsCommand(String digits) Creates a new SayDigitsCommand.
SayDigitsCommand(String digits, String escapeDigits) Creates a new SayDigitsCommand.

Method Summary

Modifier and Type	Method and Description
String	buildCommand() Returns a string suitable to be sent to asterisk.
String	getDigits() Returns the digits string to say.
String	getEscapeDigits() Returns the digits that allow the user to interrupt this command.
void	setDigits(String digits) Sets the digits to say.
void	setEscapeDigits(String escapeDigits) Sets the digits that allow the user to interrupt this command.

Methods inherited from class org.asteriskjava.fastagi.command.AbstractAgiCommand

escapeAndQuote, escapeAndQuote, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SayDigitsCommand

public SayDigitsCommand(String digits)

Creates a new SayDigitsCommand.

Parameters:

digits - the digits to say.

SayDigitsCommand

public SayDigitsCommand(String digits,
                        String escapeDigits)

Creates a new SayDigitsCommand.

Parameters:

digits - the digits to say.

escapeDigits - the digits that allow the user to interrupt this command.

Method Detail

getDigits

public String getDigits()

Returns the digits string to say.

Returns:

the digits string to say.

setDigits

public void setDigits(String digits)

Sets the digits to say.

Parameters:

digits - the digits string to say.

getEscapeDigits

public String getEscapeDigits()

Returns the digits that allow the user to interrupt this command.

Returns:

the digits that allow the user to interrupt this command.

setEscapeDigits

public void setEscapeDigits(String escapeDigits)

Sets the digits that allow the user to interrupt this command.

Parameters:

escapeDigits - the digits that allow the user to interrupt this command or null for none.

buildCommand

public String buildCommand()

Description copied from interface: AgiCommand

Returns a string suitable to be sent to asterisk.

Specified by:

buildCommand in interface AgiCommand

Specified by:

buildCommand in class AbstractAgiCommand

Returns:

a string suitable to be sent to asterisk.