Uses of Interface
net.sf.asterisk.manager.action.ManagerAction

Packages that use ManagerAction
net.sf.asterisk.manager Provides an implementaion of Asterisk's Manager API. 
net.sf.asterisk.manager.action Provides classes that represent the standard actions that can be sent to an Asterisk server via the Manager API. 
net.sf.asterisk.manager.impl Provides private implementations for interfaces defined in the net.sf.asterisk.manager package. 
 

Uses of ManagerAction in net.sf.asterisk.manager
 

Methods in net.sf.asterisk.manager with parameters of type ManagerAction
 java.lang.String ActionBuilder.buildAction(ManagerAction action)
          Builds a String suitable to be sent to Asterisk based on the given action object.
Asterisk actions consist of an unordered set of key value pairs corresponding to the attributes of the ManagerActions.
 java.lang.String ActionBuilder.buildAction(ManagerAction action, java.lang.String internalActionId)
          Builds a String suitable to be sent to Asterisk based on the given action object.
Asterisk actions consist of an unordered set of key value pairs corresponding to the attributes of the ManagerActions.
 ManagerResponse DefaultManagerConnection.sendAction(ManagerAction action)
           
 ManagerResponse ManagerConnection.sendAction(ManagerAction action)
          Sends a ManagerAction to the Asterisk server and waits for the corresponding ManagerResponse.
 ManagerResponse DefaultManagerConnection.sendAction(ManagerAction action, long timeout)
           
 ManagerResponse ManagerConnection.sendAction(ManagerAction action, long timeout)
          Sends a ManagerAction to the Asterisk server and waits for the corresponding ManagerResponse.
 void DefaultManagerConnection.sendAction(ManagerAction action, ManagerResponseHandler callbackHandler)
           
 void ManagerConnection.sendAction(ManagerAction action, ManagerResponseHandler callbackHandler)
          Sends a ManagerAction to the Asterisk server and registers a callback handler to be called when the corresponding ManagerResponse is received.
 void ManagerWriter.sendAction(ManagerAction action, java.lang.String internalActionId)
          Sends the given action to the asterisk server.
 

Uses of ManagerAction in net.sf.asterisk.manager.action
 

Subinterfaces of ManagerAction in net.sf.asterisk.manager.action
 interface 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.
 

Classes in net.sf.asterisk.manager.action that implement ManagerAction
 class 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.
 class AbstractManagerAction
          This class implements the ManagerAction interface and can serve as base class for your concrete Action implementations.
 class 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
 class AgentLogoffAction
          The AgentLogoffAction sets an agent as no longer logged in.
Available since Asterisk 1.2
 class AgentsAction
          The AgentsAction requests the state of all agents.
For each agent an AgentsEvent is generated.
 class ChallengeAction
          The ChallengeAction requests a challenge from the server to use when logging in using challenge/response.
 class ChangeMonitorAction
          The ChangeMonitorAction changes the monitoring filename of a channel.
 class 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.
 class 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
 class DBPutAction
          Adds or updates an entry in the Asterisk database for a given family, key, and value.
Available since Asterisk 1.2
 class EventsAction
          With the EventsAction you can specify what kind of events should be sent to this manager connection.
 class ExtensionStateAction
          The ExtensionStateAction queries the state of an extension in a given context.
 class GetVarAction
          The GetVarAction queries for a global or local channel variable.
Reading global variables is supported since Asterisk 1.2.
 class HangupAction
          The HangupAction causes the pbx to hang up a given channel.
 class 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.
 class LogoffAction
          The LogoffAction causes the server to close the connection.
 class MailboxCountAction
          The MailboxCountAction queries the number of unread and read messages in a mailbox.
The MailboxCountAction returns a MailboxStatusResponse.
 class MailboxStatusAction
          The MailboxStatusAction checks if a mailbox contains waiting messages.
The MailboxStatusAction returns a MailboxStatusResponse.
 class MonitorAction
          The MonitorAction starts monitoring (recording) a channel.
It is implemented in res/res_monitor.c
 class 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.
 class ParkedCallsAction
          The ParkedCallsAction requests a list of all currently parked calls.
For each active channel a ParkedCallEvent is generated.
 class PingAction
          The PingAction will ellicit a 'Pong' response, it is used to keep the manager connection open and performs no operation.
 class QueueAddAction
          The QueueAddAction adds a new member to a queue.
It is implemented in apps/app_queue.c
 class 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.
 class QueueRemoveAction
          The QueueRemoveAction removes a member from a queue.
It is implemented in apps/app_queue.c
 class 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
 class RedirectAction
          Redirects a given channel (and an optional additional channel) to a new extension.
 class 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
 class SetVarAction
          The SetVarAction sets the value of a global or local channel variable.
Setting global variables is supported since Asterisk 1.2.
 class SIPPeersAction
          Retrieves a list of all defined SIP peers.
For each peer that is found a PeerEntryEvent is sent by Asterisk containing the details.
 class 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
 class StatusAction
          The StatusAction requests the state of all active channels.
For each active channel a StatusEvent is generated.
 class StopMonitorAction
          The StopMonitorAction ends monitoring (recording) a channel.
It is implemented in res/res_monitor.c
 class ZapDialOffhookAction
          The ZapDialOffhookAction dials a number on a zap channel while offhook.
 class ZapDNDOffAction
          The ZapDNDOnAction switches a zap channel "Do Not Disturb" status off.
 class ZapDNDOnAction
          The ZapDNDOnAction switches a zap channel "Do Not Disturb" status on.
 class ZapHangupAction
          The ZapHangupAction hangs up a zap channel.
 class ZapShowChannelsAction
          The ZapShowChannelsAction requests the state of all zap channels.
For each zap channel a ZapShowChannelsEvent is generated.
 class ZapTransferAction
          The ZapTransferAction transfers a zap channel.
 

Uses of ManagerAction in net.sf.asterisk.manager.impl
 

Methods in net.sf.asterisk.manager.impl with parameters of type ManagerAction
 java.lang.String ActionBuilderImpl.buildAction(ManagerAction action)
           
 java.lang.String ActionBuilderImpl.buildAction(ManagerAction action, java.lang.String internalActionId)
           
 void ManagerWriterImpl.sendAction(ManagerAction action, java.lang.String internalActionId)
           
 



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