Browse code

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

Kamailio Dev authored on 15/11/2021 18:16:14
Showing 1 changed files
... ...
@@ -68,6 +68,7 @@ Juha Heinanen
68 68
               3.35. pres_subs_mode (integer)
69 69
               3.36. delete_same_subs (integer)
70 70
               3.37. timer_mode (integer)
71
+              3.38. subs_respond_200 (integer)
71 72
 
72 73
         4. Functions
73 74
 
... ...
@@ -157,15 +158,16 @@ Juha Heinanen
157 158
    1.35. Set pres_subs_mode parameter
158 159
    1.36. Set delete_same_subs parameter
159 160
    1.37. Set timer_mode parameter
160
-   1.38. handle_publish usage
161
-   1.39. handle_subscribe usage
162
-   1.40. pres_auth_status usage
163
-   1.41. pres_has_subscribers usage
164
-   1.42. pres_refresh_watchers usage
165
-   1.43. pres_update_watchers usage
166
-   1.44. $subs(name) usage
167
-   1.45. $notify_reply(name) usage
161
+   1.38. Set subs_respond_200 parameter
162
+   1.39. handle_publish usage
163
+   1.40. handle_subscribe usage
164
+   1.41. pres_auth_status usage
165
+   1.42. pres_has_subscribers usage
166
+   1.43. pres_refresh_watchers usage
167
+   1.44. pres_update_watchers usage
168
+   1.45. $subs(name) usage
168 169
    1.46. $notify_reply(name) usage
170
+   1.47. $notify_reply(name) usage
169 171
    2.1. presence_api_t structure
170 172
 
171 173
 Chapter 1. Admin Guide
... ...
@@ -217,6 +219,7 @@ Chapter 1. Admin Guide
217 219
         3.35. pres_subs_mode (integer)
218 220
         3.36. delete_same_subs (integer)
219 221
         3.37. timer_mode (integer)
222
+        3.38. subs_respond_200 (integer)
220 223
 
221 224
    4. Functions
222 225
 
... ...
@@ -328,6 +331,7 @@ Chapter 1. Admin Guide
328 331
    3.35. pres_subs_mode (integer)
329 332
    3.36. delete_same_subs (integer)
330 333
    3.37. timer_mode (integer)
334
+   3.38. subs_respond_200 (integer)
331 335
 
332 336
 3.1. db_url(str)
333 337
 
... ...
@@ -892,6 +896,19 @@ modparam("presence", "delete_same_subs", 1)
892 896
 modparam("presence", "timer_mode", 0)
893 897
 ...
894 898
 
899
+3.38. subs_respond_200 (integer)
900
+
901
+   Specify the response code for accepted SUBSCRIBE requests. If set to 0,
902
+   202 Accepted will be returned. If set to 1, 200 OK will be returned
903
+   instead, in conformance to RFC6665 which prohibits 202 responses.
904
+
905
+   Default value is 0.
906
+
907
+   Example 1.38. Set subs_respond_200 parameter
908
+...
909
+modparam("presence", "subs_respond_200", 1)
910
+...
911
+
895 912
 4. Functions
896 913
 
897 914
    4.1. handle_publish([sender_uri])
... ...
@@ -921,7 +938,7 @@ modparam("presence", "timer_mode", 0)
921 938
 
922 939
    The module sends an appropriate stateless reply in all cases.
923 940
 
924
-   Example 1.38. handle_publish usage
941
+   Example 1.39. handle_publish usage
925 942
 ...
926 943
         if(is_method("PUBLISH"))
927 944
         {
... ...
@@ -952,7 +969,7 @@ modparam("presence", "timer_mode", 0)
952 969
 
953 970
    The module sends an appropriate stateless reply in all cases.
954 971
 
955
-   Example 1.39. handle_subscribe usage
972
+   Example 1.40. handle_subscribe usage
956 973
 ...
957 974
 if(method=="SUBSCRIBE")
958 975
     handle_subscribe();
... ...
@@ -971,7 +988,7 @@ if(method=="SUBSCRIBE")
971 988
 
972 989
    This function can be used from REQUEST_ROUTE.
973 990
 
974
-   Example 1.40. pres_auth_status usage
991
+   Example 1.41. pres_auth_status usage
975 992
 ...
976 993
 if (method=="MESSAGE") {
977 994
     pres_auth_status("$fu", $ru");
... ...
@@ -989,7 +1006,7 @@ if (method=="MESSAGE") {
989 1006
 
990 1007
    This function can be used from ANY_ROUTE.
991 1008
 
992
-   Example 1.41. pres_has_subscribers usage
1009
+   Example 1.42. pres_has_subscribers usage
993 1010
 ...
994 1011
 if(pres_has_subscribers($var(uri), "message-summary"))
995 1012
     # do something...;
... ...
@@ -1019,7 +1036,7 @@ if(pres_has_subscribers($var(uri), "message-summary"))
1019 1036
 
1020 1037
    This function can be used from ANY_ROUTE.
1021 1038
 
1022
-   Example 1.42. pres_refresh_watchers usage
1039
+   Example 1.43. pres_refresh_watchers usage
1023 1040
 ...
1024 1041
 pres_refresh_watchers("sip:test@kamailio.org", "presence", 1);
1025 1042
 ...
... ...
@@ -1037,7 +1054,7 @@ pres_refresh_watchers("sip:test@kamailio.org", "presence", 1);
1037 1054
 
1038 1055
    This function can be used from ANY_ROUTE.
1039 1056
 
1040
-   Example 1.43. pres_update_watchers usage
1057
+   Example 1.44. pres_update_watchers usage
1041 1058
 ...
1042 1059
 pres_update_watchers("sip:test@kamailio.org", "presence");
1043 1060
 ...
... ...
@@ -1164,7 +1181,7 @@ kamctl rpc presence.presentity_list full
1164 1181
      * flags
1165 1182
      * user_agent
1166 1183
 
1167
-   Example 1.44. $subs(name) usage
1184
+   Example 1.45. $subs(name) usage
1168 1185
 ...
1169 1186
 if(handle_subscription())
1170 1187
 {
... ...
@@ -1180,7 +1197,7 @@ if(handle_subscription())
1180 1197
 
1181 1198
    The “attr” can be any pseudo var that accesses attributes of msg
1182 1199
 
1183
-   Example 1.45. $notify_reply(name) usage
1200
+   Example 1.46. $notify_reply(name) usage
1184 1201
 ...
1185 1202
 event_route[presence:notify-reply]
1186 1203
 {
... ...
@@ -1196,7 +1213,7 @@ event_route[presence:notify-reply]
1196 1213
 
1197 1214
    Fired after notify reply is received or timeout.
1198 1215
 
1199
-   Example 1.46. $notify_reply(name) usage
1216
+   Example 1.47. $notify_reply(name) usage
1200 1217
 ...
1201 1218
 event_route[presence:notify-reply]
1202 1219
 {