sysmocom
/
asterisk
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

documentation: Add missing AMI documentation 

Adds missing documentation for some channel,
bridge, and queue events.

ASTERISK-24427
ASTERISK-29515

Change-Id: I92b06b88c8cadc0155f95ebe3e870b3e795a8c64
This commit is contained in:
Naveen Albert 2021-12-13 14:29:30 +00:00 committed by Friendly Automation
parent 1ddaedeaf5
commit 70bc0ff9d0
6 changed files with 185 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
apps/app_queue.c
View File

@ -1058,6 +1058,85 @@
</description> </description>
</manager> </manager>
<managerEvent language="en_US" name="QueueParams">
<managerEventInstance class="EVENT_FLAG_AGENT">
<synopsis>Raised in response to the QueueStatus action.</synopsis>
<syntax>
<parameter name="Max">
<para>The name of the queue.</para>
</parameter>
<parameter name="Strategy">
<para>The strategy of the queue.</para>
</parameter>
<parameter name="Calls">
<para>The queue member's channel technology or location.</para>
</parameter>
<parameter name="Holdtime">
<para>The queue's hold time.</para>
</parameter>
<parameter name="TalkTime">
<para>The queue's talk time.</para>
</parameter>
<parameter name="Completed">
<para>The queue's completion time.</para>
</parameter>
<parameter name="Abandoned">
<para>The queue's call abandonment metric.</para>
</parameter>
<parameter name="ServiceLevelPerf">
<para>Primary service level performance metric.</para>
</parameter>
<parameter name="ServiceLevelPerf2">
<para>Secondary service level performance metric.</para>
</parameter>
</syntax>
<see-also>
<ref type="managerEvent">QueueMember</ref>
<ref type="managerEvent">QueueEntry</ref>
</see-also>
</managerEventInstance>
</managerEvent>
<managerEvent language="en_US" name="QueueEntry">
<managerEventInstance class="EVENT_FLAG_AGENT">
<synopsis>Raised in response to the QueueStatus action.</synopsis>
<syntax>
<parameter name="Queue">
<para>The name of the queue.</para>
</parameter>
<parameter name="Position">
<para>The caller's position within the queue.</para>
</parameter>
<parameter name="Channel">
<para>The name of the caller's channel.</para>
</parameter>
<parameter name="Uniqueid">
<para>The unique ID of the channel.</para>
</parameter>
<parameter name="CallerIDNum">
<para>The Caller ID number.</para>
</parameter>
<parameter name="CallerIDName">
<para>The Caller ID name.</para>
</parameter>
<parameter name="ConnectedLineNum">
<para>The bridged party's number.</para>
</parameter>
<parameter name="ConnectedLineName">
<para>The bridged party's name.</para>
</parameter>
<parameter name="Wait">
<para>The caller's wait time.</para>
</parameter>
<parameter name="Priority">
<para>The caller's priority within the queue.</para>
</parameter>
</syntax>
<see-also>
<ref type="managerEvent">QueueParams</ref>
<ref type="managerEvent">QueueMember</ref>
</see-also>
</managerEventInstance>
</managerEvent>
<managerEvent language="en_US" name="QueueMemberStatus"> <managerEvent language="en_US" name="QueueMemberStatus">
<managerEventInstance class="EVENT_FLAG_AGENT"> <managerEventInstance class="EVENT_FLAG_AGENT">
<synopsis>Raised when a Queue member's status has changed.</synopsis> <synopsis>Raised when a Queue member's status has changed.</synopsis>

8
main/channel.c
View File

