Browse code

presence: documente new parameters xavp_cfg and retrieve_order

Daniel-Constantin Mierla authored on 26/03/2015 20:18:21
Showing 1 changed files
... ...
@@ -698,6 +698,63 @@ modparam("presence", "subs_remove_match", 1)
698 698
 </programlisting>
699 699
 	    </example>
700 700
 	</section>
701
+	<section id="presence.p.xavp_cfg">
702
+    <title><varname>xavp_cfg</varname> (str)</title>
703
+    <para>
704
+		The name of the xavp to be used to specify attributes for internal
705
+		processing of presence module.
706
+    </para>
707
+    <para>
708
+		Inner attributes inside xavp can be:
709
+    </para>
710
+    <itemizedlist>
711
+        <listitem>
712
+			<para><emphasis>priority</emphasis> - integer value to set the
713
+			priority of the presence document (higher value, higher priority).
714
+			It can set the order of the aggregated presence documents sent by
715
+			NOTIFY (first the document with higher priority). If xavp_cfg
716
+			parameter is set but this attribute is not in the avp,
717
+			the priority of the presence document is based on timestamp,
718
+			so newer documents have higher priority.</para>
719
+        </listitem>
720
+     </itemizedlist>
721
+    <para>
722
+        Default value is <emphasis>empty</emphasis> (not set).
723
+    </para>
724
+    <example>
725
+        <title>Set <varname>xavp_cfg</varname> parameter</title>
726
+        <programlisting format="linespecific">
727
+...
728
+modparam("presence", "xavp_cfg", "pres")
729
+...
730
+if(is_method("PUBLISH")) {
731
+    $xavp(pres=>priority) = 100;
732
+}
733
+...
734
+</programlisting>
735
+    </example>
736
+	</section>
737
+
738
+	<section id="presence.p.retrieve_order">
739
+	    <title><varname>retrieve_order</varname> (int)</title>
740
+	    <para>
741
+		If set to 0, presentity records are retrieve by received_time order.
742
+		if set to 1, presentity records are retrieve by priority order.
743
+	    </para>
744
+	    <para>
745
+		<emphasis>
746
+		    Default value is 0.
747
+		</emphasis>
748
+	    </para>
749
+	    <example>
750
+		<title>Set <varname>retrieve_order</varname> parameter</title>
751
+		<programlisting format="linespecific">
752
+...
753
+modparam("presence", "retrieve_order", 1)
754
+...
755
+</programlisting>
756
+	    </example>
757
+	</section>
701 758
 
702 759
 </section>
703 760