Browse code

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

Kamailio Dev authored on 18/01/2022 19:31:18
Showing 6 changed files
... ...
@@ -22,6 +22,7 @@ Marius-Ovidiu Bucur
22 22
         3. Parameters
23 23
 
24 24
               3.1. use_partial_states (int)
25
+              3.2. default_expires (int)
25 26
 
26 27
         4. MI Commands
27 28
 
... ...
@@ -30,6 +31,7 @@ Marius-Ovidiu Bucur
30 31
    List of Examples
31 32
 
32 33
    1.1. Set use_partial_states parameter
34
+   1.2. Set default_expires parameter
33 35
 
34 36
 Chapter 1. Admin Guide
35 37
 
... ...
@@ -44,6 +46,7 @@ Chapter 1. Admin Guide
44 46
    3. Parameters
45 47
 
46 48
         3.1. use_partial_states (int)
49
+        3.2. default_expires (int)
47 50
 
48 51
    4. MI Commands
49 52
 
... ...
@@ -76,6 +79,7 @@ Chapter 1. Admin Guide
76 79
 3. Parameters
77 80
 
78 81
    3.1. use_partial_states (int)
82
+   3.2. default_expires (int)
79 83
 
80 84
 3.1. use_partial_states (int)
81 85
 
... ...
@@ -88,6 +92,18 @@ Chapter 1. Admin Guide
88 92
 modparam("presence_conference", "use_partial_states", 0)
89 93
 ...
90 94
 
95
+3.2. default_expires (int)
96
+
97
+   The default expires value used when missing from SUBSCRIBE message (in
98
+   seconds).
99
+
100
+   Default value is “3600”.
101
+
102
+   Example 1.2. Set default_expires parameter
103
+...
104
+modparam("presence_conference", "default_expires", 3600)
105
+...
106
+
91 107
 4. MI Commands
92 108
 
93 109
    4.1. conference_reset
... ...
@@ -37,6 +37,7 @@ Klaus Darilion
37 37
 
38 38
               3.1. force_single_dialog (int)
39 39
               3.2. force_dummy_dialog (int)
40
+              3.3. default_expires (int)
40 41
 
41 42
         4. Functions
42 43
 
... ...
@@ -44,6 +45,7 @@ Klaus Darilion
44 45
 
45 46
    1.1. Set parameter
46 47
    1.2. Set parameter
48
+   1.3. Set default_expires parameter
47 49
 
48 50
 Chapter 1. Admin Guide
49 51
 
... ...
@@ -59,6 +61,7 @@ Chapter 1. Admin Guide
59 61
 
60 62
         3.1. force_single_dialog (int)
61 63
         3.2. force_dummy_dialog (int)
64
+        3.3. default_expires (int)
62 65
 
63 66
    4. Functions
64 67
 
... ...
@@ -191,6 +194,7 @@ alice@example    server     server     bob@example   watcher@example
191 194
 
192 195
    3.1. force_single_dialog (int)
193 196
    3.2. force_dummy_dialog (int)
197
+   3.3. default_expires (int)
194 198
 
195 199
 3.1. force_single_dialog (int)
196 200
 
... ...
@@ -230,6 +234,18 @@ modparam("presence_dialoginfo", "force_single_dialog", 1)
230 234
 modparam("presence_dialoginfo", "force_dummy_dialog", 1)
231 235
 ...
232 236
 
237
+3.3. default_expires (int)
238
+
239
+   The default expires value used when missing from SUBSCRIBE message (in
240
+   seconds).
241
+
242
+   Default value is “3600”.
243
+
244
+   Example 1.3. Set default_expires parameter
245
+...
246
+modparam("presence_dialoginfo", "default_expires", 3600)
247
+...
248
+
233 249
 4. Functions
234 250
 
235 251
    None to be used in configuration file.
... ...
@@ -24,8 +24,15 @@ Juha Heinanen
24 24
               2.2. External Libraries or Applications
25 25
 
26 26
         3. Parameters
27
+
28
+              3.1. default_expires (int)
29
+
27 30
         4. Functions
28 31
 
32
+   List of Examples
33
+
34
+   1.1. Set default_expires parameter
35
+
29 36
 Chapter 1. Admin Guide
30 37
 
31 38
    Table of Contents
... ...
@@ -37,6 +44,9 @@ Chapter 1. Admin Guide
37 44
         2.2. External Libraries or Applications
38 45
 
39 46
    3. Parameters
47
+
48
+        3.1. default_expires (int)
49
+
40 50
    4. Functions
41 51
 
42 52
 1. Overview
... ...
@@ -73,7 +83,19 @@ Chapter 1. Admin Guide
73 83
 
74 84
 3. Parameters
75 85
 
76
-   None.
86
+   3.1. default_expires (int)
87
+
88
+3.1. default_expires (int)
89
+
90
+   The default expires value used when missing from SUBSCRIBE message (in
91
+   seconds).
92
+
93
+   Default value is “3600”.
94
+
95
+   Example 1.1. Set default_expires parameter
96
+            ...
97
+            modparam("presence_mwi", "default_expires", 3600)
98
+            ...
77 99
 
78 100
 4. Functions
79 101
 
... ...
@@ -28,8 +28,15 @@ Alex Balashov
28 28
               2.2. External Libraries or Applications
29 29
 
30 30
         3. Exported Parameters
31
+
32
+              3.1. default_expires (int)
33
+
31 34
         4. Exported Functions
32 35
 
36
+   List of Examples
37
+
38
+   1.1. Set default_expires parameter
39
+
33 40
 Chapter 1. Admin Guide
34 41
 
35 42
    Table of Contents
... ...
@@ -41,6 +48,9 @@ Chapter 1. Admin Guide
41 48
         2.2. External Libraries or Applications
