Asterisk-Java

org.asteriskjava.manager.action
Class ShowDialplanAction

java.lang.Object
  extended by org.asteriskjava.manager.action.AbstractManagerAction
      extended by org.asteriskjava.manager.action.ShowDialplanAction
All Implemented Interfaces:
java.io.Serializable, EventGeneratingAction, ManagerAction

public class ShowDialplanAction
extends AbstractManagerAction
implements EventGeneratingAction

Retrieves a list of all priorities defined in the dialplan.

For each priority a ListDialplanEvent is sent by Asterisk containing the details. When all priorities have been reported a ShowDialplanCompleteEvent is sent.

Available since Asterisk 1.6

Since:
1.0.0
Version:
$Id: ShowDialplanAction.java 1121 2008-08-16 20:54:12Z srt $
Author:
srt
See Also:
ListDialplanEvent, ShowDialplanCompleteEvent, Serialized Form

Constructor Summary
ShowDialplanAction()
          Creates a new ShowDialplanAction.
 
Method Summary
 java.lang.String getAction()
          Returns the name of the action for example "Hangup".
 java.lang.Class<? extends ResponseEvent> getActionCompleteEventClass()
          Returns the event type that indicates that Asterisk is finished sending response events for this 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
 
Methods inherited from interface org.asteriskjava.manager.action.ManagerAction
getActionId, setActionId
 

Constructor Detail

ShowDialplanAction

public ShowDialplanAction()
Creates a new ShowDialplanAction.

Method Detail

getAction

public java.lang.String getAction()
Description copied from interface: ManagerAction
Returns the name of the action for example "Hangup".

Specified by:
getAction in interface ManagerAction
Specified by:
getAction in class AbstractManagerAction

getActionCompleteEventClass

public java.lang.Class<? extends ResponseEvent> getActionCompleteEventClass()
Description copied from interface: EventGeneratingAction
Returns the event type that indicates that Asterisk is finished sending response events for this action.

Specified by:
getActionCompleteEventClass in interface EventGeneratingAction
Returns:
a Class that is an instance of ResponseEvent.
See Also:
ResponseEvent

Asterisk-Java

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