org.asteriskjava.manager.action

Class ParkAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.ParkAction

All Implemented Interfaces:

Serializable, ManagerAction

public class ParkAction
extends AbstractManagerAction

The ParkAction parks a channel using Asterisk's park feature.

Defined in res/res_features.c

Available since Asterisk 1.4.

Version:

$Id$

Author:

srt

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParkAction() Creates a new empty ParkAction.
ParkAction(String channel, String channel2) Creates a new ParkAction.
ParkAction(String channel, String channel2, Integer timeout) Creates a new ParkAction with a timeout.

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 park.
String	getChannel2() Returns the name of the channel to announce park info to and return to on timeout.
Integer	getTimeout() Returns the timeout in seconds before callback.
void	setChannel(String channel) Sets the name of the channel to park.
void	setChannel2(String channel2) Sets the name of the channel to announce park info to and return to on timeout.
void	setTimeout(Integer timeout) Sets the timeout in seconds before callback.

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

ParkAction

public ParkAction()

Creates a new empty ParkAction.

ParkAction

public ParkAction(String channel,
                  String channel2)

Creates a new ParkAction.

Parameters:

channel - name of the channel to park.

channel2 - name of the channel to announce park info to and return to on timeout.

ParkAction

public ParkAction(String channel,
                  String channel2,
                  Integer timeout)

Creates a new ParkAction with a timeout.

Parameters:

channel - the name of the channel to park.

channel2 - the name of the channel to announce park info to and return to on timeout.

timeout - the timeout in seconds before callback.

Method Detail

getAction

public String getAction()

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

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getChannel

public String getChannel()

Returns the name of the channel to park.

Returns:

the name of the channel to park.

setChannel

public void setChannel(String channel)

Sets the name of the channel to park.

This property is mandatory.

Parameters:

channel - the name of the channel to park.

getChannel2

public String getChannel2()

Returns the name of the channel to announce park info to and return to on timeout.

Returns:

the name of the channel to announce park info to and return to on timeout.

setChannel2

public void setChannel2(String channel2)

Sets the name of the channel to announce park info to and return to on timeout.

This property is mandatory.

Parameters:

channel2 - the name of the channel to announce park info to and return to on timeout.

getTimeout

public Integer getTimeout()

Returns the timeout in seconds before callback.

Returns:

the timeout in seconds before callback.

setTimeout

public void setTimeout(Integer timeout)

Sets the timeout in seconds before callback.

Parameters:

timeout - the timeout in seconds before callback.