]> git.ipfire.org Git - thirdparty/asterisk.git/commitdiff
app_meetme: Add missing AMI documentation.
authorNaveen Albert <asterisk@phreaknet.org>
Sat, 23 Jul 2022 23:07:18 +0000 (23:07 +0000)
committerGeorge Joseph <gjoseph@digium.com>
Mon, 1 Aug 2022 16:05:13 +0000 (11:05 -0500)
The MeetmeList and MeetmeListRooms AMI
responses are currently completely undocumented.
This adds documentation for these responses.

ASTERISK-30018 #close

Change-Id: Id93135b7edf01de6f8fba266e2122989dc8996b8

apps/app_meetme.c

index e37c548eb84cb513832a4ae23cd45416d2317bbd..191de68ae710a594216ee0f142073322b18bc04b 100644 (file)
                        </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"