Browse code

modules: readme files regenerated - presence_xml ... [skip ci]

Kamailio Dev authored on 05/11/2019 11:31:21
Showing 1 changed files
... ...
@@ -34,6 +34,9 @@ Anca-Maria Vamanu
34 34
               3.9. passive_mode(int)
35 35
               3.10. xcapauth_userdel_reason(str)
36 36
               3.11. force_dummy_presence(int)
37
+              3.12. force_presence_single_body(int)
38
+              3.13. presence_single_body_priorities(str)
39
+              3.14. presence_single_body_lookup_element(str)
37 40
 
38 41
         4. Functions
39 42
 
... ...
@@ -57,8 +60,11 @@ Anca-Maria Vamanu
57 57
    1.9. Set passive_mode parameter
58 58
    1.10. Set xcapauth_userdel_reason parameter
59 59
    1.11. Set force_dummy_presence parameter
60
-   1.12. pres_check_basic usage
61
-   1.13. pres_check_activities usage
60
+   1.12. Set force_presence_single_body parameter
61
+   1.13. Set presence_single_body_priorities parameter
62
+   1.14. Set presence_single_body_lookup_element parameter
63
+   1.15. pres_check_basic usage
64
+   1.16. pres_check_activities usage
62 65
 
63 66
 Chapter 1. Admin Guide
64 67
 
... ...
@@ -83,6 +89,9 @@ Chapter 1. Admin Guide
83 83
         3.9. passive_mode(int)
84 84
         3.10. xcapauth_userdel_reason(str)
85 85
         3.11. force_dummy_presence(int)
86
+        3.12. force_presence_single_body(int)
87
+        3.13. presence_single_body_priorities(str)
88
+        3.14. presence_single_body_lookup_element(str)
86 89
 
87 90
    4. Functions
88 91
 
... ...
@@ -141,6 +150,9 @@ Chapter 1. Admin Guide
141 141
    3.9. passive_mode(int)
142 142
    3.10. xcapauth_userdel_reason(str)
143 143
    3.11. force_dummy_presence(int)
144
+   3.12. force_presence_single_body(int)
145
+   3.13. presence_single_body_priorities(str)
146
+   3.14. presence_single_body_lookup_element(str)
144 147
 
145 148
 3.1. db_url(str)
146 149
 
... ...
@@ -298,6 +310,50 @@ modparam("presence_xml", "xcapauth_userdel_reason", "rejected")
298 298
 modparam("presence_xml", "force_dummy_presence", 1)
299 299
 ...
300 300
 
301
+3.12. force_presence_single_body(int)
302
+
303
+   Set this parameter to enable single body notify. One presentity can
304
+   have multiple dialogs and will by default notify all the dialogs and
305
+   this can be a problem when dealing with large ring-groups or
306
+   attendants, use this parameter to only send one body. Look at
307
+   presence_single_body_priorities and presence_single_body_lookup_element
308
+   to customize the behaviour.
309
+
310
+   Default value: “0”.
311
+
312
+   Example 1.12. Set force_presence_single_body parameter
313
+...
314
+modparam("presence_xml", "force_presence_single_body", 1)
315
+...
316
+
317
+3.13. presence_single_body_priorities(str)
318
+
319
+   Change this parameter to set the priorities when choosing the dialog
320
+   that will be the final.
321
+
322
+   Importance is left to right.
323
+
324
+   Default value: “Available|Ringing|On the Phone”.
325
+
326
+   Example 1.13. Set presence_single_body_priorities parameter
327
+...
328
+modparam("presence_xml", "presence_single_body_priorities", "Offline|Online|Busy
329
+|Really Busy")
330
+...
331
+
332
+3.14. presence_single_body_lookup_element(str)
333
+
334
+   Set the name of the element that should be used to get the priority. If
335
+   the value obtained is not in the list of
336
+   presence_single_body_priorities the priority is 0.
337
+
338
+   Default value: “note”.
339
+
340
+   Example 1.14. Set presence_single_body_lookup_element parameter
341
+...
342
+modparam("presence_xml", "presence_single_body_lookup_element", "status")
343
+...
344
+
301 345
 4. Functions
302 346
 
303 347
    4.1. pres_check_basic(presentity_uri, status)
... ...
@@ -314,7 +370,7 @@ modparam("presence_xml", "force_dummy_presence", 1)
314 314
      * 1 - if a match is found.
315 315
      * -1 - if a match is not found.
316 316
 
317
-   Example 1.12. pres_check_basic usage
317
+   Example 1.15. pres_check_basic usage
318 318
 ...
319 319
     if (pres_check_basic("$ru", "open")) {
320 320
         ...
... ...
@@ -338,7 +394,7 @@ modparam("presence_xml", "force_dummy_presence", 1)
338 338
      * -1 - if a match is not found.
339 339
      * -2 - if /presence/person or /presence/person/activity do not exist.
340 340
 
341
-   Example 1.13. pres_check_activities usage
341
+   Example 1.16. pres_check_activities usage
342 342
 ...
343 343
     if (pres_check_basic("$ru", "open")) {
344 344
         pres_check_activities("$ru", "unknown");