org.asteriskjava.manager.action

Class AgiAction

java.lang.Object

org.asteriskjava.manager.action.AbstractManagerAction

org.asteriskjava.manager.action.AgiAction

All Implemented Interfaces:

Serializable, EventGeneratingAction, ManagerAction

public class AgiAction
extends AbstractManagerAction
implements EventGeneratingAction

Add a new AGI command to execute by the Async AGI application.

It will append the application to the specified channel's queue. If the channel is not inside Async AGI application it will return an error.

It is implemented in res/res_agi.c
Available since Asterisk 1.6

Since:

1.0.0

Version:

$Id$

Author:

srt

See Also:

AsyncAgiEvent, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AgiAction() Creates a new empty AgiAction.
AgiAction(String channel, String command) Creates a new AgiAction with channel and command.
AgiAction(String channel, String command, String commandId) Creates a new AgiAction with channel, command and commandId.

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of this action.
Class<? extends ResponseEvent>	getActionCompleteEventClass() Returns the event type that indicates that Asterisk is finished sending response events for this action.
String	getChannel() Returns the name of the channel to execute the AGI command on.
String	getCommand() Returns the AGI command to execute.
String	getCommandId() Returns the command id to track execution progress.
void	setChannel(String channel) Sets the name of the channel to execute the AGI command on.
void	setCommand(String command) Sets the AGI command to execute.
void	setCommandId(String commandId) Sets the command id to track execution progress.

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

AgiAction

public AgiAction()

Creates a new empty AgiAction.

AgiAction

public AgiAction(String channel,
                 String command)

Creates a new AgiAction with channel and command.

Parameters:

channel - the name of the channel to execute the AGI command on.

command - the AGI command to execute.

AgiAction

public AgiAction(String channel,
                 String command,
                 String commandId)

Creates a new AgiAction with channel, command and commandId.

Parameters:

channel - the name of the channel to execute the AGI command on.

command - the AGI command to execute.

commandId - the command id to track execution progress.

Method Detail

getAction

public String getAction()

Returns the name of this action.

Specified by:

getAction in interface ManagerAction

Specified by:

getAction in class AbstractManagerAction

getActionCompleteEventClass

public 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

getChannel

public String getChannel()

Returns the name of the channel to execute the AGI command on.

Returns:

the name of the channel to execute the AGI command on.

setChannel

public void setChannel(String channel)

Sets the name of the channel to execute the AGI command on.

The channel must be running the Async AGI application "AGI(agi:async)".

This property is required.

Parameters:

channel - the name of the channel to execute the AGI command on.

getCommand

public String getCommand()

Returns the AGI command to execute.

Returns:

the AGI command to execute.

setCommand

public void setCommand(String command)

Sets the AGI command to execute.

This property is required.

Parameters:

command - the AGI command to execute.

getCommandId

public String getCommandId()

Returns the command id to track execution progress.

Returns:

the command id to track execution progress.

setCommandId

public void setCommandId(String commandId)

Sets the command id to track execution progress.

This value will be sent back in the CommandID header of AsyncAGI exec event notifications.

Parameters:

commandId - the command id to track execution progress.