org.asteriskjava.manager.action

Class PlayDtmfAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.PlayDtmfAction

All Implemented Interfaces:

Serializable, ManagerAction

public class PlayDtmfAction
extends AbstractManagerAction

The PlayDTMFAction plays a DTMF digit on the specified channel.

It is definied in apps/app_senddtmf.c.

Available since Asterisk 1.2.8

Since:

0.3

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PlayDtmfAction() Creates a new empty PlayDtmfAction.
PlayDtmfAction(String channel, String digit) Creates a new PlayDtmfAction that sends the given DTMF digit to the given channel.

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of this action, i.e.
String	getChannel() Returns the name of the channel to send the digit to.
String	getDigit() Returns the DTMF digit to play.
Integer	getDuration()
Boolean	getReceive() Returns the 'receive' property of this action.
void	setChannel(String channel) Sets the name of the channel to send the digit to.
void	setDigit(String digit) Sets the DTMF digit to play.
void	setDuration(Integer duration)
void	setReceive(Boolean receive) Set the receive property of the action.

Methods inherited from class org.asteriskjava.manager.action.AbstractManagerAction

getActionId, setActionId, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayDtmfAction

public PlayDtmfAction()

Creates a new empty PlayDtmfAction.

PlayDtmfAction

public PlayDtmfAction(String channel,
                      String digit)

Creates a new PlayDtmfAction that sends the given DTMF digit to the given channel.

Parameters:

channel - the name of the channel to send the digit to.

digit - the DTML digit to play.

Method Detail

getAction

public String getAction()

Returns the name of this action, i.e. "PlayDTMF".

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getReceive

public Boolean getReceive()

Returns the 'receive' property of this action. (since asterisk 16.7.0)

Returns:

the receive property, or null if not set

setReceive

public void setReceive(Boolean receive)

Set the receive property of the action. (since asterisk 16.7.0)

Parameters:

receive - value for receive, or null to unset

getChannel

public String getChannel()

Returns the name of the channel to send the digit to.

Returns:

the name of the channel to send the digit to.

setChannel

public void setChannel(String channel)

Sets the name of the channel to send the digit to.

Parameters:

channel - the name of the channel to send the digit to.

getDigit

public String getDigit()

Returns the DTMF digit to play.

Returns:

the DTMF digit to play.

setDigit

public void setDigit(String digit)

Sets the DTMF digit to play.

Parameters:

digit - the DTMF digit to play.

setDuration

public void setDuration(Integer duration)

getDuration

public Integer getDuration()