From: Naveen Albert <asterisk@phreaknet.org>
Date: Sat, 23 Jul 2022 23:07:18 +0000 (+0000)
Subject: app_meetme: Add missing AMI documentation.
X-Git-Tag: 19.7.0-rc1~42
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=eb316354a9132bdb02c84ee02953ae4b2ba6fd4a;p=thirdparty%2Fasterisk.git

app_meetme: Add missing AMI documentation.

The MeetmeList and MeetmeListRooms AMI
responses are currently completely undocumented.
This adds documentation for these responses.

ASTERISK-30018 #close

Change-Id: Id93135b7edf01de6f8fba266e2122989dc8996b8
---

diff --git a/apps/app_meetme.c b/apps/app_meetme.c
index 918cadf43e..0f717b37a0 100644
--- a/apps/app_meetme.c
+++ b/apps/app_meetme.c
@@ -639,6 +639,82 @@
 			</syntax>
 		</managerEventInstance>
 	</managerEvent>
+	<managerEvent language="en_US" name="MeetmeList">
+		<managerEventInstance class="EVENT_FLAG_CALL">
+			<synopsis>Raised in response to a MeetmeList command.</synopsis>
+			<syntax>
+				<parameter name="Conference">
+					<para>Conference ID.</para>
+				</parameter>
+				<parameter name="UserNumber">
+					<para>User ID.</para>
+				</parameter>
+				<parameter name="CallerIDNum">
+					<para>Caller ID number.</para>
+				</parameter>
+				<parameter name="CallerIDName">
+					<para>Caller ID name.</para>
+				</parameter>
+				<parameter name="ConnectedLineNum">
+					<para>Connected Line number.</para>
+				</parameter>
+				<parameter name="ConnectedLineName">
+					<para>Connected Line name.</para>
+				</parameter>
+				<parameter name="Channel">
+					<para>Channel name</para>
+				</parameter>
+				<parameter name="Admin">
+					<para>Whether or not the user is an admin.</para>
+				</parameter>
+				<parameter name="Role">
+					<para>User role. Can be "Listen only", "Talk only", or "Talk and listen".</para>
+				</parameter>
+				<parameter name="MarkedUser">
+					<para>Whether or not the user is a marked user.</para>
+				</parameter>
+				<parameter name="Muted">
+					<para>Whether or not the user is currently muted.</para>
+				</parameter>
+				<parameter name="Talking">
+					<para>Whether or not the user is currently talking.</para>
+				</parameter>
+			</syntax>
+			<see-also>
+				<ref type="manager">MeetmeList</ref>
+				<ref type="application">MeetMe</ref>
+			</see-also>
+		</managerEventInstance>
+	</managerEvent>
+	<managerEvent language="en_US" name="MeetmeListRooms">
+		<managerEventInstance class="EVENT_FLAG_CALL">
+			<synopsis>Raised in response to a MeetmeListRooms command.</synopsis>
+			<syntax>
+				<parameter name="Conference">
+					<para>Conference ID.</para>
+				</parameter>
+				<parameter name="Parties">
+					<para>Number of parties in the conference.</para>
+				</parameter>
+				<parameter name="Marked">
+					<para>Number of marked users in the conference.</para>
+				</parameter>
+				<parameter name="Activity">
+					<para>Total duration of conference in HH:MM:SS format.</para>
+				</parameter>
+				<parameter name="Creation">
+					<para>How the conference was created: "Dyanmic" or "Static".</para>
+				</parameter>
+				<parameter name="Locked">
+					<para>Whether or not the conference is locked.</para>
+				</parameter>
+			</syntax>
+			<see-also>
+				<ref type="manager">MeetmeListRooms</ref>
+				<ref type="application">MeetMe</ref>
+			</see-also>
+		</managerEventInstance>
+	</managerEvent>
  ***/
 
 #define CONFIG_FILE_NAME	"meetme.conf"