asternet/docs/html/N_AsterNET_Manager_Event.htm

278 lines
84 KiB
HTML
Raw Normal View History

<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>AsterNET.Manager.Event Namespace</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="AsterNET.Manager.Event namespace" /><meta name="Microsoft.Help.F1" content="AsterNET.Manager.Event" /><meta name="Microsoft.Help.Id" content="N:AsterNET.Manager.Event" /><meta name="Description" content="summaryN:AsterNET.Manager.Event" /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="AsterNET.Manager.Event" /><meta name="file" content="N_AsterNET_Manager_Event" /><meta name="guid" content="N_AsterNET_Manager_Event" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">AsterNet Class Library (Sandcastle documentation)<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="79b6241e-05a3-441c-b6a1-51f2b5b7f265.htm" title="AsterNet Class Library (Sandcastle documentation)" tocid="roottoc">AsterNet Class Library (Sandcastle documentation)</a></div><div class="toclevel1 current" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="N_AsterNET_Manager_Event.htm" title="AsterNET.Manager.Event" tocid="N_AsterNET_Manager_Event">AsterNET.Manager.Event</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_Manager_Event_AbstractAgentEvent.htm" title="AbstractAgentEvent Class" tocid="T_AsterNET_Manager_Event_AbstractAgentEvent">AbstractAgentEvent Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_Manager_Event_AbstractAgentVariables.htm" title="AbstractAgentVariables Class" tocid="T_AsterNET_Manager_Event_AbstractAgentVariables">AbstractAgentVariables Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_Manager_Event_AbstractChannelEvent.htm" title="AbstractChannelEvent Class" tocid="T_AsterNET_Manager_Event_AbstractChannelEvent">AbstractChannelEvent Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_Manager_Event_AbstractConfbridgeEvent.htm" title="AbstractConfbridgeEvent Class" tocid="T_AsterNET_Manager_Event_AbstractConfbridgeEvent">AbstractConfbridgeEvent Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!"></a><a data-tochassubtree="true" href="T_AsterNET_Manager_Event_AbstractMeetmeEvent.htm" title="AbstractMeetmeEvent Class" tocid="T_AsterNET_Manager_Event_AbstractMeetmeEvent">AbstractMeetmeEvent Class</a></div><div class="toclevel2" data-toclevel="2"><a class="t
 
