AsterNet Class Library (Sandcastle documentation)

| AsterNET.Manager.Event Namespace

AsterNet Manager Event
Classes

| Class | Description
--- | --- | ---
| AbstractAgentEvent | Abstract base class for several agent related events.
| AbstractAgentVariables |
| AbstractChannelEvent | Abstract base class providing common properties for HangupEvent, NewChannelEvent and NewStateEvent.
| AbstractConfbridgeEvent |
| AbstractMeetmeEvent | Abstract base class providing common properties for meet me (asterisk's conference system) events.
| AbstractParkedCallEvent | Abstract base class for several call parking related events.
| AbstractQueueMemberEvent | Abstract base class for several queue member related events.
| AgentCallbackLoginEvent | An AgentCallbackLoginEvent is triggered when an agent is successfully logged in using AgentCallbackLogin. It is implemented in channels/chan_agent.c
| AgentCallbackLogoffEvent | An AgentCallbackLogoffEvent is triggered when an agent that previously logged in using AgentCallbackLogin is logged of. It is implemented in channels/chan_agent.c
| AgentCalledEvent | An AgentCalledEvent is triggered when an agent is rung. To enable AgentCalledEvents you have to set eventwhencalled = yes in queues.conf. This event is implemented in apps/app_queue.c
| AgentCompleteEvent | An AgentCompleteEvent is triggered when at the end of a call if the caller was connected to an agent.
| AgentConnectEvent | An AgentConnectEvent is triggered when a caller is connected to an agent.
| AgentDumpEvent | An AgentDumpEvent is triggered when an agent dumps the caller while listening to the queue announcement.
| AgentLoginEvent | An AgentLoginEvent is triggered when an agent is successfully logged in using AgentLogin. It is implemented in channels/chan_agent.c
| AgentLogoffEvent | An AgentCallbackLogoffEvent is triggered when an agent that previously logged in using AgentLogin is logged of. It is implemented in channels/chan_agent.c
| AgentsCompleteEvent | An AgentsCompleteEvent is triggered after the state of all agents has been reported in response to an AgentsAction. Available since Asterisk 1.2
| AgentsEvent | An AgentsEvent is triggered for each agent in response to an AgentsAction. Available since Asterisk 1.2
| AGIExecEvent | AgiExecEvents are triggered when an AGI command is executed. For each command two events are triggered: one before excution ("Start") and one after execution ("End").
| AlarmClearEvent | An AlarmEvent is triggered when a Zap channel leaves alarm state. It is implemented in channels/chan_zap.c
| AlarmEvent | An AlarmEvent is triggered when a Zap channel enters or changes alarm state. It is implemented in channels/chan_zap.c
| AsyncAGIEvent |
| AttendedTransferEvent |
| BlindTransferEvent |
| BridgeActivityEvent |
| BridgeCreateEvent |
| BridgeDestroyEvent |
| BridgeEnterEvent |

BridgeEvent

A BridgeEvent is triggered when a link between two voice channels is established ("Link") or discontinued ("Unlink"). As of Asterisk 1.6 the Bridge event is reported directly by Asterisk. Asterisk versions up to 1.4 report individual events: LinkEvent and UnlinkEvent. For maximum compatibily do not use the Link and Unlink events in your code. Just use the Bridge event and check for isLink() and isUnlink().

| BridgeLeaveEvent |
| BridgeStateEvent |
| CdrEvent | A CdrEvent is triggered when a call detail record is generated, usually at the end of a call. To enable CdrEvents you have to add enabled = yes to the general section in cdr_manager.conf. This event is implemented in cdr/cdr_manager.c
| ChannelReloadEvent |
| ChannelUpdateEvent |
| ConfbridgeEndEvent |
| ConfbridgeJoinEvent |
| ConfbridgeLeaveEvent |
| ConfbridgeListCompleteEvent |
| ConfbridgeListEvent |
| ConfbridgeListRoomsCompleteEvent |
| ConfbridgeListRoomsEvent |
| ConfbridgeStartEvent |
| ConfbridgeTalkingEvent |
| ConnectEvent | A ConnectEvent is triggered after successful login to the asterisk server. It is a pseudo event not directly related to an asterisk generated event.
| ConnectionStateEvent | Abstract base class for several agent related events.
| DBGetResponseEvent | A DBGetResponseEvent is sent in response to a DBGetAction and contains the entry that was queried. Available since Asterisk 1.2
| DialBeginEvent | A dial begin event is triggered whenever when a dial action has started.
| DialEndEvent | A dial begin event is triggered whenever when a dial action has completed.
| DialEvent | A dial event is triggered whenever a phone attempts to dial someone. This event is implemented in apps/app_dial.c. Available since Asterisk 1.2.
| DisconnectEvent | A DisconnectEvent is triggered when the connection to the asterisk server is lost. It is a pseudo event not directly related to an asterisk generated event.
| DNDStateEvent | A DNDStateEvent is triggered by the Zap channel driver when a channel enters or leaves DND (do not disturb) state. It is implemented in channels/chan_zap.c. Available since Asterisk 1.2
| DTMFEvent |
| ExtensionStatusEvent | An ExtensionStatusEvent is triggered when the state of an extension changes. It is implemented in manager.c
| FailedACLEvent |
| FaxReceivedEvent | A FaxReceivedEvent is triggered by spandsp after a new fax has been received. It is only available if you installed the spandsp patches to Asterisk. See http://soft-switch.org/installing-spandsp.html for details. Implemented in apps/app_rxfax.c.
| HangupEvent | A HangupEvent is triggered when a channel is hung up. It is implemented in channel.c
| HoldedCallEvent | A HoldedCallEvent is triggered when a channel is put on hold. It is implemented in res/res_features.c
| HoldEvent | A HoldEvent is triggered by the SIP channel driver when a channel is put on hold. It is implemented in channels/chan_sip.c. Available since Asterisk 1.2
| JabberEvent |
| JitterBufStatsEvent |
| JoinEvent | A JoinEvent is triggered when a channel joines a queue. It is implemented in apps/app_queue.c
| LeaveEvent | A LeaveEvent is triggered when a channel leaves a queue. It is implemented in apps/app_queue.c
| LinkEvent | A LinkEvent is triggered when two voice channels are linked together and voice data exchange commences. Several Link events may be seen for a single call. This can occur when Asterisk fails to setup a native bridge for the call. This is when Asterisk must sit between two telephones and perform CODEC conversion on their behalf.
| LogChannelEvent | A LogChannelEvent is triggered when logging is turned on or off. It is implemented in logger.c
| ManagerEvent | Abstract base class for all Events that can be received from the Asterisk server. Events contain data pertaining to an event generated from within the Asterisk core or an extension module. There is one conrete subclass of ManagerEvent per each supported Asterisk Event. Channel / Privilege / UniqueId are not common to all events and should be moved to derived event classes.
| MeetmeEndEvent |
| MeetmeJoinEvent | A MeetMeJoinEvent is triggered if a channel joins a meet me conference. It is implemented in apps/app_meetme.c
| MeetmeLeaveEvent | A MeetMeLeaveEvent is triggered if a channel leaves a meet me conference. It is implemented in apps/app_meetme.c
| MeetmeMuteEvent |
| MeetmeStopTalkingEvent | A MeetMeStopTalkingEvent is triggered when a user ends talking in a meet me conference. It is implemented in apps/app_meetme.c
| MeetmeTalkingEvent | A MeetMeTalkingEvent is triggered when a user starts talking in a meet me conference.
| MeetmeTalkRequestEvent |
| MessageWaitingEvent | A MessageWaitingEvent is triggered when someone leaves voicemail. It is implemented in apps/app_voicemail.c
| MobileStatusEvent |
| ModuleLoadReportEvent |
| MonitorStartEvent |
| MonitorStopEvent |
| NewAccountCodeEvent |
| NewCallerIdEvent | A NewCallerIdEvent is triggered when the caller id of a channel changes. It is implemented in channel.c
| NewChannelEvent | A NewChannelEvent is triggered when a new channel is created. It is implemented in channel.c
| NewExtenEvent | A NewExtenEvent is triggered when a channel is connected to a new extension. It is implemented in pbx.c
| NewStateEvent | A NewStateEvent is triggered when the state of a channel has changed. It is implemented in channel.c
| OriginateResponseEvent |
| ParkedCallEvent | A ParkedCallEvent is triggered when a channel is parked (in this case no action id is set) and in response to a ParkedCallsAction. It is implemented in res/res_features.c
| ParkedCallGiveUpEvent | A ParkedCallGiveUpEvent is triggered when a channel that has been parked is hung up. It is implemented in res/res_features.c Available since Asterisk 1.2
| ParkedCallsCompleteEvent | A ParkedCallsCompleteEvent is triggered after all parked calls have been reported in response to a ParkedCallsAction.
| ParkedCallTimeOutEvent | A ParkedCallTimeOutEvent is triggered when call parking times out for a given channel. It is implemented in res/res_features.c Available since Asterisk 1.2
| PeerEntryEvent | A PeerEntryEvent is triggered in response to a SIPPeersAction or SIPShowPeerAction and contains information about a peer. It is implemented in channels/chan_sip.c
| PeerlistCompleteEvent | A PeerlistCompleteEvent is triggered after the details of all peers has been reported in response to an SIPPeersAction or SIPShowPeerAction. Available since Asterisk 1.2
| PeerStatusEvent | A PeerStatusEvent is triggered when a SIP or IAX client attempts to registrer at this asterisk server. This event is implemented in channels/chan_iax2.c and channels/chan_sip.c
| PRIEvent |
| QueueCallerAbandonEvent |
| QueueCallerJoinEvent | A QueueCallerJoinEvent is triggered when a channel joins a queue.
| QueueCallerLeaveEvent | A QueueCallerLeaveEvent is triggered when a channel leaves a queue.
| QueueEntryEvent | A QueueEntryEvent is triggered in response to a QueueStatusAction and contains information about an entry in a queue. It is implemented in apps/app_queue.c
| QueueEvent | Abstract base class providing common properties for JoinEvent and LeaveEvent.
| QueueMemberAddedEvent | A QueueMemberAddedEvent is triggered when a queue member is added to a queue. It is implemented in apps/app_queue.c. Available since : Asterisk 1.2.
| QueueMemberEvent | A QueueMemberEvent is triggered in response to a QueueStatusAction and contains information about a member of a queue. It is implemented in apps/app_queue.c
| QueueMemberPausedEvent | A QueueMemberPausedEvent is triggered when a queue member is paused or unpaused. It is implemented in apps/app_queue.c. Available since : Asterisk 1.2. Replaced by : QueueMemberPauseEvent since Asterisk 12. Removed since : Asterisk 13.
| QueueMemberPauseEvent | Raised when a member is paused/unpaused in the queue. Available since : Asterisk 12.
| QueueMemberPenaltyEvent | A QueueMemberPenaltyEvent is triggered when a queue member is assigned a new penalty.
| QueueMemberRemovedEvent | A QueueMemberRemovedEvent is triggered when a queue member is removed from a queue. It is implemented in apps/app_queue.c. Available since : Asterisk 1.2.
| QueueMemberRinginuseEvent | Raised when a member's ringinuse setting is changed
| QueueMemberStatusEvent | Raised when a Queue member's status has changed
| QueueParamsEvent | A QueueParamsEvent is triggered in response to a QueueStatusAction and contains the parameters of a queue. It is implemented in apps/app_queue.c
| QueueStatusCompleteEvent | A QueueStatusCompleteEvent is triggered after the state of all queues has been reported in response to a QueueStatusAction. Since Asterisk 1.2
| RegistryEvent | A RegistryEvent is triggered when this asterisk server attempts to register as a client at another SIP or IAX server. This event is implemented in channels/chan_iax2.c and channels/chan_sip.c
| ReloadEvent | A ReloadEvent is triggerd when the reload console command is executed or the asterisk server is started. It is implemented in manager.c
| RenameEvent | A RenameEvent is triggered when the name of a channel is changed. It is implemented in channel.c
| ResponseEvent | Abstract base class for events triggered in response to a ManagerAction. All ResponseEvents contain an additional action id property that links the event to the action that caused it.
| RTCPReceivedEvent |
| RTCPSentEvent |
| RTPReceiverStatEvent |
| RTPSenderStatEvent |
| ShowDialPlanCompleteEvent |
| ShutdownEvent | A ShutdownEvent is triggered when the asterisk server is shut down or restarted. It is implemented in asterisk.c
| StatusCompleteEvent | A StatusCompleteEvent is triggered after the state of all channels has been reported in response to a StatusAction.
| StatusEvent | A StatusEvent is triggered for each active channel in response to a StatusAction.
| TransferEvent |
| UnholdEvent | An UnholdEvent is triggered by the SIP channel driver when a channel is no longer put on hold. It is implemented in channels/chan_sip.c. Available since Asterisk 1.2
| UnknownEvent | A UnknownEvent is triggered on unknown event from manager/proxy.
| UnlinkEvent | An UnlinkEvent is triggered when a link between two voice channels is discontinued, for example, just before call completion.
| UnparkedCallEvent | A UnparkedCallEvent is triggered when a channel that has been parked is resumed. It is implemented in res/res_features.c Available since Asterisk 1.2

UserEvent

Abstract base class for user events.
You can send arbitrary user events via the UserEvent application provided with asterisk. A user event by default has the attributes channel and uniqueId but you can add custom attributes by specifying an event body.
To add your own user events you must subclass this class and name it corresponding to your event.
If you plan to send an event by UserEvent(VIPCall) you will create a new class called VIPCallEvent that extends UserEvent. The name of this class is important: Just use the name of the event you will send (VIPCall in this example) and append "Event".
To pass additional data create appropriate attributes with getter and setter methods in your new class.
Example:

                public class VIPCallEvent : UserEvent
                {
                	 private string firstName;
                	 // Constructor
                	 public VIPCallEvent()
                	 {
                	 }
                	 // Property
                	 public string FirstName
                	 {
                		 get { return this.firstName; }
                		 set { this.firstName = value; }
                	 }
                 }

To send this event use UserEvent(VIPCall|firstName: Jon) in your dialplan.
The UserEvent is implemented in apps/app_userevent.c.
Note that you must register your UserEvent with the ManagerConnection you are using in order to be recognized.

| VarSetEvent |
| ZapShowChannelsCompleteEvent | A ZapShowChannelsCompleteEvent is triggered after the state of all zap channels has been reported in response to a ZapShowChannelsAction.
| ZapShowChannelsEvent | A ZapShowChannelsEvent is triggered in response to a ZapShowChannelsAction and shows the state of a zap channel.

Enumerations

| Enumeration | Description
--- | --- | ---
| BridgeEvent BridgeStates |
| BridgeEvent BridgeTypes |