Asterisk
/
asterisk
mirror of https://github.com/asterisk/asterisk
1
0
Fork 0
Code Issues Releases Wiki Activity

docs: Add version information to manager event instance XML elements

Browse Source 
* Do a git blame on the embedded XML managerEvent elements.

* From the commit hash, grab the summary line.

* Do a git log --grep <summary> to find the cherry-pick commits in all
  branches that match.

* Do a git patch-id to ensure the commits are all related and didn't get
  a false match on the summary.

* Do a git tag --contains <commit> to find the tags that contain each
  commit.

* Weed out all tags not ..0.

* Sort and discard any .0.0 and following tags where the commit
  appeared in an earlier branch.

* The result is a single tag for each branch where the application or function
  was defined.

The events defined in res/res_pjsip/pjsip_manager.xml were done by hand
because the XML was extracted from the C source file relatively recently.

Two bugs were fixed along the way...

* The get_documentation awk script was exiting after it processed the first
  DOCUMENTATION block it found in a file.  We have at least 1 source file
  with multiple DOCUMENTATION blocks so only the first one in them was being
  processed.  The awk script was changed to continue searching rather
  than exiting after the first block.

* Fixing the awk script revealed an issue in logger.c where the third
  DOCUMENTATION block contained a XML fragment that consisted only of
  a managerEventInstance element that wasn't wrapped in a managerEvent
  element.  Since logger_doc.xml already existed, the remaining fragments
  in logger.c were moved to it and properly organized.
pull/1102/head
George Joseph 3 months ago
parent ac559b236d
commit a47b8e2d40
45 changed files with 197 additions and 26 deletions
Show Stats Download Patch File Download Diff File

2
apps/app_agent_pool.c
Unescape View File

@ -181,6 +181,7 @@
</manager> </manager>
<managerEvent language="en_US" name="Agents"> <managerEvent language="en_US" name="Agents">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis> <synopsis>
Response event in a series to the Agents AMI action containing Response event in a series to the Agents AMI action containing
information about a defined agent. information about a defined agent.
@ -226,6 +227,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AgentsComplete"> <managerEvent language="en_US" name="AgentsComplete">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis> <synopsis>
Final response event in a series of events to the Agents AMI action. Final response event in a series of events to the Agents AMI action.
</synopsis> </synopsis>

2
apps/app_confbridge.c
Unescape View File

@ -322,6 +322,7 @@
</manager> </manager>
<managerEvent language="en_US" name="ConfbridgeList"> <managerEvent language="en_US" name="ConfbridgeList">
<managerEventInstance class="EVENT_FLAG_REPORTING"> <managerEventInstance class="EVENT_FLAG_REPORTING">
<since><version>13.20.0</version><version>15.3.0</version></since>
<synopsis>Raised as part of the ConfbridgeList action response list.</synopsis> <synopsis>Raised as part of the ConfbridgeList action response list.</synopsis>
<syntax> <syntax>
<parameter name="Conference"> <parameter name="Conference">
@ -401,6 +402,7 @@
</manager> </manager>
<managerEvent language="en_US" name="ConfbridgeListRooms"> <managerEvent language="en_US" name="ConfbridgeListRooms">
<managerEventInstance class="EVENT_FLAG_REPORTING"> <managerEventInstance class="EVENT_FLAG_REPORTING">
<since><version>16.29.0</version><version>18.15.0</version><version>19.7.0</version></since>
<synopsis>Raised as part of the ConfbridgeListRooms action response list.</synopsis> <synopsis>Raised as part of the ConfbridgeListRooms action response list.</synopsis>
<syntax> <syntax>
<parameter name="Conference"> <parameter name="Conference">

8
apps/app_meetme.c
Unescape View File

@ -506,6 +506,7 @@
</manager> </manager>
<managerEvent language="en_US" name="MeetmeJoin"> <managerEvent language="en_US" name="MeetmeJoin">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a user joins a MeetMe conference.</synopsis> <synopsis>Raised when a user joins a MeetMe conference.</synopsis>
<syntax> <syntax>
<parameter name="Meetme"> <parameter name="Meetme">
@ -524,6 +525,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="MeetmeLeave"> <managerEvent language="en_US" name="MeetmeLeave">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a user leaves a MeetMe conference.</synopsis> <synopsis>Raised when a user leaves a MeetMe conference.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter)" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter)" />
@ -539,6 +541,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="MeetmeEnd"> <managerEvent language="en_US" name="MeetmeEnd">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a MeetMe conference ends.</synopsis> <synopsis>Raised when a MeetMe conference ends.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter[@name='Meetme'])" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter[@name='Meetme'])" />
@ -550,6 +553,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="MeetmeTalkRequest"> <managerEvent language="en_US" name="MeetmeTalkRequest">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a MeetMe user has started talking.</synopsis> <synopsis>Raised when a MeetMe user has started talking.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter)" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter)" />
@ -568,6 +572,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="MeetmeTalking"> <managerEvent language="en_US" name="MeetmeTalking">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a MeetMe user begins or ends talking.</synopsis> <synopsis>Raised when a MeetMe user begins or ends talking.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter)" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter)" />
@ -578,6 +583,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="MeetmeMute"> <managerEvent language="en_US" name="MeetmeMute">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a MeetMe user is muted or unmuted.</synopsis> <synopsis>Raised when a MeetMe user is muted or unmuted.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter)" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='MeetmeJoin']/managerEventInstance/syntax/parameter)" />
@ -588,6 +594,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="MeetmeList"> <managerEvent language="en_US" name="MeetmeList">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>16.29.0</version><version>18.15.0</version><version>19.7.0</version></since>
<synopsis>Raised in response to a MeetmeList command.</synopsis> <synopsis>Raised in response to a MeetmeList command.</synopsis>
<syntax> <syntax>
<parameter name="Conference"> <parameter name="Conference">
@ -635,6 +642,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="MeetmeListRooms"> <managerEvent language="en_US" name="MeetmeListRooms">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>16.29.0</version><version>18.15.0</version><version>19.7.0</version></since>
<synopsis>Raised in response to a MeetmeListRooms command.</synopsis> <synopsis>Raised in response to a MeetmeListRooms command.</synopsis>
<syntax> <syntax>
<parameter name="Conference"> <parameter name="Conference">

1
apps/app_minivm.c
Unescape View File

@ -503,6 +503,7 @@
</function> </function>
<managerEvent language="en_US" name="MiniVoiceMail"> <managerEvent language="en_US" name="MiniVoiceMail">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a notification is sent out by a MiniVoiceMail application</synopsis> <synopsis>Raised when a notification is sent out by a MiniVoiceMail application</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>

3
apps/app_mixmonitor.c
Unescape View File

@ -319,6 +319,7 @@
</function> </function>
<managerEvent language="en_US" name="MixMonitorStart"> <managerEvent language="en_US" name="MixMonitorStart">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>16.17.0</version><version>18.3.0</version></since>
<synopsis>Raised when monitoring has started on a channel.</synopsis> <synopsis>Raised when monitoring has started on a channel.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -332,6 +333,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="MixMonitorStop"> <managerEvent language="en_US" name="MixMonitorStop">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>16.17.0</version><version>18.3.0</version></since>
<synopsis>Raised when monitoring has stopped on a channel.</synopsis> <synopsis>Raised when monitoring has stopped on a channel.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -345,6 +347,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="MixMonitorMute"> <managerEvent language="en_US" name="MixMonitorMute">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>16.17.0</version><version>18.3.0</version></since>
<synopsis>Raised when monitoring is muted or unmuted on a channel.</synopsis> <synopsis>Raised when monitoring is muted or unmuted on a channel.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>

16
apps/app_queue.c
Unescape View File

