[sr-dev] git:master:58bb516e: presence: docs for rpc command presence.presentity_list

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 58bb516e4fe1b098bc574d75bef32af9d2ae61b8
URL: https://github.com/kamailio/kamailio/commit/58bb516e4fe1b098bc574d75bef32af9d2ae61b8

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2020-04-21T10:04:49+02:00

presence: docs for rpc command presence.presentity_list

---

Modified: src/modules/presence/doc/presence_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/58bb516e4fe1b098bc574d75bef32af9d2ae61b8.diff
Patch: https://github.com/kamailio/kamailio/commit/58bb516e4fe1b098bc574d75bef32af9d2ae61b8.patch

---

diff --git a/src/modules/presence/doc/presence_admin.xml b/src/modules/presence/doc/presence_admin.xml
index 850e929f67..32b67d6c6b 100644
--- a/src/modules/presence/doc/presence_admin.xml
+++ b/src/modules/presence/doc/presence_admin.xml
@@ -1346,6 +1346,33 @@ pres_update_watchers("sip:test at 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>