org.asteriskjava.manager.action

Interface ManagerAction

All Superinterfaces:

Serializable

All Known Subinterfaces:

EventGeneratingAction

All Known Implementing Classes:

AbsoluteTimeoutAction, AbstractManagerAction, AbstractMeetMeMuteAction, AgentCallbackLoginAction, AgentLogoffAction, AgentsAction, AgiAction, AtxferAction, BridgeAction, ChallengeAction, ChangeMonitorAction, CommandAction, ConfbridgeKickAction, ConfbridgeListAction, ConfbridgeListRoomsAction, ConfbridgeLockAction, ConfbridgeMuteAction, ConfbridgeSetSingleVideoSrcAction, ConfbridgeStartRecordAction, ConfbridgeStopRecordAction, ConfbridgeUnlockAction, ConfbridgeUnmuteAction, CoreSettingsAction, CoreShowChannelsAction, CoreStatusAction, DahdiShowChannelsAction, DbDelAction, DbDelTreeAction, DbGetAction, DbPutAction, DongleSendSMSAction, DongleShowDevicesAction, EventsAction, ExtensionStateAction, GetConfigAction, GetVarAction, HangupAction, IaxPeerListAction, JabberSendAction, ListCommandsAction, LocalOptimizeAwayAction, LoginAction, LogoffAction, MailboxCountAction, MailboxStatusAction, MeetMeMuteAction, MeetMeUnmuteAction, MessageSendAction, MixMonitorMuteAction, ModuleCheckAction, ModuleLoadAction, MonitorAction, MuteAudioAction, OriginateAction, ParkAction, ParkedCallsAction, PauseMixMonitorAction, PauseMonitorAction, PingAction, PlayDtmfAction, QueueAddAction, QueueLogAction, QueuePauseAction, QueuePenaltyAction, QueueRemoveAction, QueueResetAction, QueueStatusAction, QueueSummaryAction, RedirectAction, SendTextAction, SetCdrUserFieldAction, SetVarAction, ShowDialplanAction, SipNotifyAction, SipPeersAction, SipShowPeerAction, SipShowRegistryAction, SkypeAccountPropertyAction, SkypeAddBuddyAction, SkypeBuddiesAction, SkypeBuddyAction, SkypeChatSendAction, SkypeLicenseListAction, SkypeLicenseStatusAction, SkypeRemoveBuddyAction, StatusAction, StopMonitorAction, UnpauseMonitorAction, UpdateConfigAction, UserEventAction, VoicemailUsersListAction, ZapDialOffhookAction, ZapDndOffAction, ZapDndOnAction, ZapHangupAction, ZapRestartAction, ZapShowChannelsAction, ZapTransferAction

public interface ManagerAction
extends 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$

Author:

srt

Method Summary

Modifier and Type	Method and Description
String	getAction() Returns the name of the action for example "Hangup".
String	getActionId() Returns the action id.
void	setActionId(String actionId) Sets the action id.

Method Detail

getAction

String getAction()

Returns the name of the action for example "Hangup".

getActionId

String getActionId()

Returns the action id.

Returns:

the user provied action id.

setActionId

void setActionId(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 id. This way the action id can be used to track actions and their corresponding responses and response events.

Note that Asterisk-Java uses its own internal action id to match actions with the corresponding responses and events. Though the internal action is never exposed to the application code. So if you want to handle reponses or response events on your own your application must set a unique action id using this method otherwise the action id of the reponse and response event objects passed to your application will be null.

Parameters:

actionId - the user provided action id to set.

See Also:

ManagerResponse.getActionId(), ResponseEvent.getActionId()