Package net.sf.asterisk.manager.action

Provides classes that represent the standard actions that can be sent to an Asterisk server via the Manager API.

See:
Description

Interface Summary

EventGeneratingAction	The EventGeneratingAction interface is implemented by ManagerActions that return their result not in a ManagerResponse but by sending a series of events. The event type that indicates that Asterisk is finished is returned by the getActionCompleteEventClass() method.
ManagerAction	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.

Class Summary

AbsoluteTimeoutAction	The AbsoluteTimeoutAction sets the absolute maximum amount of time permitted for a call on a given channel. Note that the timeout is set from the current time forward, not counting the number of seconds the call has already been up. When setting a new timeout all previous absolute timeouts are cancelled. When the timeout is reached the call is returned to the T extension so that you can playback an explanatory note to the calling party (the called party will not hear that). This action corresponds the the AbsoluteTimeout command used in the dialplan.
AbstractManagerAction	This class implements the ManagerAction interface and can serve as base class for your concrete Action implementations.
AgentCallbackLoginAction	The AgentCallbackLoginAction sets an agent as logged in with callback. You can pass an extentsion (and optionally a context) to specify the destination of the callback. In contrast to the AgentCallbackLogin application that you can use within Asterisk's dialplan, you don't need to know the agent's password when logging in an agent. Available since Asterisk 1.2
AgentLogoffAction	The AgentLogoffAction sets an agent as no longer logged in. Available since Asterisk 1.2
AgentsAction	The AgentsAction requests the state of all agents. For each agent an AgentsEvent is generated.
ChallengeAction	The ChallengeAction requests a challenge from the server to use when logging in using challenge/response.
ChangeMonitorAction	The ChangeMonitorAction changes the monitoring filename of a channel.
CommandAction	The CommandAction sends a command line interface (CLI) command to the asterisk server. For a list of supported commands type help on asterisk's command line.
DBGetAction	Retrieves an entry in the Asterisk database for a given family and key. If an entry is found a DBGetResponseEvent is sent by Asterisk containing the value, otherwise a ManagerError indicates that no entry matches. Available since Asterisk 1.2
DBPutAction	Adds or updates an entry in the Asterisk database for a given family, key, and value. Available since Asterisk 1.2
EventsAction	With the EventsAction you can specify what kind of events should be sent to this manager connection.
ExtensionStateAction	The ExtensionStateAction queries the state of an extension in a given context.
GetVarAction	The GetVarAction queries for a global or local channel variable. Reading global variables is supported since Asterisk 1.2.
HangupAction	The HangupAction causes the pbx to hang up a given channel.
LoginAction	The LoginAction authenticates the connection. A successful login is the precondition for sending any other action except for the ChallengeAction. An unsuccessful login results in an ManagerError being received from the server with a message set to "Authentication failed" and the socket being closed by Asterisk.
LogoffAction	The LogoffAction causes the server to close the connection.
MailboxCountAction	The MailboxCountAction queries the number of unread and read messages in a mailbox. The MailboxCountAction returns a MailboxStatusResponse.
MailboxStatusAction	The MailboxStatusAction checks if a mailbox contains waiting messages. The MailboxStatusAction returns a MailboxStatusResponse.
MonitorAction	The MonitorAction starts monitoring (recording) a channel. It is implemented in res/res_monitor.c
OriginateAction	The OriginateAction generates an outgoing call to the extension in the given context with the given priority or to a given application with optional parameters. If you want to connect to an extension use the properties context, exten and priority.
ParkedCallsAction	The ParkedCallsAction requests a list of all currently parked calls. For each active channel a ParkedCallEvent is generated.
PingAction	The PingAction will ellicit a 'Pong' response, it is used to keep the manager connection open and performs no operation.
QueueAddAction	The QueueAddAction adds a new member to a queue. It is implemented in apps/app_queue.c
QueuePauseAction	The QueuePauseAction makes a queue member temporarily unavailabe (or available again). It is implemented in apps/app_queue.c Available since Asterisk 1.2.
QueueRemoveAction	The QueueRemoveAction removes a member from a queue. It is implemented in apps/app_queue.c
QueueStatusAction	The QueueStatusAction requests the state of all defined queues their members (agents) and entries (callers). For each queue a QueueParamsEvent is generated, followed by a QueueMemberEvent for each member of that queue and a QueueEntryEvent for each entry in the queue. Since Asterisk 1.2 a QueueStatusCompleteEvent is sent to denote the end of the generated dump. This action is implemented in apps/app_queue.c
RedirectAction	Redirects a given channel (and an optional additional channel) to a new extension.
SetCDRUserFieldAction	The SetCDRUserFieldAction causes the user field of the call detail record for the given channel to be changed. Depending on the value of the append property the value is appended or overwritten. The SetCDRUserFieldAction is implemented in apps/app_setcdruserfield.c
SetVarAction	The SetVarAction sets the value of a global or local channel variable. Setting global variables is supported since Asterisk 1.2.
SIPPeersAction	Retrieves a list of all defined SIP peers. For each peer that is found a PeerEntryEvent is sent by Asterisk containing the details.
SIPShowPeerAction	Retrieves a the details about a given SIP peer. For a PeerEntryEvent is sent by Asterisk containing the details of the peer followed by a PeerlistCompleteEvent. Available since Asterisk 1.2
StatusAction	The StatusAction requests the state of all active channels. For each active channel a StatusEvent is generated.
StopMonitorAction	The StopMonitorAction ends monitoring (recording) a channel. It is implemented in res/res_monitor.c
ZapDialOffhookAction	The ZapDialOffhookAction dials a number on a zap channel while offhook.
ZapDNDOffAction	The ZapDNDOnAction switches a zap channel "Do Not Disturb" status off.
ZapDNDOnAction	The ZapDNDOnAction switches a zap channel "Do Not Disturb" status on.
ZapHangupAction	The ZapHangupAction hangs up a zap channel.
ZapShowChannelsAction	The ZapShowChannelsAction requests the state of all zap channels. For each zap channel a ZapShowChannelsEvent is generated.
ZapTransferAction	The ZapTransferAction transfers a zap channel.

Package net.sf.asterisk.manager.action Description

Provides classes that represent the standard actions that can be sent to an Asterisk server via the Manager API.