rls: docs for rpc command rls.update_subs
authorDaniel-Constantin Mierla <miconda@gmail.com>
Sat, 22 Jun 2019 14:34:41 +0000 (16:34 +0200)
committerDaniel-Constantin Mierla <miconda@gmail.com>
Sat, 22 Jun 2019 14:39:46 +0000 (16:39 +0200)
src/modules/rls/doc/rls_admin.xml

index 69d898d..ab3b2d1 100644 (file)
@@ -778,6 +778,36 @@ Within event_route[xhttp:request]:
 ...
          </programlisting>
        </section>
+       <section id="rls.rpc.update_subs">
+         <title>rls.update_subs</title>
+         <para>
+               Manually triggers updates to resource list subscriptions (for example,
+               after the contents of a resource list has changes).
+         </para>
+         <para>
+               Name: <emphasis>rls.cleanup</emphasis>
+         </para>
+         <para>Parameters:</para>
+               <itemizedlist>
+                       <listitem>
+                               <para>uri - the uri of the user who made the change
+                               and whose resource list subscriptions should be
+                               updated</para>
+                       </listitem>
+                       <listitem>
+                               <para>event - the event package (e.g. presence).
+                               </para>
+                       </listitem>
+               </itemizedlist>
+         <para>
+               RPC Command Format:
+         </para>
+         <programlisting  format="linespecific">
+...
+&kamcmd; rls.update_subs sip:alice@domain.com presence
+...
+         </programlisting>
+       </section>
 </section>
 
 <section>