@ -6813,9 +6813,11 @@ int ast_channel_make_compatible(struct ast_channel *chan, struct ast_channel *pe
static void __ast_change_name_nolink(struct ast_channel *chan, const char *newname) static void __ast_change_name_nolink(struct ast_channel *chan, const char *newname)
{ {
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEventInstance> <managerEvent language="en_US" name="Rename">
<synopsis>Raised when the name of a channel is changed.</synopsis> <managerEventInstance class="EVENT_FLAG_CALL">
</managerEventInstance> <synopsis>Raised when the name of a channel is changed.</synopsis>
</managerEventInstance>
</managerEvent>
***/ ***/
ast_manager_event(chan, EVENT_FLAG_CALL, "Rename", ast_manager_event(chan, EVENT_FLAG_CALL, "Rename",
"Channel: %s\r\n" "Channel: %s\r\n"

18
main/logger.c
View File

@ -1222,14 +1222,16 @@ static int reload_logger(int rotate, const char *altconf)
if (f->disabled) { if (f->disabled) {
f->disabled = 0; /* Re-enable logging at reload */ f->disabled = 0; /* Re-enable logging at reload */
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEventInstance> <managerEvent language="en_US" name="LogChannel">
<synopsis>Raised when a logging channel is re-enabled after a reload operation.</synopsis> <managerEventInstance class="EVENT_FLAG_SYSTEM">
<syntax> <synopsis>Raised when a logging channel is re-enabled after a reload operation.</synopsis>
<parameter name="Channel"> <syntax>
<para>The name of the logging channel.</para> <parameter name="Channel">
</parameter> <para>The name of the logging channel.</para>
</syntax> </parameter>
</managerEventInstance> </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);
} }

16
main/manager_bridges.c
View File

@ -376,13 +376,15 @@ static void bridge_merge_cb(void *data, struct stasis_subscription *sub,
} }
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEventInstance> <managerEvent language="en_US" name="BridgeMerge">
<synopsis>Raised when two bridges are merged.</synopsis> <managerEventInstance class="EVENT_FLAG_CALL">
<syntax> <synopsis>Raised when two bridges are merged.</synopsis>
<bridge_snapshot prefix="To"/> <syntax>
<bridge_snapshot prefix="From"/> <bridge_snapshot prefix="To"/>
</syntax> <bridge_snapshot prefix="From"/>
</managerEventInstance> </syntax>
</managerEventInstance>
</managerEvent>
***/ ***/
manager_event(EVENT_FLAG_CALL, "BridgeMerge", manager_event(EVENT_FLAG_CALL, "BridgeMerge",
"%s" "%s"

92
main/manager_channels.c
View File

@ -891,24 +891,26 @@ static void channel_dtmf_begin_cb(void *data, struct stasis_subscription *sub,
} }
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEventInstance> <managerEvent language="en_US" name="DTMFBegin">
<synopsis>Raised when a DTMF digit has started on a channel.</synopsis> <managerEventInstance class="EVENT_FLAG_DTMF">
<syntax> <synopsis>Raised when a DTMF digit has started on a channel.</synopsis>
<channel_snapshot/> <syntax>
<parameter name="Digit"> <channel_snapshot/>
<para>DTMF digit received or transmitted (0-9, A-E, # or *</para> <parameter name="Digit">
</parameter> <para>DTMF digit received or transmitted (0-9, A-E, # or *</para>
<parameter name="Direction"> </parameter>
<enumlist> <parameter name="Direction">
<enum name="Received"/> <enumlist>
<enum name="Sent"/> <enum name="Received"/>
</enumlist> <enum name="Sent"/>
</parameter> </enumlist>
</syntax> </parameter>
<see-also> </syntax>
<ref type="managerEvent">DTMFEnd</ref> <see-also>
</see-also> <ref type="managerEvent">DTMFEnd</ref>
</managerEventInstance> </see-also>
</managerEventInstance>
</managerEvent>
***/ ***/
manager_event(EVENT_FLAG_DTMF, "DTMFBegin", manager_event(EVENT_FLAG_DTMF, "DTMFBegin",
"%s" "%s"
@ -937,27 +939,29 @@ static void channel_dtmf_end_cb(void *data, struct stasis_subscription *sub,
} }
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEventInstance> <managerEvent language="en_US" name="DTMFEnd">
<synopsis>Raised when a DTMF digit has ended on a channel.</synopsis> <managerEventInstance class="EVENT_FLAG_DTMF">
<syntax> <synopsis>Raised when a DTMF digit has ended on a channel.</synopsis>
<channel_snapshot/> <syntax>
<parameter name="Digit"> <channel_snapshot/>
<para>DTMF digit received or transmitted (0-9, A-E, # or *</para> <parameter name="Digit">
</parameter> <para>DTMF digit received or transmitted (0-9, A-E, # or *</para>
<parameter name="DurationMs"> </parameter>
<para>Duration (in milliseconds) DTMF was sent/received</para> <parameter name="DurationMs">
</parameter> <para>Duration (in milliseconds) DTMF was sent/received</para>
<parameter name="Direction"> </parameter>
<enumlist> <parameter name="Direction">
<enum name="Received"/> <enumlist>
<enum name="Sent"/> <enum name="Received"/>
</enumlist> <enum name="Sent"/>
</parameter> </enumlist>
</syntax> </parameter>
<see-also> </syntax>
<ref type="managerEvent">DTMFBegin</ref> <see-also>
</see-also> <ref type="managerEvent">DTMFBegin</ref>
</managerEventInstance> </see-also>
</managerEventInstance>
</managerEvent>
***/ ***/
manager_event(EVENT_FLAG_DTMF, "DTMFEnd", manager_event(EVENT_FLAG_DTMF, "DTMFEnd",
"%s" "%s"
@ -979,6 +983,16 @@ static void channel_flash_cb(void *data, struct stasis_subscription *sub,
return; return;
} }
/*** DOCUMENTATION
<managerEvent language="en_US" name="Flash">
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when a hook flash occurs on a channel.</synopsis>
<syntax>
<channel_snapshot/>
</syntax>
</managerEventInstance>
</managerEvent>
***/
manager_event(EVENT_FLAG_CALL, "Flash", manager_event(EVENT_FLAG_CALL, "Flash",
"%s", "%s",
ast_str_buffer(channel_event_string)); ast_str_buffer(channel_event_string));

56
main/manager_mwi.c
View File

@ -103,33 +103,35 @@ static void mwi_update_cb(void *data, struct stasis_subscription *sub,
} }
/*** DOCUMENTATION /*** DOCUMENTATION
<managerEventInstance> <managerEvent language="en_US" name="MessageWaiting">
<synopsis>Raised when the state of messages in a voicemail mailbox <managerEventInstance class="EVENT_FLAG_CALL">
has changed or when a channel has finished interacting with a <synopsis>Raised when the state of messages in a voicemail mailbox
mailbox.</synopsis> has changed or when a channel has finished interacting with a
<syntax> mailbox.</synopsis>
<channel_snapshot/> <syntax>
<parameter name="Mailbox"> <channel_snapshot/>
<para>The mailbox with the new message, specified as <literal>mailbox</literal>@<literal>context</literal></para> <parameter name="Mailbox">
</parameter> <para>The mailbox with the new message, specified as <literal>mailbox</literal>@<literal>context</literal></para>
<parameter name="Waiting"> </parameter>
<para>Whether or not the mailbox has messages waiting for it.</para> <parameter name="Waiting">
</parameter> <para>Whether or not the mailbox has messages waiting for it.</para>
<parameter name="New"> </parameter>
<para>The number of new messages.</para> <parameter name="New">
</parameter> <para>The number of new messages.</para>
<parameter name="Old"> </parameter>
<para>The number of old messages.</para> <parameter name="Old">
</parameter> <para>The number of old messages.</para>
</syntax> </parameter>
<description> </syntax>
<note><para>The Channel related parameters are only present if a <description>
channel was involved in the manipulation of a mailbox. If no <note><para>The Channel related parameters are only present if a
channel is involved, the parameters are not included with the channel was involved in the manipulation of a mailbox. If no
event.</para> channel is involved, the parameters are not included with the
</note> event.</para>
</description> </note>
</managerEventInstance> </description>
</managerEventInstance>
</managerEvent>
***/ ***/
manager_event(EVENT_FLAG_CALL, "MessageWaiting", manager_event(EVENT_FLAG_CALL, "MessageWaiting",
"%s" "%s"