Skip to content

Commit 70bc0ff

Browse files
InterLinked1Friendly Automation
InterLinked1
authored and
Friendly Automation
committed
documentation: Add missing AMI documentation
Adds missing documentation for some channel, bridge, and queue events. ASTERISK-24427 ASTERISK-29515 Change-Id: I92b06b88c8cadc0155f95ebe3e870b3e795a8c64
1 parent 1ddaede commit 70bc0ff

6 files changed

Lines changed: 185 additions & 84 deletions

File tree

‎apps/app_queue.c‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1058,6 +1058,85 @@
10581058
</description>
10591059
</manager>
10601060
1061+
<managerEvent language="en_US" name="QueueParams">
1062+
<managerEventInstance class="EVENT_FLAG_AGENT">
1063+
<synopsis>Raised in response to the QueueStatus action.</synopsis>
1064+
<syntax>
1065+
<parameter name="Max">
1066+
<para>The name of the queue.</para>
1067+
</parameter>
1068+
<parameter name="Strategy">
1069+
<para>The strategy of the queue.</para>
1070+
</parameter>
1071+
<parameter name="Calls">
1072+
<para>The queue member's channel technology or location.</para>
1073+
</parameter>
1074+
<parameter name="Holdtime">
1075+
<para>The queue's hold time.</para>
1076+
</parameter>
1077+
<parameter name="TalkTime">
1078+
<para>The queue's talk time.</para>
1079+
</parameter>
1080+
<parameter name="Completed">
1081+
<para>The queue's completion time.</para>
1082+
</parameter>
1083+
<parameter name="Abandoned">
1084+
<para>The queue's call abandonment metric.</para>
1085+
</parameter>
1086+
<parameter name="ServiceLevelPerf">
1087+
<para>Primary service level performance metric.</para>
1088+
</parameter>
1089+
<parameter name="ServiceLevelPerf2">
1090+
<para>Secondary service level performance metric.</para>
1091+
</parameter>
1092+
</syntax>
1093+
<see-also>
1094+
<ref type="managerEvent">QueueMember</ref>
1095+
<ref type="managerEvent">QueueEntry</ref>
1096+
</see-also>
1097+
</managerEventInstance>
1098+
</managerEvent>
1099+
<managerEvent language="en_US" name="QueueEntry">
1100+
<managerEventInstance class="EVENT_FLAG_AGENT">
1101+
<synopsis>Raised in response to the QueueStatus action.</synopsis>
1102+
<syntax>
1103+
<parameter name="Queue">
1104+
<para>The name of the queue.</para>
1105+
</parameter>
1106+
<parameter name="Position">
1107+
<para>The caller's position within the queue.</para>
1108+
</parameter>
1109+
<parameter name="Channel">
1110+
<para>The name of the caller's channel.</para>
1111+
</parameter>
1112+
<parameter name="Uniqueid">
1113+
<para>The unique ID of the channel.</para>
1114+
</parameter>
1115+
<parameter name="CallerIDNum">
1116+
<para>The Caller ID number.</para>
1117+
</parameter>
1118+
<parameter name="CallerIDName">
1119+
<para>The Caller ID name.</para>
1120+
</parameter>
1121+
<parameter name="ConnectedLineNum">
1122+
<para>The bridged party's number.</para>
1123+
</parameter>
1124+
<parameter name="ConnectedLineName">
1125+
<para>The bridged party's name.</para>
1126+
</parameter>
1127+
<parameter name="Wait">
1128+
<para>The caller's wait time.</para>
1129+
</parameter>
1130+
<parameter name="Priority">
1131+
<para>The caller's priority within the queue.</para>
1132+
</parameter>
1133+
</syntax>
1134+
<see-also>
1135+
<ref type="managerEvent">QueueParams</ref>
1136+
<ref type="managerEvent">QueueMember</ref>
1137+
</see-also>
1138+
</managerEventInstance>
1139+
</managerEvent>
10611140
<managerEvent language="en_US" name="QueueMemberStatus">
10621141
<managerEventInstance class="EVENT_FLAG_AGENT">
10631142
<synopsis>Raised when a Queue member's status has changed.</synopsis>

