org.asteriskjava.fastagi.command

Class SayNumberCommand

java.lang.Object

org.asteriskjava.fastagi.command.AbstractAgiCommand

org.asteriskjava.fastagi.command.SayNumberCommand

All Implemented Interfaces:

Serializable, AgiCommand

public class SayNumberCommand
extends AbstractAgiCommand

Say a given number, returning early if any of the given DTMF number 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
SayNumberCommand(String number) Creates a new SayNumberCommand.
SayNumberCommand(String number, String escapeDigits) Creates a new SayNumberCommand.

Method Summary

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

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

escapeAndQuote, escapeAndQuote, setAsteriskVersion, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SayNumberCommand

public SayNumberCommand(String number)

Creates a new SayNumberCommand.

Parameters:

number - the number to say.

SayNumberCommand

public SayNumberCommand(String number,
                        String escapeDigits)

Creates a new SayNumberCommand.

Parameters:

number - the number to say.

escapeDigits - contains the number that allow the user to interrupt this command.

Method Detail

getNumber

public String getNumber()

Returns the number to say.

Returns:

the number to say.

setNumber

public void setNumber(String number)

Sets the number to say.

Parameters:

number - the number to say.

getEscapeDigits

public String getEscapeDigits()

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

Returns:

the number that allow the user to interrupt this command.

setEscapeDigits

public void setEscapeDigits(String escapeDigits)

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

Parameters:

escapeDigits - the number 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.