42 49
 
43 50
    3. Exported Parameters
51
+
52
+        3.1. default_expires (int)
53
+
44 54
    4. Exported Functions
45 55
 
46 56
 1. Overview
... ...
@@ -78,7 +88,19 @@ Chapter 1. Admin Guide
78 88
 
79 89
 3. Exported Parameters
80 90
 
81
-   None.
91
+   3.1. default_expires (int)
92
+
93
+3.1. default_expires (int)
94
+
95
+   The default expires value used when missing from SUBSCRIBE message (in
96
+   seconds).
97
+
98
+   Default value is “3600”.
99
+
100
+   Example 1.1. Set default_expires parameter
101
+            ...
102
+            modparam("presence_profile", "default_expires", 3600)
103
+            ...
82 104
 
83 105
 4. Exported Functions
84 106
 
... ...
@@ -24,7 +24,15 @@ Carsten Bock
24 24
               2.1. Kamailio Modules
25 25
               2.2. External Libraries or Applications
26 26
 
27
-        3. Functions
27
+        3. Parameters
28
+
29
+              3.1. default_expires (int)
30
+
31
+        4. Functions
32
+
33
+   List of Examples
34
+
35
+   1.1. Set default_expires parameter
28 36
 
29 37
 Chapter 1. Admin Guide
30 38
 
... ...
@@ -36,7 +44,11 @@ Chapter 1. Admin Guide
36 44
         2.1. Kamailio Modules
37 45
         2.2. External Libraries or Applications
38 46
 
39
-   3. Functions
47
+   3. Parameters
48
+
49
+        3.1. default_expires (int)
50
+
51
+   4. Functions
40 52
 
41 53
 1. Overview
42 54
 
... ...
@@ -71,6 +83,22 @@ Chapter 1. Admin Guide
71 83
 
72 84
    None.
73 85
 
74
-3. Functions
86
+3. Parameters
87
+
88
+   3.1. default_expires (int)
89
+
90
+3.1. default_expires (int)
91
+
92
+   The default expires value used when missing from SUBSCRIBE message (in
93
+   seconds).
94
+
95
+   Default value is “3600”.
96
+
97
+   Example 1.1. Set default_expires parameter
98
+        ...
99
+        modparam("presence_reginfo", "default_expires", 3600)
100
+        ...
101
+
102
+4. Functions
75 103
 
76 104
    None to be used in configuration file.
... ...
@@ -38,6 +38,7 @@ Anca-Maria Vamanu
38 38
               3.13. force_presence_single_body(int)
39 39
               3.14. presence_single_body_priorities(str)
40 40
               3.15. presence_single_body_lookup_element(str)
41
+              3.16. default_expires (int)
41 42
 
42 43
         4. Functions
43 44
 
... ...
@@ -65,8 +66,9 @@ Anca-Maria Vamanu
65 66
    1.13. Set force_presence_single_body parameter
66 67
    1.14. Set presence_single_body_priorities parameter
67 68
    1.15. Set presence_single_body_lookup_element parameter
68
-   1.16. pres_check_basic usage
69
-   1.17. pres_check_activities usage
69
+   1.16. Set default_expires parameter
70
+   1.17. pres_check_basic usage
71
+   1.18. pres_check_activities usage
70 72
 
71 73
 Chapter 1. Admin Guide
72 74
 
... ...
@@ -95,6 +97,7 @@ Chapter 1. Admin Guide
95 97
         3.13. force_presence_single_body(int)
96 98
         3.14. presence_single_body_priorities(str)
97 99
         3.15. presence_single_body_lookup_element(str)
100
+        3.16. default_expires (int)
98 101
 
99 102
    4. Functions
100 103
 
... ...
@@ -157,6 +160,7 @@ Chapter 1. Admin Guide
157 160
    3.13. force_presence_single_body(int)
158 161
    3.14. presence_single_body_priorities(str)
159 162
    3.15. presence_single_body_lookup_element(str)
163
+   3.16. default_expires (int)
160 164
 
161 165
 3.1. db_url(str)
162 166
 
... ...
@@ -369,6 +373,18 @@ modparam("presence_xml", "presence_single_body_priorities", "Offline|Online|Busy
369 373
 modparam("presence_xml", "presence_single_body_lookup_element", "status")
370 374
 ...
371 375
 
376
+3.16. default_expires (int)
377
+
378
+   The default expires value used when missing from SUBSCRIBE message (in
379
+   seconds).
380
+
381
+   Default value is “3600”.
382
+
383
+   Example 1.16. Set default_expires parameter
384
+...
385
+modparam("presence_xml", "default_expires", 3600)
386
+...
387
+
372 388
 4. Functions
373 389
 
374 390
    4.1. pres_check_basic(presentity_uri, status)
... ...
@@ -385,7 +401,7 @@ modparam("presence_xml", "presence_single_body_lookup_element", "status")
385 401
      * 1 - if a match is found.
386 402
      * -1 - if a match is not found.
387 403
 
388
-   Example 1.16. pres_check_basic usage
404
+   Example 1.17. pres_check_basic usage
389 405
 ...
390 406
     if (pres_check_basic("$ru", "open")) {
391 407
         ...
... ...
@@ -409,7 +425,7 @@ modparam("presence_xml", "presence_single_body_lookup_element", "status")
409 425
      * -1 - if a match is not found.
410 426
      * -2 - if /presence/person or /presence/person/activity do not exist.
411 427
 
412
-   Example 1.17. pres_check_activities usage
428
+   Example 1.18. pres_check_activities usage
413 429
 ...
414 430
     if (pres_check_basic("$ru", "open")) {
415 431
         pres_check_activities("$ru", "unknown");