Kaynağa Gözat

presence: docs for rpc command to update watchers

Daniel-Constantin Mierla 6 yıl önce
ebeveyn
işleme
2fb642bd31
1 değiştirilmiş dosya ile 29 ekleme ve 0 silme
  1. 29 0
      src/modules/presence/doc/presence_admin.xml

+ 29 - 0
src/modules/presence/doc/presence_admin.xml

@@ -1266,6 +1266,35 @@ pres_update_watchers("sip:[email protected]", "presence");
 ...
 </programlisting>
 	</section>
+	<section id="presence.rpc.updateWatchers">
+	  <title>presence.updateWatchers</title>
+	  <para>
+		Manually triggers updates to watchers (for example,
+		after the contents of XCAP docs has been updated).
+	  </para>
+	  <para>
+		Name: <emphasis>presence.updateWatchers</emphasis>
+	  </para>
+	  <para>Parameters:</para>
+		<itemizedlist>
+			<listitem>
+				<para>uri - the uri of the user who made the changes
+				and whose watchers 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; presence.updateWatchers sip:[email protected] presence
+...
+	  </programlisting>
+	</section>
 </section>
 
 <section>