presence: docs for rpc command presence.presentity_list
authorDaniel-Constantin Mierla <miconda@gmail.com>
Tue, 21 Apr 2020 08:04:49 +0000 (10:04 +0200)
committerDaniel-Constantin Mierla <miconda@gmail.com>
Tue, 21 Apr 2020 08:04:49 +0000 (10:04 +0200)
src/modules/presence/doc/presence_admin.xml

index 850e929..32b67d6 100644 (file)
@@ -1346,6 +1346,33 @@ pres_update_watchers("sip:test@kamailio.org", "presence");
 ...
          </programlisting>
        </section>
+       <section id="presence.rpc.presentity_list">
+         <title>presence.presentity_list</title>
+         <para>
+               List the presentity records stored in memory.
+         </para>
+         <para>
+               Name: <emphasis>presence.presentity_list</emphasis>
+         </para>
+         <para>Parameters:</para>
+               <itemizedlist>
+                       <listitem>
+                               <para>mode - (optional) it can be 'full' to print all the
+                               fields of presentity record. If missine, only a selected
+                               set of fields are printed in the response.</para>
+                       </listitem>
+               </itemizedlist>
+         <para>
+               RPC Command Format:
+         </para>
+         <programlisting  format="linespecific">
+...
+kamctl rpc presence.presentity_list
+kamctl rpc presence.presentity_list full
+...
+         </programlisting>
+       </section>
+
 </section>
 
 <section>