Module: kamailio Branch: master Commit: c167c4738fce31cec292edc803160d607a3faaf6 URL: https://github.com/kamailio/kamailio/commit/c167c4738fce31cec292edc803160d60...

Author: Daniel-Constantin Mierla miconda@gmail.com Committer: Daniel-Constantin Mierla miconda@gmail.com Date: 2023-02-13T20:19:38+01:00

presence: docs for rpc presence.presentity_show command

---

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

---

Diff: https://github.com/kamailio/kamailio/commit/c167c4738fce31cec292edc803160d60... Patch: https://github.com/kamailio/kamailio/commit/c167c4738fce31cec292edc803160d60...

---

diff --git a/src/modules/presence/doc/presence_admin.xml b/src/modules/presence/doc/presence_admin.xml index 0545bbab6a..e2e171a3d1 100644 --- a/src/modules/presence/doc/presence_admin.xml +++ b/src/modules/presence/doc/presence_admin.xml @@ -1392,6 +1392,40 @@ pres_update_watchers("sip:test@kamailio.org", "presence"); ... kamctl rpc presence.presentity_list kamctl rpc presence.presentity_list full +... + </programlisting> + </section> + <section id="presence.rpc.presentity_show"> + <title>presence.presentity_show</title> + <para> + Return the presentity records stored in memory by filtering with username + and/or domain. + </para> + <para> + Name: <emphasis>presence.presentity_show</emphasis> + </para> + <para>Parameters:</para> + <itemizedlist> + <listitem> + <para>mode - it can be 'basic' or 'full' to print a selection or + all the fields of presentity record.</para> + </listitem> + <listitem> + <para>user - username to match presentity records, use '*' to + match any username.</para> + </listitem> + <listitem> + <para>domain - the value to match the domain of the presentity + records, use '*' to match any domain.</para> + </listitem> + </itemizedlist> + <para> + RPC Command Format: + </para> + <programlisting format="linespecific"> +... +kamctl rpc presence.presentity_show basic alice sipserver.com +kamctl rpc presence.presentity_list full * sipserver.com ... </programlisting> </section>