‎main/channel.c‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6813,9 +6813,11 @@ int ast_channel_make_compatible(struct ast_channel *chan, struct ast_channel *pe
68136813
static void __ast_change_name_nolink(struct ast_channel *chan, const char *newname)
68146814
{
68156815
/*** DOCUMENTATION
6816-
<managerEventInstance>
6817-
<synopsis>Raised when the name of a channel is changed.</synopsis>
6818-
</managerEventInstance>
6816+
<managerEvent language="en_US" name="Rename">
6817+
<managerEventInstance class="EVENT_FLAG_CALL">
6818+
<synopsis>Raised when the name of a channel is changed.</synopsis>
6819+
</managerEventInstance>
6820+
</managerEvent>
68196821
***/
68206822
ast_manager_event(chan, EVENT_FLAG_CALL, "Rename",
68216823
"Channel: %s\r\n"

‎main/logger.c‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1222,14 +1222,16 @@ static int reload_logger(int rotate, const char *altconf)
12221222
if (f->disabled) {
12231223
f->disabled = 0; /* Re-enable logging at reload */
12241224
/*** DOCUMENTATION
1225-
<managerEventInstance>
1226-
<synopsis>Raised when a logging channel is re-enabled after a reload operation.</synopsis>
1227-
<syntax>
1228-
<parameter name="Channel">
1229-
<para>The name of the logging channel.</para>
1230-
</parameter>
1231-
</syntax>
1232-
</managerEventInstance>
1225+
<managerEvent language="en_US" name="LogChannel">
1226+
<managerEventInstance class="EVENT_FLAG_SYSTEM">
1227+
<synopsis>Raised when a logging channel is re-enabled after a reload operation.</synopsis>
1228+
<syntax>
1229+
<parameter name="Channel">
1230+
<para>The name of the logging channel.</para>
1231+
</parameter>
1232+
</syntax>
1233+
</managerEventInstance>
1234+
</managerEvent>
12331235
***/
12341236
manager_event(EVENT_FLAG_SYSTEM, "LogChannel", "Channel: %s\r\nEnabled: Yes\r\n", f->filename);
12351237
}

‎main/manager_bridges.c‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -376,13 +376,15 @@ static void bridge_merge_cb(void *data, struct stasis_subscription *sub,
376376
}
377377

378378
/*** DOCUMENTATION
379-
<managerEventInstance>
380-
<synopsis>Raised when two bridges are merged.</synopsis>
381-
<syntax>
382-
<bridge_snapshot prefix="To"/>
383-
<bridge_snapshot prefix="From"/>
384-
</syntax>
385-
</managerEventInstance>
379+
<managerEvent language="en_US" name="BridgeMerge">
380+
<managerEventInstance class="EVENT_FLAG_CALL">
381+
<synopsis>Raised when two bridges are merged.</synopsis>
382+
<syntax>
383+
<bridge_snapshot prefix="To"/>
384+
<bridge_snapshot prefix="From"/>
385+
</syntax>
386+
</managerEventInstance>
387+
</managerEvent>
386388
***/
387389
manager_event(EVENT_FLAG_CALL, "BridgeMerge",
388390
"%s"

‎main/manager_channels.c‎

Lines changed: 53 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -891,24 +891,26 @@ static void channel_dtmf_begin_cb(void *data, struct stasis_subscription *sub,
891891
}
892892

893893
/*** DOCUMENTATION
894-
<managerEventInstance>
895-
<synopsis>Raised when a DTMF digit has started on a channel.</synopsis>
896-
<syntax>
897-
<channel_snapshot/>
898-
<parameter name="Digit">
899-
<para>DTMF digit received or transmitted (0-9, A-E, # or *</para>
900-
</parameter>
901-
<parameter name="Direction">
902-
<enumlist>
903-
<enum name="Received"/>
904-
<enum name="Sent"/>
905-
</enumlist>
906-
</parameter>
907-
</syntax>
908-
<see-also>
909-
<ref type="managerEvent">DTMFEnd</ref>
910-
</see-also>
911-
</managerEventInstance>
894+
<managerEvent language="en_US" name="DTMFBegin">
895+
<managerEventInstance class="EVENT_FLAG_DTMF">
896+
<synopsis>Raised when a DTMF digit has started on a channel.</synopsis>
897+
<syntax>
898+
<channel_snapshot/>
899+
<parameter name="Digit">
900+
<para>DTMF digit received or transmitted (0-9, A-E, # or *</para>
901+
</parameter>
902+
<parameter name="Direction">
903+
<enumlist>
904+
<enum name="Received"/>
905+
<enum name="Sent"/>
906+
</enumlist>
907+
</parameter>
908+
</syntax>
909+
<see-also>
910+
<ref type="managerEvent">DTMFEnd</ref>
911+
</see-also>
912+
</managerEventInstance>
913+
</managerEvent>
912914
***/
913915
manager_event(EVENT_FLAG_DTMF, "DTMFBegin",
914916
"%s"
@@ -937,27 +939,29 @@ static void channel_dtmf_end_cb(void *data, struct stasis_subscription *sub,
937939
}
938940

939941
/*** DOCUMENTATION
940-
<managerEventInstance>
941-
<synopsis>Raised when a DTMF digit has ended on a channel.</synopsis>
942-
<syntax>
943-
<channel_snapshot/>
944-
<parameter name="Digit">
945-
<para>DTMF digit received or transmitted (0-9, A-E, # or *</para>
946-
</parameter>
947-
<parameter name="DurationMs">
948-
<para>Duration (in milliseconds) DTMF was sent/received</para>
949-
</parameter>
950-
<parameter name="Direction">
951-
<enumlist>
952-
<enum name="Received"/>
953-
<enum name="Sent"/>
954-
</enumlist>
955-
</parameter>
956-
</syntax>
957-
<see-also>
958-
<ref type="managerEvent">DTMFBegin</ref>
959-
</see-also>
960-
</managerEventInstance>
942+
<managerEvent language="en_US" name="DTMFEnd">
943+
<managerEventInstance class="EVENT_FLAG_DTMF">
944+
<synopsis>Raised when a DTMF digit has ended on a channel.</synopsis>
945+
<syntax>
946+
<channel_snapshot/>
947+
<parameter name="Digit">
948+
<para>DTMF digit received or transmitted (0-9, A-E, # or *</para>
949+
</parameter>
950+
<parameter name="DurationMs">
951+
<para>Duration (in milliseconds) DTMF was sent/received</para>
952+
</parameter>
953+
<parameter name="Direction">
954+
<enumlist>
955+
<enum name="Received"/>
956+
<enum name="Sent"/>
957+
</enumlist>
958+
</parameter>
959+
</syntax>
960+
<see-also>
961+
<ref type="managerEvent">DTMFBegin</ref>
962+
</see-also>
963+
</managerEventInstance>
964+
</managerEvent>
961965
***/
962966
manager_event(EVENT_FLAG_DTMF, "DTMFEnd",
963967
"%s"
@@ -979,6 +983,16 @@ static void channel_flash_cb(void *data, struct stasis_subscription *sub,
979983
return;
980984
}
981985

986+
/*** DOCUMENTATION
987+
<managerEvent language="en_US" name="Flash">
988+
<managerEventInstance class="EVENT_FLAG_CALL">
989+
<synopsis>Raised when a hook flash occurs on a channel.</synopsis>
990+
<syntax>
991+
<channel_snapshot/>
992+
</syntax>
993+
</managerEventInstance>
994+
</managerEvent>
995+
***/
982996
manager_event(EVENT_FLAG_CALL, "Flash",
983997
"%s",
984998
ast_str_buffer(channel_event_string));

‎main/manager_mwi.c‎

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -103,33 +103,35 @@ static void mwi_update_cb(void *data, struct stasis_subscription *sub,
103103
}
104104

105105
/*** DOCUMENTATION
106-
<managerEventInstance>
107-
<synopsis>Raised when the state of messages in a voicemail mailbox
108-
has changed or when a channel has finished interacting with a
109-
mailbox.</synopsis>
110-
<syntax>
111-
<channel_snapshot/>
112-
<parameter name="Mailbox">
113-
<para>The mailbox with the new message, specified as <literal>mailbox</literal>@<literal>context</literal></para>
114-
</parameter>
115-
<parameter name="Waiting">
116-
<para>Whether or not the mailbox has messages waiting for it.</para>
117-
</parameter>
118-
<parameter name="New">
119-
<para>The number of new messages.</para>
120-
</parameter>
121-
<parameter name="Old">
122-
<para>The number of old messages.</para>
123-
</parameter>
124-
</syntax>
125-
<description>
126-
<note><para>The Channel related parameters are only present if a
127-
channel was involved in the manipulation of a mailbox. If no
128-
channel is involved, the parameters are not included with the
129-
event.</para>
130-
</note>
131-
</description>
132-
</managerEventInstance>
106+
<managerEvent language="en_US" name="MessageWaiting">
107+
<managerEventInstance class="EVENT_FLAG_CALL">
108+
<synopsis>Raised when the state of messages in a voicemail mailbox
109+
has changed or when a channel has finished interacting with a
110+
mailbox.</synopsis>
111+
<syntax>
112+
<channel_snapshot/>
113+
<parameter name="Mailbox">
114+
<para>The mailbox with the new message, specified as <literal>mailbox</literal>@<literal>context</literal></para>
115+
</parameter>
116+
<parameter name="Waiting">
117+
<para>Whether or not the mailbox has messages waiting for it.</para>
118+
</parameter>
119+
<parameter name="New">
120+
<para>The number of new messages.</para>
121+
</parameter>
122+
<parameter name="Old">
123+
<para>The number of old messages.</para>
124+
</parameter>
125+
</syntax>
126+
<description>
127+
<note><para>The Channel related parameters are only present if a
128+
channel was involved in the manipulation of a mailbox. If no
129+
channel is involved, the parameters are not included with the
130+
event.</para>
131+
</note>
132+
</description>
133+
</managerEventInstance>
134+
</managerEvent>
133135
***/
134136
manager_event(EVENT_FLAG_CALL, "MessageWaiting",
135137
"%s"

0 commit comments

Comments
 (0)