org.asteriskjava.fastagi.command

Class SayTimeCommand

java.lang.Object

org.asteriskjava.fastagi.command.AbstractAgiCommand

org.asteriskjava.fastagi.command.SayTimeCommand

All Implemented Interfaces:

Serializable, AgiCommand

public class SayTimeCommand
extends AbstractAgiCommand

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

Time is the number of seconds elapsed since 00:00:00 on January 1, 1970, Coordinated Universal Time (UTC).

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
SayTimeCommand(long time) Creates a new SayTimeCommand.
SayTimeCommand(long time, String escapeDigits) Creates a new SayTimeCommand.

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.
long	getTime() Returns the time to say in seconds since 00:00:00 on January 1, 1970.
void	setEscapeDigits(String escapeDigits) Sets the digits that allow the user to interrupt this command.
void	setTime(long time) Sets the time to say in seconds since 00:00:00 on January 1, 1970.

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

SayTimeCommand

public SayTimeCommand(long time)

Creates a new SayTimeCommand.

Parameters:

time - the time to say in seconds since 00:00:00 on January 1, 1970.

SayTimeCommand

public SayTimeCommand(long time,
                      String escapeDigits)

Creates a new SayTimeCommand.

Parameters:

time - the time to say in seconds since 00:00:00 on January 1, 1970.

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

Method Detail

getTime

public long getTime()

Returns the time to say in seconds since 00:00:00 on January 1, 1970.

Returns:

the time to say in seconds since 00:00:00 on January 1, 1970.

setTime

public void setTime(long time)

Sets the time to say in seconds since 00:00:00 on January 1, 1970.

Parameters:

time - the time to say in seconds since 00:00:00 on January 1, 1970.

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