AsterNet Class Library (Sandcastle documentation)

| AsterNET.Manager.Action Namespace

AsterNet Manager Action
Classes

| Class | Description
--- | --- | ---

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.

| 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.
| AgentsAction | The AgentsAction requests the state of all agents. For each agent an AgentsEvent is generated. After the state of all agents has been reported an AgentsCompleteEvent is generated. Available since Asterisk 1.2
| AgiAction | This action lets you execute any AGI command through the Manager interface For example, check the AsterNET.Test project
| AOCMessageAction |
| AtxferAction |
| BridgeAction |
| ChallengeAction | The ChallengeAction requests a challenge from the server to use when logging in using challenge/response. Sending this action to the asterisk server results in a ChallengeResponse being received from the server.
| ChangeMonitorAction | The ChangeMonitorAction changes the monitoring filename of a channel. It has no effect if the channel is not monitored. It is implemented in res/res_monitor.c
| 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.
| ConfbridgeKickAction |
| ConfbridgeListAction | Lists all users in a particular ConfBridge conference. ConfbridgeList will follow as separate events, followed by a final event called ConfbridgeListComplete
| ConfbridgeListRoomsAction | Lists data about all active conferences. ConfbridgeListRooms will follow as separate events, followed by a final event called ConfbridgeListRoomsComplete.
| ConfbridgeLockAction |
| ConfbridgeMuteAction |
| ConfbridgeSetSingleVideoSrcAction |
| ConfbridgeStartRecordAction |
| ConfbridgeStopRecordAction |
| ConfbridgeUnlockAction |
| ConfbridgeUnmuteAction |
| CoreSettingsAction |
| CoreShowChannelsAction |
| CoreStatusAction |
| CreateConfigAction |
| DBDelAction |
| DBDelTreeAction |
| 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.
| 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.
| GetConfigAction | The GetConfigAction sends a GetConfig command to the asterisk server.
| GetVarAction | The GetVarAction queries for a channel variable.
| 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.
| ManagerAction | This class implements the ManagerAction interface and can serve as base class for your concrete Action implementations.
| ManagerActionEvent | The ManagerActionEvent 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 ActionCompleteEventClass property.
| ManagerActionResponse | The ManagerActionResponse is implemented by ManagerActions that return their result in a custom ManagerResponse The response type that indicates that Asterisk is finished is returned by the ActionCompleteResponseClass property.
| 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. If you want to connect to an application use the properties application and data if needed. Note that no call detail record will be written when directly connecting to an application, so it may be better to connect to an extension that starts the application you wish to connect to.
The response to this action is sent when the channel has been answered and asterisk starts connecting it to the given extension. So be careful not to choose a too short timeout when waiting for the response.
If you set async to true Asterisk reports an OriginateSuccess- and OriginateFailureEvents. The action id of these events equals the action id of this OriginateAction.

| ParkAction | The ParkAction allows to send a Channel to a Parking lot. A successful login is the precondition for sending for that
| ParkedCallsAction | The ParkedCallsAction requests a list of all currently parked calls. For each active channel a ParkedCallEvent is generated. After all parked calls have been reported a ParkedCallsCompleteEvent is generated.
| PingAction | The PingAction will ellicit a 'Pong' response, it is used to keep the manager connection open and performs no operation.
| ProxyAction |
| QueueAddAction | The QueueAddAction adds a new member to a queue. It is implemented in apps/app_queue.c
| QueueLogAction |
| 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.
| QueuePenaltyAction |
| QueueReloadAction |
| QueueRemoveAction | The QueueRemoveAction removes a member from a queue. It is implemented in apps/app_queue.c
| QueueResetAction |
| QueueRuleAction |

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 SetVar action sets the value of a channel variable for a given channel.
| SIPPeersAction | Retrieves a list of all defined SIP peers. For each peer that is found a PeerEntryEvent is sent by Asterisk containing the details. When all peers have been reported a PeerlistCompleteEvent is sent. Available since Asterisk 1.2
| 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. After the state of all channels has been reported a StatusCompleteEvent is generated.
| StopMonitorAction | The StopMonitorAction ends monitoring (recording) a channel. It is implemented in res/res_monitor.c

UpdateConfigAction

The UpdateConfigAction sends an UpdateConfig command to the asterisk server. Please take note that unlike the manager documentation, this command does not dump back the config file upon success -- it only tells you it succeeded. You should use the handy addCommand method this class provides for specifying what actions you would like to take on the configuration file. It will generate appropriate sequence numbers for the command. You may use the static ACTION_* fields provided by this action to specify what action you would like to take, while avoiding handling the strings required. Plain fields:
SrcFilename: Configuration filename to read(e.g. foo.conf)
DstFilename: Configuration filename to write(e.g. foo.conf)
Reload: Whether or not a reload should take place (or name of specific module)
Repeatable fields:
Action-XXXXXX: Action to Take (NewCat,RenameCat,DelCat,Update,Delete,Append)
Cat-XXXXXX: Category to operate on
Var-XXXXXX: Variable to work on
Value-XXXXXX: Value to work on
Match-XXXXXX: Extra match required to match line

| 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. After all zap channels have been listed a ZapShowChannelsCompleteEvent is generated.
| ZapTransferAction | The ZapTransferAction transfers a zap channel.