org.asteriskjava.fastagi.command

Class SayPhoneticCommand

java.lang.Object

org.asteriskjava.fastagi.command.AbstractAgiCommand

org.asteriskjava.fastagi.command.SayPhoneticCommand

All Implemented Interfaces:

Serializable, AgiCommand

public class SayPhoneticCommand
extends AbstractAgiCommand

AGI Command: SAY PHONETIC

Say a given character string with phonetics, 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.

See: AGI Command SAY PHONETIC (Asterisk 18)

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SayPhoneticCommand(String text) Creates a new SayPhoneticCommand.
SayPhoneticCommand(String text, String escapeDigits) Creates a new SayPhoneticCommand.

Method Summary

Modifier and Type	Method and Description
String	buildCommand() Returns a string suitable to be sent to asterisk.
String	getEscapeDigits() Returns the digits that allow the user to interrupt this command.
String	getText() Returns the text to say.
void	setEscapeDigits(String escapeDigits) Sets the digits that allow the user to interrupt this command.
void	setText(String text) Sets the text 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

SayPhoneticCommand

public SayPhoneticCommand(String text)

Creates a new SayPhoneticCommand.

Parameters:

text - the text to say.

SayPhoneticCommand

public SayPhoneticCommand(String text,
                          String escapeDigits)

Creates a new SayPhoneticCommand.

Parameters:

text - the text to say.

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

Method Detail

getText

public String getText()

Returns the text to say.

Returns:

the text to say.

setText

public void setText(String text)

Sets the text to say.

Parameters:

text - the text 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 text 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.