@ -1134,6 +1134,7 @@
<managerEvent language="en_US" name="QueueParams"> <managerEvent language="en_US" name="QueueParams">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<synopsis>Raised in response to the QueueStatus action.</synopsis> <synopsis>Raised in response to the QueueStatus action.</synopsis>
<syntax> <syntax>
<parameter name="Max"> <parameter name="Max">
@ -1172,6 +1173,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="QueueEntry"> <managerEvent language="en_US" name="QueueEntry">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<synopsis>Raised in response to the QueueStatus action.</synopsis> <synopsis>Raised in response to the QueueStatus action.</synopsis>
<syntax> <syntax>
<parameter name="Queue"> <parameter name="Queue">
@ -1213,6 +1215,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="QueueMemberStatus"> <managerEvent language="en_US" name="QueueMemberStatus">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a Queue member's status has changed.</synopsis> <synopsis>Raised when a Queue member's status has changed.</synopsis>
<syntax> <syntax>
<parameter name="Queue"> <parameter name="Queue">
@ -1293,6 +1296,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="QueueMemberAdded"> <managerEvent language="en_US" name="QueueMemberAdded">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a member is added to the queue.</synopsis> <synopsis>Raised when a member is added to the queue.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@ -1305,6 +1309,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="QueueMemberRemoved"> <managerEvent language="en_US" name="QueueMemberRemoved">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a member is removed from the queue.</synopsis> <synopsis>Raised when a member is removed from the queue.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@ -1317,6 +1322,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="QueueMemberPause"> <managerEvent language="en_US" name="QueueMemberPause">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.2.0</version></since>
<synopsis>Raised when a member is paused/unpaused in the queue.</synopsis> <synopsis>Raised when a member is paused/unpaused in the queue.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@ -1329,6 +1335,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="QueueMemberPenalty"> <managerEvent language="en_US" name="QueueMemberPenalty">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a member's penalty is changed.</synopsis> <synopsis>Raised when a member's penalty is changed.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@ -1340,6 +1347,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="QueueMemberRinginuse"> <managerEvent language="en_US" name="QueueMemberRinginuse">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a member's ringinuse setting is changed.</synopsis> <synopsis>Raised when a member's ringinuse setting is changed.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='QueueMemberStatus']/managerEventInstance/syntax/parameter)" />
@ -1351,6 +1359,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="QueueCallerJoin"> <managerEvent language="en_US" name="QueueCallerJoin">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a caller joins a Queue.</synopsis> <synopsis>Raised when a caller joins a Queue.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -1370,6 +1379,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="QueueCallerLeave"> <managerEvent language="en_US" name="QueueCallerLeave">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a caller leaves a Queue.</synopsis> <synopsis>Raised when a caller leaves a Queue.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -1384,6 +1394,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="QueueCallerAbandon"> <managerEvent language="en_US" name="QueueCallerAbandon">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a caller abandons the queue.</synopsis> <synopsis>Raised when a caller abandons the queue.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -1400,6 +1411,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AgentCalled"> <managerEvent language="en_US" name="AgentCalled">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when an queue member is notified of a caller in the queue.</synopsis> <synopsis>Raised when an queue member is notified of a caller in the queue.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -1417,6 +1429,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AgentRingNoAnswer"> <managerEvent language="en_US" name="AgentRingNoAnswer">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a queue member is notified of a caller in the queue and fails to answer.</synopsis> <synopsis>Raised when a queue member is notified of a caller in the queue and fails to answer.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -1435,6 +1448,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AgentComplete"> <managerEvent language="en_US" name="AgentComplete">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a queue member has finished servicing a caller in the queue.</synopsis> <synopsis>Raised when a queue member has finished servicing a caller in the queue.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -1462,6 +1476,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AgentDump"> <managerEvent language="en_US" name="AgentDump">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a queue member hangs up on a caller in the queue.</synopsis> <synopsis>Raised when a queue member hangs up on a caller in the queue.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -1478,6 +1493,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AgentConnect"> <managerEvent language="en_US" name="AgentConnect">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when a queue member answers and is bridged to a caller in the queue.</synopsis> <synopsis>Raised when a queue member answers and is bridged to a caller in the queue.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>

1
apps/app_stack.c
Unescape View File

@ -205,6 +205,7 @@
</agi> </agi>
<managerEvent language="en_US" name="VarSet"> <managerEvent language="en_US" name="VarSet">
<managerEventInstance class="EVENT_FLAG_DIALPLAN"> <managerEventInstance class="EVENT_FLAG_DIALPLAN">
<since><version>12.0.0</version></since>
<synopsis>Raised when a variable local to the gosub stack frame is set due to a subroutine call.</synopsis> <synopsis>Raised when a variable local to the gosub stack frame is set due to a subroutine call.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>

1
apps/app_voicemail.c
Unescape View File

@ -573,6 +573,7 @@
</manager> </manager>
<managerEvent language="en_US" name="VoicemailPasswordChange"> <managerEvent language="en_US" name="VoicemailPasswordChange">
<managerEventInstance class="EVENT_FLAG_USER"> <managerEventInstance class="EVENT_FLAG_USER">
<since><version>18.21.0</version><version>20.6.0</version><version>21.1.0</version></since>
<synopsis>Raised in response to a mailbox password change.</synopsis> <synopsis>Raised in response to a mailbox password change.</synopsis>
<syntax> <syntax>
<parameter name="Context"> <parameter name="Context">

9
apps/confbridge/confbridge_manager.c
Unescape View File

@ -39,6 +39,7 @@
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="ConfbridgeStart"> <managerEvent language="en_US" name="ConfbridgeStart">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a conference starts.</synopsis> <synopsis>Raised when a conference starts.</synopsis>
<syntax> <syntax>
<parameter name="Conference"> <parameter name="Conference">
@ -54,6 +55,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ConfbridgeEnd"> <managerEvent language="en_US" name="ConfbridgeEnd">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a conference ends.</synopsis> <synopsis>Raised when a conference ends.</synopsis>
<syntax> <syntax>
<parameter name="Conference"> <parameter name="Conference">
@ -69,6 +71,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ConfbridgeJoin"> <managerEvent language="en_US" name="ConfbridgeJoin">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel joins a Confbridge conference.</synopsis> <synopsis>Raised when a channel joins a Confbridge conference.</synopsis>
<syntax> <syntax>
<parameter name="Conference"> <parameter name="Conference">
@ -99,6 +102,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ConfbridgeLeave"> <managerEvent language="en_US" name="ConfbridgeLeave">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel leaves a Confbridge conference.</synopsis> <synopsis>Raised when a channel leaves a Confbridge conference.</synopsis>
<syntax> <syntax>
<parameter name="Conference"> <parameter name="Conference">
@ -122,6 +126,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ConfbridgeRecord"> <managerEvent language="en_US" name="ConfbridgeRecord">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a conference starts recording.</synopsis> <synopsis>Raised when a conference starts recording.</synopsis>
<syntax> <syntax>
<parameter name="Conference"> <parameter name="Conference">
@ -137,6 +142,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ConfbridgeStopRecord"> <managerEvent language="en_US" name="ConfbridgeStopRecord">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a conference that was recording stops recording.</synopsis> <synopsis>Raised when a conference that was recording stops recording.</synopsis>
<syntax> <syntax>
<parameter name="Conference"> <parameter name="Conference">
@ -152,6 +158,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ConfbridgeMute"> <managerEvent language="en_US" name="ConfbridgeMute">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a Confbridge participant mutes.</synopsis> <synopsis>Raised when a Confbridge participant mutes.</synopsis>
<syntax> <syntax>
<parameter name="Conference"> <parameter name="Conference">
@ -175,6 +182,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ConfbridgeUnmute"> <managerEvent language="en_US" name="ConfbridgeUnmute">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a confbridge participant unmutes.</synopsis> <synopsis>Raised when a confbridge participant unmutes.</synopsis>
<syntax> <syntax>
<parameter name="Conference"> <parameter name="Conference">
@ -198,6 +206,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ConfbridgeTalking"> <managerEvent language="en_US" name="ConfbridgeTalking">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a confbridge participant begins or ends talking.</synopsis> <synopsis>Raised when a confbridge participant begins or ends talking.</synopsis>
<syntax> <syntax>
<parameter name="Conference"> <parameter name="Conference">

2
build_tools/get_documentation
Unescape View File

@ -1,3 +1,3 @@
/\/\*\*\* DOCUMENTATION/ {printit=1; next} /\/\*\*\* DOCUMENTATION/ {printit=1; next}
/\*\*\*\// {if (printit) exit} /\*\*\*\// {if (printit) printit=0}
{if (printit) print} {if (printit) print}

1
cdr/cdr_manager.c
Unescape View File

@ -41,6 +41,7 @@
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="Cdr"> <managerEvent language="en_US" name="Cdr">
<managerEventInstance class="EVENT_FLAG_CDR"> <managerEventInstance class="EVENT_FLAG_CDR">
<since><version>13.2.0</version></since>
<synopsis>Raised when a CDR is generated.</synopsis> <synopsis>Raised when a CDR is generated.</synopsis>
<syntax> <syntax>
<parameter name="AccountCode"> <parameter name="AccountCode">

1
cel/cel_manager.c
Unescape View File

@ -36,6 +36,7 @@
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="CEL"> <managerEvent language="en_US" name="CEL">
<managerEventInstance class="EVENT_FLAG_CEL"> <managerEventInstance class="EVENT_FLAG_CEL">
<since><version>13.2.0</version></since>
<synopsis>Raised when a Channel Event Log is generated for a channel.</synopsis> <synopsis>Raised when a Channel Event Log is generated for a channel.</synopsis>
<syntax> <syntax>
<parameter name="EventName"> <parameter name="EventName">

6
channels/chan_dahdi.c
Unescape View File

