Module: kamailio Branch: master Commit: 867294f79f30b1b737d78e623514b4b14475f9cf URL: https://github.com/kamailio/kamailio/commit/867294f79f30b1b737d78e623514b4b… Author: Kamailio Dev <kamailio.dev(a)kamailio.org> Committer: Kamailio Dev <kamailio.dev(a)kamailio.org> Date: 2019-11-05T12:31:21+01:00 modules: readme files regenerated - presence_xml ... [skip ci] --- Modified: src/modules/presence_xml/README --- Diff: https://github.com/kamailio/kamailio/commit/867294f79f30b1b737d78e623514b4b… Patch: https://github.com/kamailio/kamailio/commit/867294f79f30b1b737d78e623514b4b… --- diff --git a/src/modules/presence_xml/README b/src/modules/presence_xml/README index 2098395373..9f7a80ba05 100644 --- a/src/modules/presence_xml/README +++ b/src/modules/presence_xml/README @@ -34,6 +34,9 @@ Anca-Maria Vamanu 3.9. passive_mode(int) 3.10. xcapauth_userdel_reason(str) 3.11. force_dummy_presence(int) + 3.12. force_presence_single_body(int) + 3.13. presence_single_body_priorities(str) + 3.14. presence_single_body_lookup_element(str) 4. Functions @@ -57,8 +60,11 @@ Anca-Maria Vamanu 1.9. Set passive_mode parameter 1.10. Set xcapauth_userdel_reason parameter 1.11. Set force_dummy_presence parameter - 1.12. pres_check_basic usage - 1.13. pres_check_activities usage + 1.12. Set force_presence_single_body parameter + 1.13. Set presence_single_body_priorities parameter + 1.14. Set presence_single_body_lookup_element parameter + 1.15. pres_check_basic usage + 1.16. pres_check_activities usage Chapter 1. Admin Guide @@ -83,6 +89,9 @@ Chapter 1. Admin Guide 3.9. passive_mode(int) 3.10. xcapauth_userdel_reason(str) 3.11. force_dummy_presence(int) + 3.12. force_presence_single_body(int) + 3.13. presence_single_body_priorities(str) + 3.14. presence_single_body_lookup_element(str) 4. Functions @@ -141,6 +150,9 @@ Chapter 1. Admin Guide 3.9. passive_mode(int) 3.10. xcapauth_userdel_reason(str) 3.11. force_dummy_presence(int) + 3.12. force_presence_single_body(int) + 3.13. presence_single_body_priorities(str) + 3.14. presence_single_body_lookup_element(str) 3.1. db_url(str) @@ -298,6 +310,50 @@ modparam("presence_xml", "xcapauth_userdel_reason", "rejected") modparam("presence_xml", "force_dummy_presence", 1) ... +3.12. force_presence_single_body(int) + + Set this parameter to enable single body notify. One presentity can + have multiple dialogs and will by default notify all the dialogs and + this can be a problem when dealing with large ring-groups or + attendants, use this parameter to only send one body. Look at + presence_single_body_priorities and presence_single_body_lookup_element + to customize the behaviour. + + Default value: “0”. + + Example 1.12. Set force_presence_single_body parameter +... +modparam("presence_xml", "force_presence_single_body", 1) +... + +3.13. presence_single_body_priorities(str) + + Change this parameter to set the priorities when choosing the dialog + that will be the final. + + Importance is left to right. + + Default value: “Available|Ringing|On the Phone”. + + Example 1.13. Set presence_single_body_priorities parameter +... +modparam("presence_xml", "presence_single_body_priorities", "Offline|Online|Busy +|Really Busy") +... + +3.14. presence_single_body_lookup_element(str) + + Set the name of the element that should be used to get the priority. If + the value obtained is not in the list of + presence_single_body_priorities the priority is 0. + + Default value: “note”. + + Example 1.14. Set presence_single_body_lookup_element parameter +... +modparam("presence_xml", "presence_single_body_lookup_element", "status") +... + 4. Functions 4.1. pres_check_basic(presentity_uri, status) @@ -314,7 +370,7 @@ modparam("presence_xml", "force_dummy_presence", 1) * 1 - if a match is found. * -1 - if a match is not found. - Example 1.12. pres_check_basic usage + Example 1.15. pres_check_basic usage ... if (pres_check_basic("$ru", "open")) { ... @@ -338,7 +394,7 @@ modparam("presence_xml", "force_dummy_presence", 1) * -1 - if a match is not found. * -2 - if /presence/person or /presence/person/activity do not exist. - Example 1.13. pres_check_activities usage + Example 1.16. pres_check_activities usage ... if (pres_check_basic("$ru", "open")) { pres_check_activities("$ru", "unknown");