</th><th>Class</th><th>Description</th></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AbstractAgentEvent.htm">AbstractAgentEvent</a></td><td><div class="summary">
Abstract base class for several agent related events.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AbstractAgentVariables.htm">AbstractAgentVariables</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AbstractChannelEvent.htm">AbstractChannelEvent</a></td><td><div class="summary">
Abstract base class providing common properties for HangupEvent, NewChannelEvent and NewStateEvent.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AbstractConfbridgeEvent.htm">AbstractConfbridgeEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AbstractMeetmeEvent.htm">AbstractMeetmeEvent</a></td><td><div class="summary">
Abstract base class providing common properties for meet me (asterisk's conference system) events.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AbstractParkedCallEvent.htm">AbstractParkedCallEvent</a></td><td><div class="summary">
Abstract base class for several call parking related events.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AbstractQueueMemberEvent.htm">AbstractQueueMemberEvent</a></td><td><div class="summary">
Abstract base class for several queue member related events.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AgentCallbackLoginEvent.htm">AgentCallbackLoginEvent</a></td><td><div class="summary">
An AgentCallbackLoginEvent is triggered when an agent is successfully logged in using AgentCallbackLogin.<br />
It is implemented in channels/chan_agent.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AgentCallbackLogoffEvent.htm">AgentCallbackLogoffEvent</a></td><td><div class="summary">
An AgentCallbackLogoffEvent is triggered when an agent that previously logged in using
AgentCallbackLogin is logged of.<br />
It is implemented in channels/chan_agent.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AgentCalledEvent.htm">AgentCalledEvent</a></td><td><div class="summary">
An AgentCalledEvent is triggered when an agent is rung.<br />
To enable AgentCalledEvents you have to set eventwhencalled = yes in queues.conf.<br />
This event is implemented in apps/app_queue.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AgentCompleteEvent.htm">AgentCompleteEvent</a></td><td><div class="summary">
An AgentCompleteEvent is triggered when at the end of a call if the caller was connected to an agent.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AgentConnectEvent.htm">AgentConnectEvent</a></td><td><div class="summary">
An AgentConnectEvent is triggered when a caller is connected to an agent.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AgentDumpEvent.htm">AgentDumpEvent</a></td><td><div class="summary">
An AgentDumpEvent is triggered when an agent dumps the caller while listening
to the queue announcement.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AgentLoginEvent.htm">AgentLoginEvent</a></td><td><div class="summary">
An AgentLoginEvent is triggered when an agent is successfully logged in using AgentLogin.<br />
It is implemented in channels/chan_agent.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AgentLogoffEvent.htm">AgentLogoffEvent</a></td><td><div class="summary">
An AgentCallbackLogoffEvent is triggered when an agent that previously logged in using AgentLogin is logged of.
It is implemented in channels/chan_agent.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AgentsCompleteEvent.htm">AgentsCompleteEvent</a></td><td><div class="summary">
An AgentsCompleteEvent is triggered after the state of all agents has been
reported in response to an AgentsAction.<br />
Available since Asterisk 1.2
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AgentsEvent.htm">AgentsEvent</a></td><td><div class="summary">
An AgentsEvent is triggered for each agent in response to an AgentsAction.<br />
Available since Asterisk 1.2
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AGIExecEvent.htm">AGIExecEvent</a></td><td><div class="summary">
AgiExecEvents are triggered when an AGI command is executed.<br />
For each command two events are triggered: one before excution ("Start") and one after execution ("End").
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AlarmClearEvent.htm">AlarmClearEvent</a></td><td><div class="summary">
An AlarmEvent is triggered when a Zap channel leaves alarm state.<br />
It is implemented in channels/chan_zap.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AlarmEvent.htm">AlarmEvent</a></td><td><div class="summary">
An AlarmEvent is triggered when a Zap channel enters or changes alarm state.<br />
It is implemented in channels/chan_zap.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AsyncAGIEvent.htm">AsyncAGIEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_AttendedTransferEvent.htm">AttendedTransferEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_BlindTransferEvent.htm">BlindTransferEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_BridgeActivityEvent.htm">BridgeActivityEvent</a></td><td><div class="summary" /></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_BridgeCreateEvent.htm">BridgeCreateEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_BridgeDestroyEvent.htm">BridgeDestroyEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_BridgeEnterEvent.htm">BridgeEnterEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_BridgeEvent.htm">BridgeEvent</a></td><td><div class="summary">
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().
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_BridgeLeaveEvent.htm">BridgeLeaveEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_BridgeStateEvent.htm">BridgeStateEvent</a></td><td><div class="summary" /></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_CdrEvent.htm">CdrEvent</a></td><td><div class="summary">
A CdrEvent is triggered when a call detail record is generated, usually at the end of a call.<br />
To enable CdrEvents you have to add enabled = yes to the general section in
cdr_manager.conf.<br />
This event is implemented in cdr/cdr_manager.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ChannelReloadEvent.htm">ChannelReloadEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ChannelUpdateEvent.htm">ChannelUpdateEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ConfbridgeEndEvent.htm">ConfbridgeEndEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ConfbridgeJoinEvent.htm">ConfbridgeJoinEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ConfbridgeLeaveEvent.htm">ConfbridgeLeaveEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ConfbridgeListCompleteEvent.htm">ConfbridgeListCompleteEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ConfbridgeListEvent.htm">ConfbridgeListEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ConfbridgeListRoomsCompleteEvent.htm">ConfbridgeListRoomsCompleteEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ConfbridgeListRoomsEvent.htm">ConfbridgeListRoomsEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ConfbridgeStartEvent.htm">ConfbridgeStartEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ConfbridgeTalkingEvent.htm">ConfbridgeTalkingEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ConnectEvent.htm">ConnectEvent</a></td><td><div class="summary">
A ConnectEvent is triggered after successful login to the asterisk server.<br />
It is a pseudo event not directly related to an asterisk generated event.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ConnectionStateEvent.htm">ConnectionStateEvent</a></td><td><div class="summary">
Abstract base class for several agent related events.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_DBGetResponseEvent.htm">DBGetResponseEvent</a></td><td><div class="summary">
A DBGetResponseEvent is sent in response to a DBGetAction and contains the entry that was queried.<br />
Available since Asterisk 1.2
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_DialBeginEvent.htm">DialBeginEvent</a></td><td><div class="summary">
A dial begin event is triggered whenever a phone attempts to dial someone.<br />
This event is implemented in apps/app_dial.c.<br />
Available since Asterisk 1.2.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_DialEvent.htm">DialEvent</a></td><td><div class="summary">
A dial event is triggered whenever a phone attempts to dial someone.<br />
This event is implemented in apps/app_dial.c.<br />
Available since Asterisk 1.2.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_DisconnectEvent.htm">DisconnectEvent</a></td><td><div class="summary">
A DisconnectEvent is triggered when the connection to the asterisk server is lost.<br />
It is a pseudo event not directly related to an asterisk generated event.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_DNDStateEvent.htm">DNDStateEvent</a></td><td><div class="summary">
A DNDStateEvent is triggered by the Zap channel driver when a channel enters
or leaves DND (do not disturb) state.<br />
It is implemented in channels/chan_zap.c.<br />
Available since Asterisk 1.2
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_DTMFEvent.htm">DTMFEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ExtensionStatusEvent.htm">ExtensionStatusEvent</a></td><td><div class="summary">
An ExtensionStatusEvent is triggered when the state of an extension changes.<br />
It is implemented in manager.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_FailedACLEvent.htm">FailedACLEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_FaxReceivedEvent.htm">FaxReceivedEvent</a></td><td><div class="summary">
A FaxReceivedEvent is triggered by spandsp after a new fax has been received.<br />
It is only available if you installed the spandsp patches to Asterisk.<br />
See http://soft-switch.org/installing-spandsp.html for details.<br />
Implemented in apps/app_rxfax.c.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_HangupEvent.htm">HangupEvent</a></td><td><div class="summary">
A HangupEvent is triggered when a channel is hung up.<br />
It is implemented in channel.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_HoldedCallEvent.htm">HoldedCallEvent</a></td><td><div class="summary">
A HoldedCallEvent is triggered when a channel is put on hold.<br />
It is implemented in res/res_features.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_HoldEvent.htm">HoldEvent</a></td><td><div class="summary">
A HoldEvent is triggered by the SIP channel driver when a channel is put on hold.<br />
It is implemented in channels/chan_sip.c.<br />
Available since Asterisk 1.2
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_JabberEvent.htm">JabberEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_JitterBufStatsEvent.htm">JitterBufStatsEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_JoinEvent.htm">JoinEvent</a></td><td><div class="summary">
A JoinEvent is triggered when a channel joines a queue.<br />
It is implemented in apps/app_queue.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_LeaveEvent.htm">LeaveEvent</a></td><td><div class="summary">
A LeaveEvent is triggered when a channel leaves a queue.<br />
It is implemented in apps/app_queue.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_LinkEvent.htm">LinkEvent</a></td><td><div class="summary">
A LinkEvent is triggered when two voice channels are linked together and voice data exchange commences.<br />
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.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_LogChannelEvent.htm">LogChannelEvent</a></td><td><div class="summary">
A LogChannelEvent is triggered when logging is turned on or off.<br />
It is implemented in logger.c<br /></div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ManagerEvent.htm">ManagerEvent</a></td><td><div class="summary">
Abstract base class for all Events that can be received from the Asterisk server.<br />
Events contain data pertaining to an event generated from within the Asterisk
core or an extension module.<br />
There is one conrete subclass of ManagerEvent per each supported Asterisk
Event.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_MeetmeEndEvent.htm">MeetmeEndEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_MeetmeJoinEvent.htm">MeetmeJoinEvent</a></td><td><div class="summary">
A MeetMeJoinEvent is triggered if a channel joins a meet me conference.<br />
It is implemented in apps/app_meetme.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_MeetmeLeaveEvent.htm">MeetmeLeaveEvent</a></td><td><div class="summary">
A MeetMeLeaveEvent is triggered if a channel leaves a meet me conference.<br />
It is implemented in apps/app_meetme.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_MeetmeMuteEvent.htm">MeetmeMuteEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_MeetmeStopTalkingEvent.htm">MeetmeStopTalkingEvent</a></td><td><div class="summary">
A MeetMeStopTalkingEvent is triggered when a user ends talking in a meet me conference.<br />
It is implemented in apps/app_meetme.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_MeetmeTalkingEvent.htm">MeetmeTalkingEvent</a></td><td><div class="summary">
A MeetMeTalkingEvent is triggered when a user starts talking in a meet me conference.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_MeetmeTalkRequestEvent.htm">MeetmeTalkRequestEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_MessageWaitingEvent.htm">MessageWaitingEvent</a></td><td><div class="summary">
A MessageWaitingEvent is triggered when someone leaves voicemail.<br />
It is implemented in apps/app_voicemail.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_MobileStatusEvent.htm">MobileStatusEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ModuleLoadReportEvent.htm">ModuleLoadReportEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_MonitorStartEvent.htm">MonitorStartEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_MonitorStopEvent.htm">MonitorStopEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_NewAccountCodeEvent.htm">NewAccountCodeEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_NewCallerIdEvent.htm">NewCallerIdEvent</a></td><td><div class="summary">
A NewCallerIdEvent is triggered when the caller id of a channel changes.<br />
It is implemented in channel.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_NewChannelEvent.htm">NewChannelEvent</a></td><td><div class="summary">
A NewChannelEvent is triggered when a new channel is created.<br />
It is implemented in channel.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_NewExtenEvent.htm">NewExtenEvent</a></td><td><div class="summary">
A NewExtenEvent is triggered when a channel is connected to a new extension.<br />
It is implemented in pbx.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_NewStateEvent.htm">NewStateEvent</a></td><td><div class="summary">
A NewStateEvent is triggered when the state of a channel has changed.<br />
It is implemented in channel.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_OriginateResponseEvent.htm">OriginateResponseEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ParkedCallEvent.htm">ParkedCallEvent</a></td><td><div class="summary">
A ParkedCallEvent is triggered when a channel is parked (in this case no
action id is set) and in response to a ParkedCallsAction.<br />
It is implemented in res/res_features.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ParkedCallGiveUpEvent.htm">ParkedCallGiveUpEvent</a></td><td><div class="summary">
A ParkedCallGiveUpEvent is triggered when a channel that has been parked is hung up.<br />
It is implemented in res/res_features.c<br />
Available since Asterisk 1.2
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ParkedCallsCompleteEvent.htm">ParkedCallsCompleteEvent</a></td><td><div class="summary">
A ParkedCallsCompleteEvent is triggered after all parked calls have been reported in response to a ParkedCallsAction.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ParkedCallTimeOutEvent.htm">ParkedCallTimeOutEvent</a></td><td><div class="summary">
A ParkedCallTimeOutEvent is triggered when call parking times out for a given channel.<br />
It is implemented in res/res_features.c<br />
Available since Asterisk 1.2
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_PeerEntryEvent.htm">PeerEntryEvent</a></td><td><div class="summary">
A PeerEntryEvent is triggered in response to a SIPPeersAction or SIPShowPeerAction and contains information about a peer.<br />
It is implemented in channels/chan_sip.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_PeerlistCompleteEvent.htm">PeerlistCompleteEvent</a></td><td><div class="summary">
A PeerlistCompleteEvent is triggered after the details of all peers has been reported in response to an SIPPeersAction or SIPShowPeerAction.<br />
Available since Asterisk 1.2
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_PeerStatusEvent.htm">PeerStatusEvent</a></td><td><div class="summary">
A PeerStatusEvent is triggered when a SIP or IAX client attempts to registrer at this asterisk server.<br />
This event is implemented in channels/chan_iax2.c and channels/chan_sip.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_PRIEvent.htm">PRIEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_QueueCallerAbandonEvent.htm">QueueCallerAbandonEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_QueueEntryEvent.htm">QueueEntryEvent</a></td><td><div class="summary">
A QueueEntryEvent is triggered in response to a QueueStatusAction and contains information about an entry in a queue.<br />
It is implemented in apps/app_queue.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_QueueEvent.htm">QueueEvent</a></td><td><div class="summary">
Abstract base class providing common properties for JoinEvent and LeaveEvent.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_QueueMemberAddedEvent.htm">QueueMemberAddedEvent</a></td><td><div class="summary">
A QueueMemberAddedEvent is triggered when a queue member is added to a queue.<br />
It is implemented in apps/app_queue.c.<br />
Available since Asterisk 1.2
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_QueueMemberEvent.htm">QueueMemberEvent</a></td><td><div class="summary">
A QueueMemberEvent is triggered in response to a QueueStatusAction and contains information about a member of a queue.<br />
It is implemented in apps/app_queue.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_QueueMemberPausedEvent.htm">QueueMemberPausedEvent</a></td><td><div class="summary">
A QueueMemberPausedEvent is triggered when a queue member is paused or unpaused.<br />
It is implemented in apps/app_queue.c.<br />
Available since Asterisk 1.2
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_QueueMemberPenaltyEvent.htm">QueueMemberPenaltyEvent</a></td><td><div class="summary">
A QueueMemberPenaltyEvent is triggered when a queue member is assigned a new penalty.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_QueueMemberRemovedEvent.htm">QueueMemberRemovedEvent</a></td><td><div class="summary">
A QueueMemberRemovedEvent is triggered when a queue member is removed from a queue.<br />
It is implemented in apps/app_queue.c.<br />
Available since Asterisk 1.2
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_QueueMemberStatusEvent.htm">QueueMemberStatusEvent</a></td><td><div class="summary">
A QueueMemberStatusEvent shows the status of a QueueMemberEvent
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_QueueParamsEvent.htm">QueueParamsEvent</a></td><td><div class="summary">
A QueueParamsEvent is triggered in response to a QueueStatusAction and contains the parameters of a queue.<br />
It is implemented in apps/app_queue.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_QueueStatusCompleteEvent.htm">QueueStatusCompleteEvent</a></td><td><div class="summary">
A QueueStatusCompleteEvent is triggered after the state of all queues has been reported in response to a QueueStatusAction.<br />
Since Asterisk 1.2
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_RegistryEvent.htm">RegistryEvent</a></td><td><div class="summary">
A RegistryEvent is triggered when this asterisk server attempts to register
as a client at another SIP or IAX server.<br />
This event is implemented in channels/chan_iax2.c and
channels/chan_sip.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ReloadEvent.htm">ReloadEvent</a></td><td><div class="summary">
A ReloadEvent is triggerd when the reload console command is executed or the asterisk server is started.<br />
It is implemented in manager.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_RenameEvent.htm">RenameEvent</a></td><td><div class="summary">
A RenameEvent is triggered when the name of a channel is changed.<br />
It is implemented in channel.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ResponseEvent.htm">ResponseEvent</a></td><td><div class="summary">
Abstract base class for events triggered in response to a ManagerAction.<br />
All ResponseEvents contain an additional action id property that links the
event to the action that caused it.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_RTCPReceivedEvent.htm">RTCPReceivedEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_RTCPSentEvent.htm">RTCPSentEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_RTPReceiverStatEvent.htm">RTPReceiverStatEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_RTPSenderStatEvent.htm">RTPSenderStatEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ShowDialPlanCompleteEvent.htm">ShowDialPlanCompleteEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ShutdownEvent.htm">ShutdownEvent</a></td><td><div class="summary">
A ShutdownEvent is triggered when the asterisk server is shut down or restarted.<br />
It is implemented in asterisk.c
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_StatusCompleteEvent.htm">StatusCompleteEvent</a></td><td><div class="summary">
A StatusCompleteEvent is triggered after the state of all channels has been reported in response
to a StatusAction.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_StatusEvent.htm">StatusEvent</a></td><td><div class="summary">
A StatusEvent is triggered for each active channel in response to a StatusAction.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_TransferEvent.htm">TransferEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_UnholdEvent.htm">UnholdEvent</a></td><td><div class="summary">
An UnholdEvent is triggered by the SIP channel driver when a channel is no longer put on hold.<br />
It is implemented in channels/chan_sip.c.<br />
Available since Asterisk 1.2
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_UnknownEvent.htm">UnknownEvent</a></td><td><div class="summary">
A UnknownEvent is triggered on unknown event from manager/proxy.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_UnlinkEvent.htm">UnlinkEvent</a></td><td><div class="summary">
An UnlinkEvent is triggered when a link between two voice channels is discontinued,
for example, just before call completion.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_UnparkedCallEvent.htm">UnparkedCallEvent</a></td><td><div class="summary">
A UnparkedCallEvent is triggered when a channel that has been parked is resumed.<br />
It is implemented in res/res_features.c<br />
Available since Asterisk 1.2
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_UserEvent.htm">UserEvent</a></td><td><div class="summary">
Abstract base class for user events.<br />
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.<br />
To add your own user events you must subclass this class and name it corresponding to your event.<br />
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".<br />
To pass additional data create appropriate attributes with getter and setter methods in your new class.<br />
Example:
<pre>
public class VIPCallEvent : UserEvent
{
private string firstName;
// Constructor
public VIPCallEvent()
{
}
// Property
public string FirstName
{
get { return this.firstName; }
set { this.firstName = value; }
}
}
</pre>
To send this event use UserEvent(VIPCall|firstName: Jon) in your dialplan.<br />
The UserEvent is implemented in apps/app_userevent.c.<br />
Note that you must register your UserEvent with the ManagerConnection you are using in order to be recognized.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_VarSetEvent.htm">VarSetEvent</a></td><td /></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ZapShowChannelsCompleteEvent.htm">ZapShowChannelsCompleteEvent</a></td><td><div class="summary">
A ZapShowChannelsCompleteEvent is triggered after the state of all zap channels has been reported
in response to a ZapShowChannelsAction.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="T_AsterNET_Manager_Event_ZapShowChannelsEvent.htm">ZapShowChannelsEvent</a></td><td><div class="summary">
A ZapShowChannelsEvent is triggered in response to a ZapShowChannelsAction and shows the state of a zap channel.
</div></td></tr></table></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Enumerations</span></div><div id="ID1RBSection" class="collapsibleSection"><table id="typeList" class="members"><tr><th class="iconColumn">
 
</th><th>Enumeration</th><th>Description</th></tr><tr data="enumeration; public"><td><img src="../icons/pubenumeration.gif" alt="Public enumeration" title="Public enumeration" /></td><td><a href="T_AsterNET_Manager_Event_BridgeEvent_BridgeStates.htm">BridgeEvent<span id="LSTA847CC2E_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTA847CC2E_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>BridgeStates</a></td><td /></tr><tr data="enumeration; public"><td><img src="../icons/pubenumeration.gif" alt="Public enumeration" title="Public enumeration" /></td><td><a href="T_AsterNET_Manager_Event_BridgeEvent_BridgeTypes.htm">BridgeEvent<span id="LSTA847CC2E_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LSTA847CC2E_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>BridgeTypes</a></td><td /></tr></table></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>