[Asterisk-code-review] documentation: Add missing AMI documentation (asterisk[16])

N A asteriskteam at digium.com
Wed Jan 5 06:33:34 CST 2022


N A has uploaded this change for review. ( https://gerrit.asterisk.org/c/asterisk/+/17806 )


Change subject: documentation: Add missing AMI documentation
......................................................................

documentation: Add missing AMI documentation

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

ASTERISK-24427
ASTERISK-29515

Change-Id: I92b06b88c8cadc0155f95ebe3e870b3e795a8c64
---
M apps/app_queue.c
M main/channel.c
M main/logger.c
M main/manager_bridges.c
M main/manager_channels.c
M main/manager_mwi.c
6 files changed, 185 insertions(+), 84 deletions(-)



  git pull ssh://gerrit.asterisk.org:29418/asterisk refs/changes/06/17806/1

diff --git a/apps/app_queue.c b/apps/app_queue.c
index dcd5aa8..4ce54f8 100644
--- a/apps/app_queue.c
+++ b/apps/app_queue.c
@@ -1058,6 +1058,85 @@
 		</description>
 	</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">
 		<managerEventInstance class="EVENT_FLAG_AGENT">
 			<synopsis>Raised when a Queue member's status has changed.</synopsis>
diff --git a/main/channel.c b/main/channel.c
index 60eea4b..cd7513a 100644
--- a/main/channel.c
+++ b/main/channel.c
@@ -6825,9 +6825,11 @@
 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"
diff --git a/main/logger.c b/main/logger.c
index ebc72fe..e9f8f96 100644
--- a/main/logger.c
+++ b/main/logger.c
@@ -1222,14 +1222,16 @@
 		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);
 		}
diff --git a/main/manager_bridges.c b/main/manager_bridges.c
index 19c8a79..e6ce39d 100644
--- a/main/manager_bridges.c
+++ b/main/manager_bridges.c
@@ -383,13 +383,15 @@
 	}
 
 	/*** 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"
diff --git a/main/manager_channels.c b/main/manager_channels.c
index 943e9f4..4a5def7 100644
--- a/main/manager_channels.c
+++ b/main/manager_channels.c
@@ -908,24 +908,26 @@
 	}
 
 	/*** 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"
@@ -954,27 +956,29 @@
 	}
 
 	/*** 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"
@@ -996,6 +1000,16 @@
 		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));
diff --git a/main/manager_mwi.c b/main/manager_mwi.c
index 7542b5b..f39ac19 100644
--- a/main/manager_mwi.c
+++ b/main/manager_mwi.c
@@ -103,33 +103,35 @@
 	}
 
 	/*** 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"

-- 
To view, visit https://gerrit.asterisk.org/c/asterisk/+/17806
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings

Gerrit-Project: asterisk
Gerrit-Branch: 16
Gerrit-Change-Id: I92b06b88c8cadc0155f95ebe3e870b3e795a8c64
Gerrit-Change-Number: 17806
Gerrit-PatchSet: 1
Gerrit-Owner: N A <mail at interlinked.x10host.com>
Gerrit-MessageType: newchange
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20220105/03a3ae0e/attachment-0001.html>


More information about the asterisk-code-review mailing list