@ -556,6 +556,7 @@
</manager> </manager>
<managerEvent language="en_US" name="AlarmClear"> <managerEvent language="en_US" name="AlarmClear">
<managerEventInstance class="EVENT_FLAG_SYSTEM"> <managerEventInstance class="EVENT_FLAG_SYSTEM">
<since><version>12.0.0</version></since>
<synopsis>Raised when an alarm is cleared on a DAHDI channel.</synopsis> <synopsis>Raised when an alarm is cleared on a DAHDI channel.</synopsis>
<syntax> <syntax>
<parameter name="DAHDIChannel"> <parameter name="DAHDIChannel">
@ -567,6 +568,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="SpanAlarmClear"> <managerEvent language="en_US" name="SpanAlarmClear">
<managerEventInstance class="EVENT_FLAG_SYSTEM"> <managerEventInstance class="EVENT_FLAG_SYSTEM">
<since><version>12.0.0</version></since>
<synopsis>Raised when an alarm is cleared on a DAHDI span.</synopsis> <synopsis>Raised when an alarm is cleared on a DAHDI span.</synopsis>
<syntax> <syntax>
<parameter name="Span"> <parameter name="Span">
@ -577,6 +579,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="DNDState"> <managerEvent language="en_US" name="DNDState">
<managerEventInstance class="EVENT_FLAG_SYSTEM"> <managerEventInstance class="EVENT_FLAG_SYSTEM">
<since><version>12.0.0</version></since>
<synopsis>Raised when the Do Not Disturb state is changed on a DAHDI channel.</synopsis> <synopsis>Raised when the Do Not Disturb state is changed on a DAHDI channel.</synopsis>
<syntax> <syntax>
<parameter name="DAHDIChannel"> <parameter name="DAHDIChannel">
@ -594,6 +597,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="Alarm"> <managerEvent language="en_US" name="Alarm">
<managerEventInstance class="EVENT_FLAG_SYSTEM"> <managerEventInstance class="EVENT_FLAG_SYSTEM">
<since><version>12.0.0</version></since>
<synopsis>Raised when an alarm is set on a DAHDI channel.</synopsis> <synopsis>Raised when an alarm is set on a DAHDI channel.</synopsis>
<syntax> <syntax>
<parameter name="DAHDIChannel"> <parameter name="DAHDIChannel">
@ -608,6 +612,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="SpanAlarm"> <managerEvent language="en_US" name="SpanAlarm">
<managerEventInstance class="EVENT_FLAG_SYSTEM"> <managerEventInstance class="EVENT_FLAG_SYSTEM">
<since><version>12.0.0</version></since>
<synopsis>Raised when an alarm is set on a DAHDI span.</synopsis> <synopsis>Raised when an alarm is set on a DAHDI span.</synopsis>
<syntax> <syntax>
<parameter name="Span"> <parameter name="Span">
@ -621,6 +626,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="DAHDIChannel"> <managerEvent language="en_US" name="DAHDIChannel">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a DAHDI channel is created or an underlying technology is associated with a DAHDI channel.</synopsis> <synopsis>Raised when a DAHDI channel is created or an underlying technology is associated with a DAHDI channel.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>

1
channels/sig_pri.c
Unescape View File

@ -29,6 +29,7 @@
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="MCID"> <managerEvent language="en_US" name="MCID">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Published when a malicious call ID request arrives.</synopsis> <synopsis>Published when a malicious call ID request arrives.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>

1
funcs/func_global.c
Unescape View File

@ -117,6 +117,7 @@
</function> </function>
<managerEvent language="en_US" name="VarSet"> <managerEvent language="en_US" name="VarSet">
<managerEventInstance class="EVENT_FLAG_DIALPLAN"> <managerEventInstance class="EVENT_FLAG_DIALPLAN">
<since><version>12.0.0</version></since>
<synopsis>Raised when a variable is shared between channels.</synopsis> <synopsis>Raised when a variable is shared between channels.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>

3
main/aoc.c
Unescape View File

@ -41,6 +41,7 @@
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="AOC-S"> <managerEvent language="en_US" name="AOC-S">
<managerEventInstance class="EVENT_FLAG_AOC"> <managerEventInstance class="EVENT_FLAG_AOC">
<since><version>12.0.0</version></since>
<synopsis>Raised when an Advice of Charge message is sent at the beginning of a call.</synopsis> <synopsis>Raised when an Advice of Charge message is sent at the beginning of a call.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -92,6 +93,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AOC-D"> <managerEvent language="en_US" name="AOC-D">
<managerEventInstance class="EVENT_FLAG_AOC"> <managerEventInstance class="EVENT_FLAG_AOC">
<since><version>12.0.0</version></since>
<synopsis>Raised when an Advice of Charge message is sent during a call.</synopsis> <synopsis>Raised when an Advice of Charge message is sent during a call.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -150,6 +152,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AOC-E"> <managerEvent language="en_US" name="AOC-E">
<managerEventInstance class="EVENT_FLAG_AOC"> <managerEventInstance class="EVENT_FLAG_AOC">
<since><version>12.0.0</version></since>
<synopsis>Raised when an Advice of Charge message is sent at the end of a call.</synopsis> <synopsis>Raised when an Advice of Charge message is sent at the end of a call.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>

2
main/asterisk.c
Unescape View File

@ -249,6 +249,7 @@ int daemon(int, int); /* defined in libresolv of all places */
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="FullyBooted"> <managerEvent language="en_US" name="FullyBooted">
<managerEventInstance class="EVENT_FLAG_SYSTEM"> <managerEventInstance class="EVENT_FLAG_SYSTEM">
<since><version>12.0.0</version></since>
<synopsis>Raised when all Asterisk initialization procedures have finished.</synopsis> <synopsis>Raised when all Asterisk initialization procedures have finished.</synopsis>
<syntax> <syntax>
<parameter name="Status"> <parameter name="Status">
@ -265,6 +266,7 @@ int daemon(int, int); /* defined in libresolv of all places */
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="Shutdown"> <managerEvent language="en_US" name="Shutdown">
<managerEventInstance class="EVENT_FLAG_SYSTEM"> <managerEventInstance class="EVENT_FLAG_SYSTEM">
<since><version>12.0.0</version></since>
<synopsis>Raised when Asterisk is shutdown or restarted.</synopsis> <synopsis>Raised when Asterisk is shutdown or restarted.</synopsis>
<syntax> <syntax>
<parameter name="Shutdown"> <parameter name="Shutdown">

1
main/channel.c
Unescape View File

