kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-31 10:47:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation: Add missing AMI documentation

Browse Source 
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 935b8cb04e
commit 3e7e1d1d05
6 changed files with 185 additions and 84 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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)
{
/*** DOCUMENTATION
<managerEventInstance>
<synopsis>Raised when the name of a channel is changed.</synopsis>
</managerEventInstance>
<managerEvent language="en_US" name="Rename">
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when the name of a channel is changed.</synopsis>
</managerEventInstance>
</managerEvent>
***/
ast_manager_event(chan, EVENT_FLAG_CALL, "Rename",
"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) {
f->disabled = 0; /* Re-enable logging at reload */
/*** DOCUMENTATION
<managerEventInstance>
<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 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);
}

16
main/manager_bridges.c
View File

@@ -376,13 +376,15 @@ static void bridge_merge_cb(void *data, struct stasis_subscription *sub,
}
/*** DOCUMENTATION
<managerEventInstance>
<synopsis>Raised when two bridges are merged.</synopsis>
<syntax>
<bridge_snapshot prefix="To"/>
<bridge_snapshot prefix="From"/>
</syntax>
</managerEventInstance>
<managerEvent language="en_US" name="BridgeMerge">
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when two bridges are merged.</synopsis>
<syntax>
<bridge_snapshot prefix="To"/>
<bridge_snapshot prefix="From"/>
</syntax>
</managerEventInstance>
</managerEvent>
***/
manager_event(EVENT_FLAG_CALL, "BridgeMerge",
"%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
<managerEventInstance>
<synopsis>Raised when a DTMF digit has started on a channel.</synopsis>
<syntax>
<channel_snapshot/>
<parameter name="Digit">
<para>DTMF digit received or transmitted (0-9, A-E, # or *</para>
</parameter>
<parameter name="Direction">
<enumlist>
<enum name="Received"/>
<enum name="Sent"/>
</enumlist>
</parameter>
</syntax>
<see-also>
<ref type="managerEvent">DTMFEnd</ref>
</see-also>
</managerEventInstance>
<managerEvent language="en_US" name="DTMFBegin">
<managerEventInstance class="EVENT_FLAG_DTMF">
<synopsis>Raised when a DTMF digit has started on a channel.</synopsis>
<syntax>
<channel_snapshot/>
<parameter name="Digit">
<para>DTMF digit received or transmitted (0-9, A-E, # or *</para>
</parameter>
<parameter name="Direction">
<enumlist>
<enum name="Received"/>
<enum name="Sent"/>
</enumlist>
</parameter>
</syntax>
<see-also>
<ref type="managerEvent">DTMFEnd</ref>
</see-also>
</managerEventInstance>
</managerEvent>
***/
manager_event(EVENT_FLAG_DTMF, "DTMFBegin",
"%s"
@@ -937,27 +939,29 @@ static void channel_dtmf_end_cb(void *data, struct stasis_subscription *sub,
}
/*** DOCUMENTATION
<managerEventInstance>
<synopsis>Raised when a DTMF digit has ended on a channel.</synopsis>
<syntax>
<channel_snapshot/>
<parameter name="Digit">
<para>DTMF digit received or transmitted (0-9, A-E, # or *</para>
</parameter>
<parameter name="DurationMs">
<para>Duration (in milliseconds) DTMF was sent/received</para>
</parameter>
<parameter name="Direction">
<enumlist>
<enum name="Received"/>
<enum name="Sent"/>
</enumlist>
</parameter>
</syntax>
<see-also>
<ref type="managerEvent">DTMFBegin</ref>
</see-also>
</managerEventInstance>
<managerEvent language="en_US" name="DTMFEnd">
<managerEventInstance class="EVENT_FLAG_DTMF">
<synopsis>Raised when a DTMF digit has ended on a channel.</synopsis>
<syntax>
<channel_snapshot/>
<parameter name="Digit">
<para>DTMF digit received or transmitted (0-9, A-E, # or *</para>
</parameter>
<parameter name="DurationMs">
<para>Duration (in milliseconds) DTMF was sent/received</para>
</parameter>
<parameter name="Direction">
<enumlist>
<enum name="Received"/>
<enum name="Sent"/>
</enumlist>
</parameter>
</syntax>
<see-also>
<ref type="managerEvent">DTMFBegin</ref>
</see-also>
</managerEventInstance>
</managerEvent>
***/
manager_event(EVENT_FLAG_DTMF, "DTMFEnd",
"%s"
@@ -979,6 +983,16 @@ static void channel_flash_cb(void *data, struct stasis_subscription *sub,
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",
"%s",
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
<managerEventInstance>
<synopsis>Raised when the state of messages in a voicemail mailbox
has changed or when a channel has finished interacting with a
mailbox.</synopsis>
<syntax>
<channel_snapshot/>
<parameter name="Mailbox">
<para>The mailbox with the new message, specified as <literal>mailbox</literal>@<literal>context</literal></para>
</parameter>
<parameter name="Waiting">
<para>Whether or not the mailbox has messages waiting for it.</para>
</parameter>
<parameter name="New">
<para>The number of new messages.</para>
</parameter>
<parameter name="Old">
<para>The number of old messages.</para>
</parameter>
</syntax>
<description>
<note><para>The Channel related parameters are only present if a
channel was involved in the manipulation of a mailbox. If no
channel is involved, the parameters are not included with the
event.</para>
</note>
</description>
</managerEventInstance>
<managerEvent language="en_US" name="MessageWaiting">
<managerEventInstance class="EVENT_FLAG_CALL">
<synopsis>Raised when the state of messages in a voicemail mailbox
has changed or when a channel has finished interacting with a
mailbox.</synopsis>
<syntax>
<channel_snapshot/>
<parameter name="Mailbox">
<para>The mailbox with the new message, specified as <literal>mailbox</literal>@<literal>context</literal></para>
</parameter>
<parameter name="Waiting">
<para>Whether or not the mailbox has messages waiting for it.</para>
</parameter>
<parameter name="New">
<para>The number of new messages.</para>
</parameter>
<parameter name="Old">
<para>The number of old messages.</para>
</parameter>
</syntax>
<description>
<note><para>The Channel related parameters are only present if a
channel was involved in the manipulation of a mailbox. If no
channel is involved, the parameters are not included with the
event.</para>
</note>
</description>
</managerEventInstance>
</managerEvent>
***/
manager_event(EVENT_FLAG_CALL, "MessageWaiting",
"%s"