modules: readme files regenerated - presence ... [skip ci]
authorKamailio Dev <kamailio.dev@kamailio.org>
Tue, 17 Mar 2020 13:46:18 +0000 (14:46 +0100)
committerKamailio Dev <kamailio.dev@kamailio.org>
Tue, 17 Mar 2020 13:46:18 +0000 (14:46 +0100)
src/modules/presence/README

index a298c0b..2b8b382 100644 (file)
@@ -67,6 +67,7 @@ Juha Heinanen
               3.34. sip_uri_match (int)
               3.35. enable_dmq (integer)
               3.36. pres_subs_mode (integer)
+              3.37. delete_same_subs (integer)
 
         4. Functions
 
@@ -154,15 +155,16 @@ Juha Heinanen
    1.34. Set sip_uri_match parameter
    1.35. Set enable_dmq parameter
    1.36. Set pres_subs_mode parameter
-   1.37. handle_publish usage
-   1.38. handle_subscribe usage
-   1.39. pres_auth_status usage
-   1.40. pres_has_subscribers usage
-   1.41. pres_refresh_watchers usage
-   1.42. pres_update_watchers usage
-   1.43. $subs(name) usage
-   1.44. $notify_reply(name) usage
+   1.37. Set delete_same_subs parameter
+   1.38. handle_publish usage
+   1.39. handle_subscribe usage
+   1.40. pres_auth_status usage
+   1.41. pres_has_subscribers usage
+   1.42. pres_refresh_watchers usage
+   1.43. pres_update_watchers usage
+   1.44. $subs(name) usage
    1.45. $notify_reply(name) usage
+   1.46. $notify_reply(name) usage
    2.1. presence_api_t structure
 
 Chapter 1. Admin Guide
@@ -213,6 +215,7 @@ Chapter 1. Admin Guide
         3.34. sip_uri_match (int)
         3.35. enable_dmq (integer)
         3.36. pres_subs_mode (integer)
+        3.37. delete_same_subs (integer)
 
    4. Functions
 
@@ -322,6 +325,7 @@ Chapter 1. Admin Guide
    3.34. sip_uri_match (int)
    3.35. enable_dmq (integer)
    3.36. pres_subs_mode (integer)
+   3.37. delete_same_subs (integer)
 
 3.1. db_url(str)
 
@@ -869,6 +873,17 @@ modparam("presence", "enable_dmq", 1)
 modparam("presence", "pres_subs_mode", 0)
 ...
 
+3.37. delete_same_subs (integer)
+
+   Enable deleting of subscriptions with the same presence uri and callid.
+
+   Default value is 0 (disabled behavior).
+
+   Example 1.37. Set delete_same_subs parameter
+...
+modparam("presence", "delete_same_subs", 1)
+...
+
 4. Functions
 
    4.1. handle_publish([sender_uri])
@@ -898,7 +913,7 @@ modparam("presence", "pres_subs_mode", 0)
 
    The module sends an appropriate stateless reply in all cases.
 
-   Example 1.37. handle_publish usage
+   Example 1.38. handle_publish usage
 ...
         if(is_method("PUBLISH"))
         {
@@ -929,7 +944,7 @@ modparam("presence", "pres_subs_mode", 0)
 
    The module sends an appropriate stateless reply in all cases.
 
-   Example 1.38. handle_subscribe usage
+   Example 1.39. handle_subscribe usage
 ...
 if(method=="SUBSCRIBE")
     handle_subscribe();
@@ -948,7 +963,7 @@ if(method=="SUBSCRIBE")
 
    This function can be used from REQUEST_ROUTE.
 
-   Example 1.39. pres_auth_status usage
+   Example 1.40. pres_auth_status usage
 ...
 if (method=="MESSAGE") {
     pres_auth_status("$fu", $ru");
@@ -966,7 +981,7 @@ if (method=="MESSAGE") {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.40. pres_has_subscribers usage
+   Example 1.41. pres_has_subscribers usage
 ...
 if(pres_has_subscribers($var(uri), "message-summary"))
     # do something...;
@@ -996,7 +1011,7 @@ if(pres_has_subscribers($var(uri), "message-summary"))
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.41. pres_refresh_watchers usage
+   Example 1.42. pres_refresh_watchers usage
 ...
 pres_refresh_watchers("sip:test@kamailio.org", "presence", 1);
 ...
@@ -1014,7 +1029,7 @@ pres_refresh_watchers("sip:test@kamailio.org", "presence", 1);
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.42. pres_update_watchers usage
+   Example 1.43. pres_update_watchers usage
 ...
 pres_update_watchers("sip:test@kamailio.org", "presence");
 ...
@@ -1123,7 +1138,7 @@ kamcmd presence.updateWatchers sip:alice@domain.com presence
      * flags
      * user_agent
 
-   Example 1.43. $subs(name) usage
+   Example 1.44. $subs(name) usage
 ...
 if(handle_subscription())
 {
@@ -1139,7 +1154,7 @@ if(handle_subscription())
 
    The “attr” can be any pseudo var that accesses attributes of msg
 
-   Example 1.44. $notify_reply(name) usage
+   Example 1.45. $notify_reply(name) usage
 ...
 event_route[presence:notify-reply]
 {
@@ -1155,7 +1170,7 @@ event_route[presence:notify-reply]
 
    Fired after notify reply is received or timeout.
 
-   Example 1.45. $notify_reply(name) usage
+   Example 1.46. $notify_reply(name) usage
 ...
 event_route[presence:notify-reply]
 {