@ -6763,6 +6763,7 @@ static void __ast_change_name_nolink(struct ast_channel *chan, const char *newna
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="Rename"> <managerEvent language="en_US" name="Rename">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<synopsis>Raised when the name of a channel is changed.</synopsis> <synopsis>Raised when the name of a channel is changed.</synopsis>
</managerEventInstance> </managerEventInstance>
</managerEvent> </managerEvent>

3
main/core_local.c
Unescape View File

@ -73,6 +73,7 @@
</manager> </manager>
<managerEvent language="en_US" name="LocalBridge"> <managerEvent language="en_US" name="LocalBridge">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when two halves of a Local Channel form a bridge.</synopsis> <synopsis>Raised when two halves of a Local Channel form a bridge.</synopsis>
<syntax> <syntax>
<channel_snapshot prefix="LocalOne"/> <channel_snapshot prefix="LocalOne"/>
@ -94,6 +95,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="LocalOptimizationBegin"> <managerEvent language="en_US" name="LocalOptimizationBegin">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when two halves of a Local Channel begin to optimize <synopsis>Raised when two halves of a Local Channel begin to optimize
themselves out of the media path.</synopsis> themselves out of the media path.</synopsis>
<syntax> <syntax>
@ -115,6 +117,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="LocalOptimizationEnd"> <managerEvent language="en_US" name="LocalOptimizationEnd">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when two halves of a Local Channel have finished optimizing <synopsis>Raised when two halves of a Local Channel have finished optimizing
themselves out of the media path.</synopsis> themselves out of the media path.</synopsis>
<syntax> <syntax>

1
main/devicestate.c
Unescape View File

@ -120,6 +120,7 @@
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="DeviceStateChange"> <managerEvent language="en_US" name="DeviceStateChange">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>13.0.0</version></since>
<synopsis>Raised when a device state changes</synopsis> <synopsis>Raised when a device state changes</synopsis>
<syntax> <syntax>
<parameter name="Device"> <parameter name="Device">

3
main/loader.c
Unescape View File

@ -58,6 +58,7 @@
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="Reload"> <managerEvent language="en_US" name="Reload">
<managerEventInstance class="EVENT_FLAG_SYSTEM"> <managerEventInstance class="EVENT_FLAG_SYSTEM">
<since><version>12.0.0</version></since>
<synopsis>Raised when a module has been reloaded in Asterisk.</synopsis> <synopsis>Raised when a module has been reloaded in Asterisk.</synopsis>
<syntax> <syntax>
<parameter name="Module"> <parameter name="Module">
@ -82,6 +83,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="Load"> <managerEvent language="en_US" name="Load">
<managerEventInstance class="EVENT_FLAG_SYSTEM"> <managerEventInstance class="EVENT_FLAG_SYSTEM">
<since><version>16.0.0</version></since>
<synopsis>Raised when a module has been loaded in Asterisk.</synopsis> <synopsis>Raised when a module has been loaded in Asterisk.</synopsis>
<syntax> <syntax>
<parameter name="Module"> <parameter name="Module">
@ -100,6 +102,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="Unload"> <managerEvent language="en_US" name="Unload">
<managerEventInstance class="EVENT_FLAG_SYSTEM"> <managerEventInstance class="EVENT_FLAG_SYSTEM">
<since><version>16.0.0</version></since>
<synopsis>Raised when a module has been unloaded in Asterisk.</synopsis> <synopsis>Raised when a module has been unloaded in Asterisk.</synopsis>
<syntax> <syntax>
<parameter name="Module"> <parameter name="Module">

1
main/lock.c
Unescape View File

@ -322,6 +322,7 @@ int __ast_pthread_mutex_lock(const char *filename, int lineno, const char *func,
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="DeadlockStart"> <managerEvent language="en_US" name="DeadlockStart">
<managerEventInstance class="EVENT_FLAG_SYSTEM"> <managerEventInstance class="EVENT_FLAG_SYSTEM">
<since><version>16.29.0</version><version>18.15.0</version><version>19.7.0</version></since>
<synopsis>Raised when a probable deadlock has started. <synopsis>Raised when a probable deadlock has started.
Delivery of this event is attempted but not guaranteed, Delivery of this event is attempted but not guaranteed,
and could fail for example if the manager itself is deadlocked. and could fail for example if the manager itself is deadlocked.

25
main/logger.c
Unescape View File

@ -71,9 +71,6 @@
#include "asterisk/backtrace.h" #include "asterisk/backtrace.h"
#include "asterisk/json.h" #include "asterisk/json.h"
/*** DOCUMENTATION
***/
static int logger_register_level(const char *name); static int logger_register_level(const char *name);
static int logger_unregister_level(const char *name); static int logger_unregister_level(const char *name);
static int logger_get_dynamic_level(const char *name); static int logger_get_dynamic_level(const char *name);
@ -1239,18 +1236,6 @@ static int reload_logger(int rotate, const char *altconf)
AST_RWLIST_TRAVERSE(&logchannels, f, list) { AST_RWLIST_TRAVERSE(&logchannels, f, list) {
if (f->disabled) { if (f->disabled) {
f->disabled = 0; /* Re-enable logging at reload */ f->disabled = 0; /* Re-enable logging at reload */
/*** DOCUMENTATION
<managerEvent language="en_US" name="LogChannel">
<managerEventInstance class="EVENT_FLAG_SYSTEM">
<synopsis>Raised when a logging channel is re-enabled after a reload operation.</synopsis>
<syntax>
<parameter name="Channel">
<para>The name of the logging channel.</para>
</parameter>
</syntax>
</managerEventInstance>
</managerEvent>
***/
manager_event(EVENT_FLAG_SYSTEM, "LogChannel", "Channel: %s\r\nEnabled: Yes\r\n", f->filename); manager_event(EVENT_FLAG_SYSTEM, "LogChannel", "Channel: %s\r\nEnabled: Yes\r\n", f->filename);
} }
if (f->fileptr && (f->fileptr != stdout) && (f->fileptr != stderr)) { if (f->fileptr && (f->fileptr != stdout) && (f->fileptr != stderr)) {
@ -1983,16 +1968,6 @@ static void logger_print_normal(struct logmsg *logmsg)
fprintf(stderr, "Logger Warning: Unable to write to log file '%s': %s (disabled)\n", chan->filename, strerror(errno)); fprintf(stderr, "Logger Warning: Unable to write to log file '%s': %s (disabled)\n", chan->filename, strerror(errno));
} }
/*** DOCUMENTATION
<managerEventInstance>
<synopsis>Raised when a logging channel is disabled.</synopsis>
<syntax>
<parameter name="Channel">
<para>The name of the logging channel.</para>
</parameter>
</syntax>
</managerEventInstance>
***/
manager_event(EVENT_FLAG_SYSTEM, "LogChannel", "Channel: %s\r\nEnabled: No\r\nReason: %d - %s\r\n", chan->filename, errno, strerror(errno)); manager_event(EVENT_FLAG_SYSTEM, "LogChannel", "Channel: %s\r\nEnabled: No\r\nReason: %d - %s\r\n", chan->filename, errno, strerror(errno));
chan->disabled = 1; chan->disabled = 1;
} }

20
main/logger_doc.xml
Unescape View File

@ -34,4 +34,24 @@
<ref type="application">Log</ref> <ref type="application">Log</ref>
</see-also> </see-also>
</function> </function>
<managerEvent language="en_US" name="LogChannel">
<managerEventInstance class="EVENT_FLAG_SYSTEM">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<synopsis>Raised when a logging channel is re-enabled after a reload operation.</synopsis>
<syntax>
<parameter name="Channel">
<para>The name of the logging channel.</para>
</parameter>
</syntax>
</managerEventInstance>
<managerEventInstance class="EVENT_FLAG_SYSTEM">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<synopsis>Raised when a logging channel is disabled.</synopsis>
<syntax>
<parameter name="Channel">
<para>The name of the logging channel.</para>
</parameter>
</syntax>
</managerEventInstance>
</managerEvent>
</docs> </docs>

8
main/manager_bridges.c
Unescape View File

@ -36,6 +36,7 @@ static struct stasis_message_router *bridge_state_router;
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="BridgeCreate"> <managerEvent language="en_US" name="BridgeCreate">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a bridge is created.</synopsis> <synopsis>Raised when a bridge is created.</synopsis>
<syntax> <syntax>
<bridge_snapshot/> <bridge_snapshot/>
@ -49,6 +50,7 @@ static struct stasis_message_router *bridge_state_router;
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="BridgeDestroy"> <managerEvent language="en_US" name="BridgeDestroy">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a bridge is destroyed.</synopsis> <synopsis>Raised when a bridge is destroyed.</synopsis>
<syntax> <syntax>
<bridge_snapshot/> <bridge_snapshot/>
@ -62,6 +64,7 @@ static struct stasis_message_router *bridge_state_router;
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="BridgeEnter"> <managerEvent language="en_US" name="BridgeEnter">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel enters a bridge.</synopsis> <synopsis>Raised when a channel enters a bridge.</synopsis>
<syntax> <syntax>
<bridge_snapshot/> <bridge_snapshot/>
@ -79,6 +82,7 @@ static struct stasis_message_router *bridge_state_router;
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="BridgeLeave"> <managerEvent language="en_US" name="BridgeLeave">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel leaves a bridge.</synopsis> <synopsis>Raised when a channel leaves a bridge.</synopsis>
<syntax> <syntax>
<bridge_snapshot/> <bridge_snapshot/>
@ -93,6 +97,7 @@ static struct stasis_message_router *bridge_state_router;
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="BridgeVideoSourceUpdate"> <managerEvent language="en_US" name="BridgeVideoSourceUpdate">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>13.13.0</version><version>14.2.0</version></since>
<synopsis>Raised when the channel that is the source of video in a bridge changes.</synopsis> <synopsis>Raised when the channel that is the source of video in a bridge changes.</synopsis>
<syntax> <syntax>
<bridge_snapshot/> <bridge_snapshot/>
@ -155,6 +160,7 @@ static struct stasis_message_router *bridge_state_router;
<list-elements> <list-elements>
<managerEvent language="en_US" name="BridgeInfoChannel"> <managerEvent language="en_US" name="BridgeInfoChannel">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>13.0.0</version></since>
<synopsis>Information about a channel in a bridge.</synopsis> <synopsis>Information about a channel in a bridge.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -164,6 +170,7 @@ static struct stasis_message_router *bridge_state_router;
</list-elements> </list-elements>
<managerEvent language="en_US" name="BridgeInfoComplete"> <managerEvent language="en_US" name="BridgeInfoComplete">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>13.0.0</version></since>
<synopsis>Information about a bridge.</synopsis> <synopsis>Information about a bridge.</synopsis>
<syntax> <syntax>
<bridge_snapshot/> <bridge_snapshot/>
@ -390,6 +397,7 @@ static void bridge_merge_cb(void *data, struct stasis_subscription *sub,
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="BridgeMerge"> <managerEvent language="en_US" name="BridgeMerge">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<synopsis>Raised when two bridges are merged.</synopsis> <synopsis>Raised when two bridges are merged.</synopsis>
<syntax> <syntax>
<bridge_snapshot prefix="To"/> <bridge_snapshot prefix="To"/>

28
main/manager_channels.c
Unescape View File

@ -38,6 +38,7 @@
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="Newchannel"> <managerEvent language="en_US" name="Newchannel">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a new channel is created.</synopsis> <synopsis>Raised when a new channel is created.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -50,6 +51,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="Newstate"> <managerEvent language="en_US" name="Newstate">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel's state changes.</synopsis> <synopsis>Raised when a channel's state changes.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -62,6 +64,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="Hangup"> <managerEvent language="en_US" name="Hangup">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel is hung up.</synopsis> <synopsis>Raised when a channel is hung up.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -82,6 +85,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="HangupRequest"> <managerEvent language="en_US" name="HangupRequest">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a hangup is requested.</synopsis> <synopsis>Raised when a hangup is requested.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -95,6 +99,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="SoftHangupRequest"> <managerEvent language="en_US" name="SoftHangupRequest">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a soft hangup is requested with a specific cause code.</synopsis> <synopsis>Raised when a soft hangup is requested with a specific cause code.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -108,6 +113,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="NewExten"> <managerEvent language="en_US" name="NewExten">
<managerEventInstance class="EVENT_FLAG_DIALPLAN"> <managerEventInstance class="EVENT_FLAG_DIALPLAN">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel enters a new context, extension, priority.</synopsis> <synopsis>Raised when a channel enters a new context, extension, priority.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -127,6 +133,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="NewCallerid"> <managerEvent language="en_US" name="NewCallerid">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel receives new Caller ID information.</synopsis> <synopsis>Raised when a channel receives new Caller ID information.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -141,6 +148,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="NewConnectedLine"> <managerEvent language="en_US" name="NewConnectedLine">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>13.13.0</version><version>14.2.0</version></since>
<synopsis>Raised when a channel's connected line information is changed.</synopsis> <synopsis>Raised when a channel's connected line information is changed.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -152,6 +160,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="NewAccountCode"> <managerEvent language="en_US" name="NewAccountCode">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a Channel's AccountCode is changed.</synopsis> <synopsis>Raised when a Channel's AccountCode is changed.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -166,6 +175,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="DialBegin"> <managerEvent language="en_US" name="DialBegin">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a dial action has started.</synopsis> <synopsis>Raised when a dial action has started.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -184,6 +194,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="DialState"> <managerEvent language="en_US" name="DialState">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>14.0.0</version></since>
<synopsis>Raised when dial status has changed.</synopsis> <synopsis>Raised when dial status has changed.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -211,6 +222,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="DialEnd"> <managerEvent language="en_US" name="DialEnd">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a dial action has completed.</synopsis> <synopsis>Raised when a dial action has completed.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -267,6 +279,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="Hold"> <managerEvent language="en_US" name="Hold">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel goes on hold.</synopsis> <synopsis>Raised when a channel goes on hold.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -281,6 +294,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="Unhold"> <managerEvent language="en_US" name="Unhold">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel goes off hold.</synopsis> <synopsis>Raised when a channel goes off hold.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -292,6 +306,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ChanSpyStart"> <managerEvent language="en_US" name="ChanSpyStart">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when one channel begins spying on another channel.</synopsis> <synopsis>Raised when one channel begins spying on another channel.</synopsis>
<syntax> <syntax>
<channel_snapshot prefix="Spyer"/> <channel_snapshot prefix="Spyer"/>
@ -305,6 +320,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ChanSpyStop"> <managerEvent language="en_US" name="ChanSpyStop">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel has stopped spying.</synopsis> <synopsis>Raised when a channel has stopped spying.</synopsis>
<syntax> <syntax>
<channel_snapshot prefix="Spyer"/> <channel_snapshot prefix="Spyer"/>
@ -318,6 +334,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="HangupHandlerRun"> <managerEvent language="en_US" name="HangupHandlerRun">
<managerEventInstance class="EVENT_FLAG_DIALPLAN"> <managerEventInstance class="EVENT_FLAG_DIALPLAN">
<since><version>12.0.0</version></since>
<synopsis>Raised when a hangup handler is about to be called.</synopsis> <synopsis>Raised when a hangup handler is about to be called.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -332,6 +349,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="HangupHandlerPop"> <managerEvent language="en_US" name="HangupHandlerPop">
<managerEventInstance class="EVENT_FLAG_DIALPLAN"> <managerEventInstance class="EVENT_FLAG_DIALPLAN">
<since><version>12.0.0</version></since>
<synopsis> <synopsis>
Raised when a hangup handler is removed from the handler stack Raised when a hangup handler is removed from the handler stack
by the CHANNEL() function. by the CHANNEL() function.
@ -348,6 +366,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="HangupHandlerPush"> <managerEvent language="en_US" name="HangupHandlerPush">
<managerEventInstance class="EVENT_FLAG_DIALPLAN"> <managerEventInstance class="EVENT_FLAG_DIALPLAN">
<since><version>12.0.0</version></since>
<synopsis> <synopsis>
Raised when a hangup handler is added to the handler stack by Raised when a hangup handler is added to the handler stack by
the CHANNEL() function. the CHANNEL() function.
@ -364,6 +383,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="FAXStatus"> <managerEvent language="en_US" name="FAXStatus">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis> <synopsis>
Raised periodically during a fax transmission. Raised periodically during a fax transmission.
</synopsis> </synopsis>
@ -386,6 +406,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ReceiveFAX"> <managerEvent language="en_US" name="ReceiveFAX">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis> <synopsis>
Raised when a receive fax operation has completed. Raised when a receive fax operation has completed.
</synopsis> </synopsis>
@ -414,6 +435,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="SendFAX"> <managerEvent language="en_US" name="SendFAX">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis> <synopsis>
Raised when a send fax operation has completed. Raised when a send fax operation has completed.
</synopsis> </synopsis>
@ -425,6 +447,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="MusicOnHoldStart"> <managerEvent language="en_US" name="MusicOnHoldStart">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when music on hold has started on a channel.</synopsis> <synopsis>Raised when music on hold has started on a channel.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -441,6 +464,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="MusicOnHoldStop"> <managerEvent language="en_US" name="MusicOnHoldStop">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when music on hold has stopped on a channel.</synopsis> <synopsis>Raised when music on hold has stopped on a channel.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -871,6 +895,7 @@ static void channel_dtmf_begin_cb(void *data, struct stasis_subscription *sub,
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="DTMFBegin"> <managerEvent language="en_US" name="DTMFBegin">
<managerEventInstance class="EVENT_FLAG_DTMF"> <managerEventInstance class="EVENT_FLAG_DTMF">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<synopsis>Raised when a DTMF digit has started on a channel.</synopsis> <synopsis>Raised when a DTMF digit has started on a channel.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -919,6 +944,7 @@ static void channel_dtmf_end_cb(void *data, struct stasis_subscription *sub,
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="DTMFEnd"> <managerEvent language="en_US" name="DTMFEnd">
<managerEventInstance class="EVENT_FLAG_DTMF"> <managerEventInstance class="EVENT_FLAG_DTMF">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<synopsis>Raised when a DTMF digit has ended on a channel.</synopsis> <synopsis>Raised when a DTMF digit has ended on a channel.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -964,6 +990,7 @@ static void channel_flash_cb(void *data, struct stasis_subscription *sub,
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="Flash"> <managerEvent language="en_US" name="Flash">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<synopsis>Raised when a hook flash occurs on a channel.</synopsis> <synopsis>Raised when a hook flash occurs on a channel.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -992,6 +1019,7 @@ static void channel_wink_cb(void *data, struct stasis_subscription *sub,
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="Wink"> <managerEvent language="en_US" name="Wink">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<synopsis>Raised when a wink occurs on a channel.</synopsis> <synopsis>Raised when a wink occurs on a channel.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>

8
main/manager_doc.xml
Unescape View File

@ -192,6 +192,7 @@
</manager> </manager>
<managerEvent language="en_US" name="Status"> <managerEvent language="en_US" name="Status">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>18.26.0</version><version>20.11.0</version><version>21.6.0</version><version>22.1.0</version></since>
<synopsis>Raised in response to a Status command.</synopsis> <synopsis>Raised in response to a Status command.</synopsis>
<syntax> <syntax>
<parameter name="ActionID" required="false"/> <parameter name="ActionID" required="false"/>
@ -250,6 +251,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="StatusComplete"> <managerEvent language="en_US" name="StatusComplete">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>18.26.0</version><version>20.11.0</version><version>21.6.0</version><version>22.1.0</version></since>
<synopsis>Raised in response to a Status command.</synopsis> <synopsis>Raised in response to a Status command.</synopsis>
<syntax> <syntax>
<parameter name="Items"> <parameter name="Items">
@ -702,6 +704,7 @@
</manager> </manager>
<managerEvent language="en_US" name="OriginateResponse"> <managerEvent language="en_US" name="OriginateResponse">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>18.26.0</version><version>20.11.0</version><version>21.6.0</version><version>22.1.0</version></since>
<synopsis>Raised in response to an Originate command.</synopsis> <synopsis>Raised in response to an Originate command.</synopsis>
<syntax> <syntax>
<parameter name="ActionID" required="false"/> <parameter name="ActionID" required="false"/>
@ -1001,6 +1004,7 @@
</manager> </manager>
<managerEvent language="en_US" name="CoreShowChannel"> <managerEvent language="en_US" name="CoreShowChannel">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>18.26.0</version><version>20.11.0</version><version>21.6.0</version><version>22.1.0</version></since>
<synopsis>Raised in response to a CoreShowChannels command.</synopsis> <synopsis>Raised in response to a CoreShowChannels command.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" /> <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
@ -1026,6 +1030,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="CoreShowChannelsComplete"> <managerEvent language="en_US" name="CoreShowChannelsComplete">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>18.26.0</version><version>20.11.0</version><version>21.6.0</version><version>22.1.0</version></since>
<synopsis>Raised at the end of the CoreShowChannel list produced by the CoreShowChannels command.</synopsis> <synopsis>Raised at the end of the CoreShowChannel list produced by the CoreShowChannels command.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" /> <xi:include xpointer="xpointer(/docs/manager[@name='Login']/syntax/parameter[@name='ActionID'])" />
@ -1064,6 +1069,7 @@
</manager> </manager>
<managerEvent language="en_US" name="CoreShowChannelMapComplete"> <managerEvent language="en_US" name="CoreShowChannelMapComplete">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>18.26.0</version><version>20.11.0</version><version>21.6.0</version><version>22.1.0</version></since>
<synopsis>Raised at the end of the CoreShowChannelMap list produced by the CoreShowChannelMap command.</synopsis> <synopsis>Raised at the end of the CoreShowChannelMap list produced by the CoreShowChannelMap command.</synopsis>
<syntax> <syntax>
<parameter name="EventList"> <parameter name="EventList">
@ -1576,6 +1582,7 @@
</manager> </manager>
<managerEvent name="ExtensionStatus" language="en_US"> <managerEvent name="ExtensionStatus" language="en_US">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>18.26.0</version><version>20.11.0</version><version>21.6.0</version><version>22.1.0</version></since>
<synopsis>Raised when a hint changes due to a device state change.</synopsis> <synopsis>Raised when a hint changes due to a device state change.</synopsis>
<syntax> <syntax>
<parameter name="Exten"> <parameter name="Exten">
@ -1656,6 +1663,7 @@
</managerEvent> </managerEvent>
<managerEvent name="PresenceStatus" language="en_US"> <managerEvent name="PresenceStatus" language="en_US">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>18.26.0</version><version>20.11.0</version><version>21.6.0</version><version>22.1.0</version></since>
<synopsis>Raised when a hint changes due to a presence state change.</synopsis> <synopsis>Raised when a hint changes due to a presence state change.</synopsis>
<syntax> <syntax>
<parameter name="Exten" /> <parameter name="Exten" />

1
main/manager_mwi.c
Unescape View File

@ -105,6 +105,7 @@ static void mwi_update_cb(void *data, struct stasis_subscription *sub,
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="MessageWaiting"> <managerEvent language="en_US" name="MessageWaiting">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>16.24.0</version><version>18.10.0</version><version>19.2.0</version></since>
<synopsis>Raised when the state of messages in a voicemail mailbox <synopsis>Raised when the state of messages in a voicemail mailbox
has changed or when a channel has finished interacting with a has changed or when a channel has finished interacting with a
mailbox.</synopsis> mailbox.</synopsis>

1
main/pbx.c
Unescape View File

@ -199,6 +199,7 @@
</list-elements> </list-elements>
<managerEvent name="ExtensionStateListComplete" language="en_US"> <managerEvent name="ExtensionStateListComplete" language="en_US">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>13.0.0</version></since>
<synopsis> <synopsis>
Indicates the end of the list the current known extension states. Indicates the end of the list the current known extension states.
</synopsis> </synopsis>

1
main/pickup.c
Unescape View File

@ -36,6 +36,7 @@
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="Pickup"> <managerEvent language="en_US" name="Pickup">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a call pickup occurs.</synopsis> <synopsis>Raised when a call pickup occurs.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>

1
main/presencestate.c
Unescape View File

@ -28,6 +28,7 @@
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="PresenceStateChange"> <managerEvent language="en_US" name="PresenceStateChange">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>13.0.0</version></since>
<synopsis>Raised when a presence state changes</synopsis> <synopsis>Raised when a presence state changes</synopsis>
<syntax> <syntax>
<parameter name="Presentity"> <parameter name="Presentity">

2
main/rtp_engine.c
Unescape View File

@ -30,6 +30,7 @@
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="RTCPSent"> <managerEvent language="en_US" name="RTCPSent">
<managerEventInstance class="EVENT_FLAG_REPORTING"> <managerEventInstance class="EVENT_FLAG_REPORTING">
<since><version>12.0.0</version></since>
<synopsis>Raised when an RTCP packet is sent.</synopsis> <synopsis>Raised when an RTCP packet is sent.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -109,6 +110,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="RTCPReceived"> <managerEvent language="en_US" name="RTCPReceived">
<managerEventInstance class="EVENT_FLAG_REPORTING"> <managerEventInstance class="EVENT_FLAG_REPORTING">
<since><version>12.0.0</version></since>
<synopsis>Raised when an RTCP packet is received.</synopsis> <synopsis>Raised when an RTCP packet is received.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>

15
main/security_events.c
Unescape View File

@ -31,6 +31,7 @@
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="FailedACL"> <managerEvent language="en_US" name="FailedACL">
<managerEventInstance class="EVENT_FLAG_SECURITY"> <managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request violates an ACL check.</synopsis> <synopsis>Raised when a request violates an ACL check.</synopsis>
<syntax> <syntax>
<parameter name="EventTV"> <parameter name="EventTV">
@ -79,6 +80,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="InvalidAccountID"> <managerEvent language="en_US" name="InvalidAccountID">
<managerEventInstance class="EVENT_FLAG_SECURITY"> <managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request fails an authentication check due to an invalid account ID.</synopsis> <synopsis>Raised when a request fails an authentication check due to an invalid account ID.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@ -96,6 +98,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="SessionLimit"> <managerEvent language="en_US" name="SessionLimit">
<managerEventInstance class="EVENT_FLAG_SECURITY"> <managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request fails due to exceeding the number of allowed concurrent sessions for that service.</synopsis> <synopsis>Raised when a request fails due to exceeding the number of allowed concurrent sessions for that service.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@ -113,6 +116,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="MemoryLimit"> <managerEvent language="en_US" name="MemoryLimit">
<managerEventInstance class="EVENT_FLAG_SECURITY"> <managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request fails due to an internal memory allocation failure.</synopsis> <synopsis>Raised when a request fails due to an internal memory allocation failure.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@ -130,6 +134,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="LoadAverageLimit"> <managerEvent language="en_US" name="LoadAverageLimit">
<managerEventInstance class="EVENT_FLAG_SECURITY"> <managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request fails because a configured load average limit has been reached.</synopsis> <synopsis>Raised when a request fails because a configured load average limit has been reached.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@ -147,6 +152,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="RequestNotSupported"> <managerEvent language="en_US" name="RequestNotSupported">
<managerEventInstance class="EVENT_FLAG_SECURITY"> <managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request fails due to some aspect of the requested item not being supported by the service.</synopsis> <synopsis>Raised when a request fails due to some aspect of the requested item not being supported by the service.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@ -167,6 +173,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="RequestNotAllowed"> <managerEvent language="en_US" name="RequestNotAllowed">
<managerEventInstance class="EVENT_FLAG_SECURITY"> <managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request is not allowed by the service.</synopsis> <synopsis>Raised when a request is not allowed by the service.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@ -188,6 +195,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AuthMethodNotAllowed"> <managerEvent language="en_US" name="AuthMethodNotAllowed">
<managerEventInstance class="EVENT_FLAG_SECURITY"> <managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request used an authentication method not allowed by the service.</synopsis> <synopsis>Raised when a request used an authentication method not allowed by the service.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@ -208,6 +216,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="RequestBadFormat"> <managerEvent language="en_US" name="RequestBadFormat">
<managerEventInstance class="EVENT_FLAG_SECURITY"> <managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request is received with bad formatting.</synopsis> <synopsis>Raised when a request is received with bad formatting.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@ -230,6 +239,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="SuccessfulAuth"> <managerEvent language="en_US" name="SuccessfulAuth">
<managerEventInstance class="EVENT_FLAG_SECURITY"> <managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request successfully authenticates with a service.</synopsis> <synopsis>Raised when a request successfully authenticates with a service.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@ -250,6 +260,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="UnexpectedAddress"> <managerEvent language="en_US" name="UnexpectedAddress">
<managerEventInstance class="EVENT_FLAG_SECURITY"> <managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request has a different source address then what is expected for a session already in progress with a service.</synopsis> <synopsis>Raised when a request has a different source address then what is expected for a session already in progress with a service.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@ -270,6 +281,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ChallengeResponseFailed"> <managerEvent language="en_US" name="ChallengeResponseFailed">
<managerEventInstance class="EVENT_FLAG_SECURITY"> <managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request's attempt to authenticate has been challenged, and the request failed the authentication challenge.</synopsis> <synopsis>Raised when a request's attempt to authenticate has been challenged, and the request failed the authentication challenge.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@ -296,6 +308,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="InvalidPassword"> <managerEvent language="en_US" name="InvalidPassword">
<managerEventInstance class="EVENT_FLAG_SECURITY"> <managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request provides an invalid password during an authentication attempt.</synopsis> <synopsis>Raised when a request provides an invalid password during an authentication attempt.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@ -322,6 +335,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ChallengeSent"> <managerEvent language="en_US" name="ChallengeSent">
<managerEventInstance class="EVENT_FLAG_SECURITY"> <managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when an Asterisk service sends an authentication challenge to a request.</synopsis> <synopsis>Raised when an Asterisk service sends an authentication challenge to a request.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />
@ -340,6 +354,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="InvalidTransport"> <managerEvent language="en_US" name="InvalidTransport">
<managerEventInstance class="EVENT_FLAG_SECURITY"> <managerEventInstance class="EVENT_FLAG_SECURITY">
<since><version>12.1.0</version></since>
<synopsis>Raised when a request attempts to use a transport not allowed by the Asterisk service.</synopsis> <synopsis>Raised when a request attempts to use a transport not allowed by the Asterisk service.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='FailedACL']/managerEventInstance/syntax/parameter[@name='EventTV'])" />

1
main/stasis.c
Unescape View File

@ -46,6 +46,7 @@
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="UserEvent"> <managerEvent language="en_US" name="UserEvent">
<managerEventInstance class="EVENT_FLAG_USER"> <managerEventInstance class="EVENT_FLAG_USER">
<since><version>12.3.0</version></since>
<synopsis>A user defined event raised from the dialplan.</synopsis> <synopsis>A user defined event raised from the dialplan.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>

2
main/stasis_bridges.c
Unescape View File

@ -46,6 +46,7 @@
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="BlindTransfer"> <managerEvent language="en_US" name="BlindTransfer">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a blind transfer is complete.</synopsis> <synopsis>Raised when a blind transfer is complete.</synopsis>
<syntax> <syntax>
<parameter name="Result"> <parameter name="Result">
@ -84,6 +85,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AttendedTransfer"> <managerEvent language="en_US" name="AttendedTransfer">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when an attended transfer is complete.</synopsis> <synopsis>Raised when an attended transfer is complete.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(docs/managerEvent[@name='BlindTransfer']/managerEventInstance/syntax/parameter[@name='Result'])" /> <xi:include xpointer="xpointer(docs/managerEvent[@name='BlindTransfer']/managerEventInstance/syntax/parameter[@name='Result'])" />

5
main/stasis_channels.c
Unescape View File

@ -44,6 +44,7 @@
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="VarSet"> <managerEvent language="en_US" name="VarSet">
<managerEventInstance class="EVENT_FLAG_DIALPLAN"> <managerEventInstance class="EVENT_FLAG_DIALPLAN">
<since><version>12.0.0</version></since>
<synopsis>Raised when a variable is set to a particular value.</synopsis> <synopsis>Raised when a variable is set to a particular value.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -58,6 +59,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AgentLogin"> <managerEvent language="en_US" name="AgentLogin">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when an Agent has logged in.</synopsis> <synopsis>Raised when an Agent has logged in.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -73,6 +75,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AgentLogoff"> <managerEvent language="en_US" name="AgentLogoff">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<since><version>12.0.0</version></since>
<synopsis>Raised when an Agent has logged off.</synopsis> <synopsis>Raised when an Agent has logged off.</synopsis>
<syntax> <syntax>
<xi:include xpointer="xpointer(/docs/managerEvent[@name='AgentLogin']/managerEventInstance/syntax/parameter)" /> <xi:include xpointer="xpointer(/docs/managerEvent[@name='AgentLogin']/managerEventInstance/syntax/parameter)" />
@ -87,6 +90,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ChannelTalkingStart"> <managerEvent language="en_US" name="ChannelTalkingStart">
<managerEventInstance class="EVENT_FLAG_CLASS"> <managerEventInstance class="EVENT_FLAG_CLASS">
<since><version>12.4.0</version></since>
<synopsis>Raised when talking is detected on a channel.</synopsis> <synopsis>Raised when talking is detected on a channel.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -99,6 +103,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ChannelTalkingStop"> <managerEvent language="en_US" name="ChannelTalkingStop">
<managerEventInstance class="EVENT_FLAG_CLASS"> <managerEventInstance class="EVENT_FLAG_CLASS">
<since><version>12.4.0</version></since>
<synopsis>Raised when talking is no longer detected on a channel.</synopsis> <synopsis>Raised when talking is no longer detected on a channel.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>

2
main/stasis_endpoints.c
Unescape View File

@ -36,6 +36,7 @@
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="PeerStatus"> <managerEvent language="en_US" name="PeerStatus">
<managerEventInstance class="EVENT_FLAG_SYSTEM"> <managerEventInstance class="EVENT_FLAG_SYSTEM">
<since><version>12.0.0</version></since>
<synopsis>Raised when the state of a peer changes.</synopsis> <synopsis>Raised when the state of a peer changes.</synopsis>
<syntax> <syntax>
<parameter name="ChannelType"> <parameter name="ChannelType">
@ -71,6 +72,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ContactStatus"> <managerEvent language="en_US" name="ContactStatus">
<managerEventInstance class="EVENT_FLAG_SYSTEM"> <managerEventInstance class="EVENT_FLAG_SYSTEM">
<since><version>13.5.0</version></since>
<synopsis>Raised when the state of a contact changes.</synopsis> <synopsis>Raised when the state of a contact changes.</synopsis>
<syntax> <syntax>
<parameter name="URI"> <parameter name="URI">

1
main/stasis_system.c
Unescape View File

@ -36,6 +36,7 @@
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEvent language="en_US" name="Registry"> <managerEvent language="en_US" name="Registry">
<managerEventInstance class="EVENT_FLAG_SYSTEM"> <managerEventInstance class="EVENT_FLAG_SYSTEM">
<since><version>12.0.0</version></since>
<synopsis>Raised when an outbound registration completes.</synopsis> <synopsis>Raised when an outbound registration completes.</synopsis>
<syntax> <syntax>
<parameter name="ChannelType"> <parameter name="ChannelType">

5
res/parking/parking_manager.c
Unescape View File

@ -116,6 +116,7 @@
</manager> </manager>
<managerEvent language="en_US" name="ParkedCall"> <managerEvent language="en_US" name="ParkedCall">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel is parked.</synopsis> <synopsis>Raised when a channel is parked.</synopsis>
<syntax> <syntax>
<channel_snapshot prefix="Parkee"/> <channel_snapshot prefix="Parkee"/>
@ -139,6 +140,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ParkedCallTimeOut"> <managerEvent language="en_US" name="ParkedCallTimeOut">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel leaves a parking lot due to reaching the time limit of being parked.</synopsis> <synopsis>Raised when a channel leaves a parking lot due to reaching the time limit of being parked.</synopsis>
<syntax> <syntax>
<channel_snapshot prefix="Parkee"/> <channel_snapshot prefix="Parkee"/>
@ -149,6 +151,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ParkedCallGiveUp"> <managerEvent language="en_US" name="ParkedCallGiveUp">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel leaves a parking lot because it hung up without being answered.</synopsis> <synopsis>Raised when a channel leaves a parking lot because it hung up without being answered.</synopsis>
<syntax> <syntax>
<channel_snapshot prefix="Parkee"/> <channel_snapshot prefix="Parkee"/>
@ -159,6 +162,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="UnParkedCall"> <managerEvent language="en_US" name="UnParkedCall">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel leaves a parking lot because it was retrieved from the parking lot and reconnected.</synopsis> <synopsis>Raised when a channel leaves a parking lot because it was retrieved from the parking lot and reconnected.</synopsis>
<syntax> <syntax>
<channel_snapshot prefix="Parkee"/> <channel_snapshot prefix="Parkee"/>
@ -170,6 +174,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ParkedCallSwap"> <managerEvent language="en_US" name="ParkedCallSwap">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>13.5.0</version></since>
<synopsis>Raised when a channel takes the place of a previously parked channel</synopsis> <synopsis>Raised when a channel takes the place of a previously parked channel</synopsis>
<syntax> <syntax>
<channel_snapshot prefix="Parkee"/> <channel_snapshot prefix="Parkee"/>

5
res/res_agi.c
Unescape View File

@ -1295,6 +1295,7 @@
</manager> </manager>
<managerEvent language="en_US" name="AsyncAGIStart"> <managerEvent language="en_US" name="AsyncAGIStart">
<managerEventInstance class="EVENT_FLAG_AGI"> <managerEventInstance class="EVENT_FLAG_AGI">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel starts AsyncAGI command processing.</synopsis> <synopsis>Raised when a channel starts AsyncAGI command processing.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -1312,6 +1313,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AsyncAGIEnd"> <managerEvent language="en_US" name="AsyncAGIEnd">
<managerEventInstance class="EVENT_FLAG_AGI"> <managerEventInstance class="EVENT_FLAG_AGI">
<since><version>12.0.0</version></since>
<synopsis>Raised when a channel stops AsyncAGI command processing.</synopsis> <synopsis>Raised when a channel stops AsyncAGI command processing.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -1326,6 +1328,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AsyncAGIExec"> <managerEvent language="en_US" name="AsyncAGIExec">
<managerEventInstance class="EVENT_FLAG_AGI"> <managerEventInstance class="EVENT_FLAG_AGI">
<since><version>12.0.0</version></since>
<synopsis>Raised when AsyncAGI completes an AGI command.</synopsis> <synopsis>Raised when AsyncAGI completes an AGI command.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -1346,6 +1349,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AGIExecStart"> <managerEvent language="en_US" name="AGIExecStart">
<managerEventInstance class="EVENT_FLAG_AGI"> <managerEventInstance class="EVENT_FLAG_AGI">
<since><version>12.0.0</version></since>
<synopsis>Raised when a received AGI command starts processing.</synopsis> <synopsis>Raised when a received AGI command starts processing.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>
@ -1364,6 +1368,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AGIExecEnd"> <managerEvent language="en_US" name="AGIExecEnd">
<managerEventInstance class="EVENT_FLAG_AGI"> <managerEventInstance class="EVENT_FLAG_AGI">
<since><version>12.0.0</version></since>
<synopsis>Raised when a received AGI command completes processing.</synopsis> <synopsis>Raised when a received AGI command completes processing.</synopsis>
<syntax> <syntax>
<channel_snapshot/> <channel_snapshot/>

4
res/res_fax.c
Unescape View File

@ -258,6 +258,7 @@
</manager> </manager>
<managerEvent language="en_US" name="FAXSessionsEntry"> <managerEvent language="en_US" name="FAXSessionsEntry">
<managerEventInstance class="EVENT_FLAG_REPORTING"> <managerEventInstance class="EVENT_FLAG_REPORTING">
<since><version>13.0.0</version></since>
<synopsis>A single list item for the FAXSessions AMI command</synopsis> <synopsis>A single list item for the FAXSessions AMI command</synopsis>
<syntax> <syntax>
<parameter name="ActionID" required="false"/> <parameter name="ActionID" required="false"/>
@ -308,6 +309,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="FAXSessionsComplete"> <managerEvent language="en_US" name="FAXSessionsComplete">
<managerEventInstance class="EVENT_FLAG_CALL"> <managerEventInstance class="EVENT_FLAG_CALL">
<since><version>13.0.0</version></since>
<synopsis>Raised when all FAXSession events are completed for a FAXSessions command</synopsis> <synopsis>Raised when all FAXSession events are completed for a FAXSessions command</synopsis>
<syntax> <syntax>
<parameter name="ActionID" required="false"/> <parameter name="ActionID" required="false"/>
@ -339,6 +341,7 @@
</manager> </manager>
<managerEvent language="en_US" name="FAXSession"> <managerEvent language="en_US" name="FAXSession">
<managerEventInstance class="EVENT_FLAG_REPORTING"> <managerEventInstance class="EVENT_FLAG_REPORTING">
<since><version>13.0.0</version></since>
<synopsis>Raised in response to FAXSession manager command</synopsis> <synopsis>Raised in response to FAXSession manager command</synopsis>
<syntax> <syntax>
<parameter name="ActionID" required="false"/> <parameter name="ActionID" required="false"/>
@ -407,6 +410,7 @@
</manager> </manager>
<managerEvent language="en_US" name="FAXStats"> <managerEvent language="en_US" name="FAXStats">
<managerEventInstance class="EVENT_FLAG_REPORTING"> <managerEventInstance class="EVENT_FLAG_REPORTING">
<since><version>13.0.0</version></since>
<synopsis>Raised in response to FAXStats manager command</synopsis> <synopsis>Raised in response to FAXStats manager command</synopsis>
<syntax> <syntax>
<parameter name="ActionID" required="false"/> <parameter name="ActionID" required="false"/>

1
res/res_manager_devicestate.c
Unescape View File

@ -47,6 +47,7 @@
</list-elements> </list-elements>
<managerEvent name="DeviceStateListComplete" language="en_US"> <managerEvent name="DeviceStateListComplete" language="en_US">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>13.0.0</version></since>
<synopsis> <synopsis>
Indicates the end of the list the current known extension states. Indicates the end of the list the current known extension states.
</synopsis> </synopsis>

1
res/res_manager_presencestate.c
Unescape View File

@ -48,6 +48,7 @@
</list-elements> </list-elements>
<managerEvent name="PresenceStateListComplete" language="en_US"> <managerEvent name="PresenceStateListComplete" language="en_US">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>13.0.0</version></since>
<synopsis> <synopsis>
Indicates the end of the list the current known extension states. Indicates the end of the list the current known extension states.
</synopsis> </synopsis>

2
res/res_mwi_external_ami.c
Unescape View File

@ -54,6 +54,7 @@
</manager> </manager>
<managerEvent language="en_US" name="MWIGet"> <managerEvent language="en_US" name="MWIGet">
<managerEventInstance class="EVENT_FLAG_REPORTING"> <managerEventInstance class="EVENT_FLAG_REPORTING">
<since><version>12.1.0</version></since>
<synopsis> <synopsis>
Raised in response to a MWIGet command. Raised in response to a MWIGet command.
</synopsis> </synopsis>
@ -76,6 +77,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="MWIGetComplete"> <managerEvent language="en_US" name="MWIGetComplete">
<managerEventInstance class="EVENT_FLAG_REPORTING"> <managerEventInstance class="EVENT_FLAG_REPORTING">
<since><version>12.1.0</version></since>
<synopsis> <synopsis>
Raised in response to a MWIGet command. Raised in response to a MWIGet command.
</synopsis> </synopsis>

15
res/res_pjsip/pjsip_manager.xml
Unescape View File

@ -21,6 +21,7 @@
</manager> </manager>
<managerEvent language="en_US" name="IdentifyDetail"> <managerEvent language="en_US" name="IdentifyDetail">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>13.20.0</version><version>15.3.0</version></since>
<synopsis>Provide details about an identify section.</synopsis> <synopsis>Provide details about an identify section.</synopsis>
<syntax> <syntax>
<parameter name="ObjectType"> <parameter name="ObjectType">
@ -49,6 +50,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AorDetail"> <managerEvent language="en_US" name="AorDetail">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>13.12.0</version><version>14.1.0</version></since>
<synopsis>Provide details about an Address of Record (AoR) section.</synopsis> <synopsis>Provide details about an Address of Record (AoR) section.</synopsis>
<syntax> <syntax>
<parameter name="ObjectType"> <parameter name="ObjectType">
@ -104,6 +106,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AuthDetail"> <managerEvent language="en_US" name="AuthDetail">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>12.0.0</version></since>
<synopsis>Provide details about an authentication section.</synopsis> <synopsis>Provide details about an authentication section.</synopsis>
<syntax> <syntax>
<parameter name="ObjectType"> <parameter name="ObjectType">
@ -138,6 +141,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="TransportDetail"> <managerEvent language="en_US" name="TransportDetail">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>12.6.0</version></since>
<synopsis>Provide details about an authentication section.</synopsis> <synopsis>Provide details about an authentication section.</synopsis>
<syntax> <syntax>
<parameter name="ObjectType"> <parameter name="ObjectType">
@ -217,6 +221,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="EndpointDetail"> <managerEvent language="en_US" name="EndpointDetail">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>12.0.0</version></since>
<synopsis>Provide details about an endpoint section.</synopsis> <synopsis>Provide details about an endpoint section.</synopsis>
<syntax> <syntax>
<parameter name="ObjectType"> <parameter name="ObjectType">
@ -518,6 +523,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AorList"> <managerEvent language="en_US" name="AorList">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>16.0.0</version></since>
<synopsis>Provide details about an Address of Record (AoR) section.</synopsis> <synopsis>Provide details about an Address of Record (AoR) section.</synopsis>
<syntax> <syntax>
<parameter name="ObjectType"> <parameter name="ObjectType">
@ -564,6 +570,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="AuthList"> <managerEvent language="en_US" name="AuthList">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>16.0.0</version></since>
<synopsis>Provide details about an Address of Record (Auth) section.</synopsis> <synopsis>Provide details about an Address of Record (Auth) section.</synopsis>
<syntax> <syntax>
<parameter name="ObjectType"> <parameter name="ObjectType">
@ -595,6 +602,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ContactList"> <managerEvent language="en_US" name="ContactList">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>16.0.0</version></since>
<synopsis>Provide details about a contact section.</synopsis> <synopsis>Provide details about a contact section.</synopsis>
<syntax> <syntax>
<parameter name="ObjectType"> <parameter name="ObjectType">
@ -666,6 +674,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="ContactStatusDetail"> <managerEvent language="en_US" name="ContactStatusDetail">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>13.0.0</version></since>
<synopsis>Provide details about a contact's status.</synopsis> <synopsis>Provide details about a contact's status.</synopsis>
<syntax> <syntax>
<parameter name="AOR"> <parameter name="AOR">
@ -727,6 +736,7 @@
</managerEvent> </managerEvent>
<managerEvent language="en_US" name="EndpointList"> <managerEvent language="en_US" name="EndpointList">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>12.0.0</version></since>
<synopsis>Provide details about a contact's status.</synopsis> <synopsis>Provide details about a contact's status.</synopsis>
<syntax> <syntax>
<parameter name="ObjectType"> <parameter name="ObjectType">
@ -777,6 +787,7 @@
</list-elements> </list-elements>
<managerEvent language="en_US" name="EndpointListComplete"> <managerEvent language="en_US" name="EndpointListComplete">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>12.0.0</version></since>
<synopsis>Provide final information about an endpoint list.</synopsis> <synopsis>Provide final information about an endpoint list.</synopsis>
<syntax> <syntax>
<parameter name="EventList"/> <parameter name="EventList"/>
@ -821,6 +832,7 @@
</list-elements> </list-elements>
<managerEvent language="en_US" name="EndpointDetailComplete"> <managerEvent language="en_US" name="EndpointDetailComplete">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>12.0.0</version></since>
<synopsis>Provide final information about endpoint details.</synopsis> <synopsis>Provide final information about endpoint details.</synopsis>
<syntax> <syntax>
<parameter name="EventList"/> <parameter name="EventList"/>
@ -851,6 +863,7 @@
</list-elements> </list-elements>
<managerEvent language="en_US" name="AorListComplete"> <managerEvent language="en_US" name="AorListComplete">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>16.0.0</version></since>
<synopsis>Provide final information about an aor list.</synopsis> <synopsis>Provide final information about an aor list.</synopsis>
<syntax> <syntax>
<parameter name="EventList"/> <parameter name="EventList"/>
@ -880,6 +893,7 @@
</list-elements> </list-elements>
<managerEvent language="en_US" name="AuthListComplete"> <managerEvent language="en_US" name="AuthListComplete">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>16.0.0</version></since>
<synopsis>Provide final information about an auth list.</synopsis> <synopsis>Provide final information about an auth list.</synopsis>
<syntax> <syntax>
<parameter name="EventList"/> <parameter name="EventList"/>
@ -910,6 +924,7 @@
</list-elements> </list-elements>
<managerEvent language="en_US" name="ContactListComplete"> <managerEvent language="en_US" name="ContactListComplete">
<managerEventInstance class="EVENT_FLAG_COMMAND"> <managerEventInstance class="EVENT_FLAG_COMMAND">
<since><version>16.0.0</version></since>
<synopsis>Provide final information about a contact list.</synopsis> <synopsis>Provide final information about a contact list.</synopsis>
<syntax> <syntax>
<parameter name="EventList"/> <parameter name="EventList"/>

Write Preview
Loading…
Cancel
Save