Asterisk-Java

org.asteriskjava.manager.action
Class ParkAction

java.lang.Object
  extended by org.asteriskjava.manager.action.AbstractManagerAction
      extended by org.asteriskjava.manager.action.ParkAction
All Implemented Interfaces:
java.io.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: ParkAction.java 938 2007-12-31 03:23:38Z srt $
Author:
srt
See Also:
Serialized Form

Constructor Summary
ParkAction()
          Creates a new empty ParkAction.
ParkAction(java.lang.String channel, java.lang.String channel2)
          Creates a new ParkAction.
ParkAction(java.lang.String channel, java.lang.String channel2, java.lang.Integer timeout)
          Creates a new ParkAction with a timeout.
 
Method Summary
 java.lang.String getAction()
          Returns the name of this action, i.e.
 java.lang.String getChannel()
          Returns the name of the channel to park.
 java.lang.String getChannel2()
          Returns the name of the channel to announce park info to and return to on timeout.
 java.lang.Integer getTimeout()
          Returns the timeout in seconds before callback.
 void setChannel(java.lang.String channel)
          Sets the name of the channel to park.
 void setChannel2(java.lang.String channel2)
          Sets the name of the channel to announce park info to and return to on timeout.
 void setTimeout(java.lang.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(java.lang.String channel,
                  java.lang.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(java.lang.String channel,
                  java.lang.String channel2,
                  java.lang.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 java.lang.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 java.lang.String getChannel()
Returns the name of the channel to park.

Returns:
the name of the channel to park.

setChannel

public void setChannel(java.lang.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 java.lang.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(java.lang.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 java.lang.Integer getTimeout()
Returns the timeout in seconds before callback.

Returns:
the timeout in seconds before callback.

setTimeout

public void setTimeout(java.lang.Integer timeout)
Sets the timeout in seconds before callback.

Parameters:
timeout - the timeout in seconds before callback.

Asterisk-Java

Copyright © 2004-2009 Stefan Reuter. All Rights Reserved.