net.sf.asterisk.manager.action
Interface ManagerAction

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

EventGeneratingAction

All Known Implementing Classes:

AbsoluteTimeoutAction, AbstractManagerAction, AgentCallbackLoginAction, AgentLogoffAction, AgentsAction, ChallengeAction, ChangeMonitorAction, CommandAction, DBGetAction, DBPutAction, EventsAction, ExtensionStateAction, GetVarAction, HangupAction, LoginAction, LogoffAction, MailboxCountAction, MailboxStatusAction, MonitorAction, OriginateAction, ParkedCallsAction, PingAction, QueueAddAction, QueuePauseAction, QueueRemoveAction, QueueStatusAction, RedirectAction, SetCDRUserFieldAction, SetVarAction, SIPPeersAction, SIPShowPeerAction, StatusAction, StopMonitorAction, ZapDialOffhookAction, ZapDNDOffAction, ZapDNDOnAction, ZapHangupAction, ZapShowChannelsAction, ZapTransferAction

public interface ManagerAction
extends java.io.Serializable

Interface that all Actions that can be sent to the Asterisk server must impement.
Instances of this class represent a command sent to Asterisk via Manager API, requesting a particular Action be performed. The number of actions available to the client are determined by the modules presently loaded in the Asterisk engine.
There is one conrete subclass of ManagerAction per each supported Asterisk Action.

Version:

$Id: ManagerAction.java,v 1.4 2005/07/16 13:19:33 srt Exp $

Author:

srt

Method Summary

java.lang.String	getAction() Returns the name of the action.
java.lang.String	getActionId() Returns the action id.
void	setActionId(java.lang.String actionId) Sets the action id. If the action id is set and sent to the asterisk server any response returned by the asterisk server will include the same action id.

Method Detail

getAction

java.lang.String getAction()

Returns the name of the action.

getActionId

java.lang.String getActionId()

Returns the action id.

setActionId

void setActionId(java.lang.String actionId)

Sets the action id.
If the action id is set and sent to the asterisk server any response returned by the asterisk server will include the same action id. This way the action id can be used to track actions and their corresponding responses.