Browse code

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

Kamailio Dev authored on 16/06/2022 10:31:15
Showing 1 changed files
... ...
@@ -54,15 +54,17 @@ Frederic Gaisnon
54 54
               5.8. disable_caller_publish_flag (int)
55 55
               5.9. disable_callee_publish_flag (int)
56 56
               5.10. use_pubruri_avps (int)
57
-              5.11. pubruri_caller_avp (str)
58
-              5.12. pubruri_callee_avp (str)
59
-              5.13. pubruri_caller_dlg_var (str)
60
-              5.14. pubruri_callee_dlg_var (str)
61
-              5.15. callee_trying (int)
62
-              5.16. caller_entity_when_publish_disabled (int)
63
-              5.17. callee_entity_when_publish_disabled (int)
64
-              5.18. publish_dialog_req_within (int)
65
-              5.19. attribute_display (int)
57
+              5.11. refresh_pubruri_avps_flag (int)
58
+              5.12. pubruri_caller_avp (str)
59
+              5.13. pubruri_callee_avp (str)
60
+              5.14. pubruri_caller_dlg_var (str)
61
+              5.15. pubruri_callee_dlg_var (str)
62
+              5.16. callee_trying (int)
63
+              5.17. caller_entity_when_publish_disabled (int)
64
+              5.18. callee_entity_when_publish_disabled (int)
65
+              5.19. publish_dialog_req_within (int)
66
+              5.20. local_identity_dlg_var (str)
67
+              5.21. attribute_display (int)
66 68
 
67 69
         6. Functions
68 70
 
... ...
@@ -78,15 +80,17 @@ Frederic Gaisnon
78 80
    1.8. Set disable_caller_publish_flag parameter
79 81
    1.9. Set disable_callee_publish_flag parameter
80 82
    1.10. Set use_pubruri_avps parameter
81
-   1.11. Set pubruri_caller_avp parameter
82
-   1.12. Set pubruri_callee_avp parameter
83
-   1.13. Set pubruri_caller_avp parameter
84
-   1.14. Set pubruri_callee_dlg_var parameter
85
-   1.15. Set callee_trying parameter
86
-   1.16. Set caller_entity_when_publish_disabled parameter
87
-   1.17. Set callee_entity_when_publish_disabled parameter
88
-   1.18. Set publish_dialog_req_within parameter
89
-   1.19. Set attribute_display parameter
83
+   1.11. Set refresh_pubruri_avps_flag parameter
84
+   1.12. Set pubruri_caller_avp parameter
85
+   1.13. Set pubruri_callee_avp parameter
86
+   1.14. Set pubruri_caller_avp parameter
87
+   1.15. Set pubruri_callee_dlg_var parameter
88
+   1.16. Set callee_trying parameter
89
+   1.17. Set caller_entity_when_publish_disabled parameter
90
+   1.18. Set callee_entity_when_publish_disabled parameter
91
+   1.19. Set publish_dialog_req_within parameter
92
+   1.20. Set local_identity_dlg_var parameter
93
+   1.21. Set attribute_display parameter
90 94
 
91 95
 Chapter 1. Admin Guide
92 96
 
... ...
@@ -112,15 +116,17 @@ Chapter 1. Admin Guide
112 116
         5.8. disable_caller_publish_flag (int)
113 117
         5.9. disable_callee_publish_flag (int)
114 118
         5.10. use_pubruri_avps (int)
115
-        5.11. pubruri_caller_avp (str)
116
-        5.12. pubruri_callee_avp (str)
117
-        5.13. pubruri_caller_dlg_var (str)
118
-        5.14. pubruri_callee_dlg_var (str)
119
-        5.15. callee_trying (int)
120
-        5.16. caller_entity_when_publish_disabled (int)
121
-        5.17. callee_entity_when_publish_disabled (int)
122
-        5.18. publish_dialog_req_within (int)
123
-        5.19. attribute_display (int)
119
+        5.11. refresh_pubruri_avps_flag (int)
120
+        5.12. pubruri_caller_avp (str)
121
+        5.13. pubruri_callee_avp (str)
122
+        5.14. pubruri_caller_dlg_var (str)
123
+        5.15. pubruri_callee_dlg_var (str)
124
+        5.16. callee_trying (int)
125
+        5.17. caller_entity_when_publish_disabled (int)
126
+        5.18. callee_entity_when_publish_disabled (int)
127
+        5.19. publish_dialog_req_within (int)
128
+        5.20. local_identity_dlg_var (str)
129
+        5.21. attribute_display (int)
124 130
 
125 131
    6. Functions
126 132
 
... ...
@@ -299,15 +305,17 @@ Chapter 1. Admin Guide
299 305
    5.8. disable_caller_publish_flag (int)
300 306
    5.9. disable_callee_publish_flag (int)
301 307
    5.10. use_pubruri_avps (int)
302
-   5.11. pubruri_caller_avp (str)
303
-   5.12. pubruri_callee_avp (str)
304
-   5.13. pubruri_caller_dlg_var (str)
305
-   5.14. pubruri_callee_dlg_var (str)
306
-   5.15. callee_trying (int)
307
-   5.16. caller_entity_when_publish_disabled (int)
308
-   5.17. callee_entity_when_publish_disabled (int)
309
-   5.18. publish_dialog_req_within (int)
310
-   5.19. attribute_display (int)
308
+   5.11. refresh_pubruri_avps_flag (int)
309
+   5.12. pubruri_caller_avp (str)
310
+   5.13. pubruri_callee_avp (str)
311
+   5.14. pubruri_caller_dlg_var (str)
312
+   5.15. pubruri_callee_dlg_var (str)
313
+   5.16. callee_trying (int)
314
+   5.17. caller_entity_when_publish_disabled (int)
315
+   5.18. callee_entity_when_publish_disabled (int)
316
+   5.19. publish_dialog_req_within (int)
317
+   5.20. local_identity_dlg_var (str)
318
+   5.21. attribute_display (int)
311 319
 
312 320
 5.1. include_callid (int)
313 321
 
... ...
@@ -444,7 +452,19 @@ modparam("pua_dialoginfo", "disable_callee_publish_flag", 10)
444 452
 modparam("pua_dialoginfo", "use_pubruri_avps", 1)
445 453
 ...
446 454
 
447
-5.11. pubruri_caller_avp (str)
455
+5.11. refresh_pubruri_avps_flag (int)
456
+
457
+   If use_pubruri_avps is enabled, this message flag indicates whether to
458
+   refresh R-Uri from avps before sending the PUBLISH requests.
459
+
460
+   Default value is “-1”.
461
+
462
+   Example 1.11. Set refresh_pubruri_avps_flag parameter
463
+...
464
+modparam("pua_dialoginfo", "refresh_pubruri_avps_flag", 11)
465
+...
466
+
467
+5.12. pubruri_caller_avp (str)
448 468
 
449 469
    If use_pubruri_avps is enabled, PUBLISH-requests reporting
450 470
    dialog-information about the caller (entity=caller) are sent using the
... ...
@@ -455,12 +475,12 @@ modparam("pua_dialoginfo", "use_pubruri_avps", 1)
455 475
 
456 476
    Default value is “NULL”.
457 477
 
458
-   Example 1.11. Set pubruri_caller_avp parameter
478
+   Example 1.12. Set pubruri_caller_avp parameter
459 479
 ...
460 480
 modparam("pua_dialoginfo", "pubruri_caller_avp", "$avp(s:puburis_caller)")
461 481
 ...
462 482
 
463
-5.12. pubruri_callee_avp (str)
483
+5.13. pubruri_callee_avp (str)
464 484
 
465 485
    If use_pubruri_avps is enabled, PUBLISH-requests reporting
466 486
    dialog-information about the callee (entity=callee) are sent using the
... ...
@@ -471,12 +491,12 @@ modparam("pua_dialoginfo", "pubruri_caller_avp", "$avp(s:puburis_caller)")
471 491
 
472 492
    Default value is “NULL”.
473 493
 
474
-   Example 1.12. Set pubruri_callee_avp parameter
494
+   Example 1.13. Set pubruri_callee_avp parameter
475 495
 ...
476 496
 modparam("pua_dialoginfo", "pubruri_callee_avp", "$avp(s:puburis_callee)")
477 497
 ...
478 498
 
479
-5.13. pubruri_caller_dlg_var (str)
499
+5.14. pubruri_caller_dlg_var (str)
480 500
 
481 501
    Must be set to the name of dialog variable where to store the URI for
482 502
    caller, used to send the notifications. This is needed to restored the
... ...
@@ -485,12 +505,12 @@ modparam("pua_dialoginfo", "pubruri_callee_avp", "$avp(s:puburis_callee)")
485 505
 
486 506
    Default value is “NULL”.
487 507
 
488
-   Example 1.13. Set pubruri_caller_avp parameter
508
+   Example 1.14. Set pubruri_caller_avp parameter
489 509
 ...
490 510
 modparam("pua_dialoginfo", "pubruri_caller_dlg_var", "pubruri_caller")
491 511
 ...
492 512
 
493
-5.14. pubruri_callee_dlg_var (str)
513
+5.15. pubruri_callee_dlg_var (str)
494 514
 
495 515
    Must be set to the name of dialog variable where to store the URI for
496 516
    callee, used to send the notifications. This is needed to restored the
... ...
@@ -499,24 +519,24 @@ modparam("pua_dialoginfo", "pubruri_caller_dlg_var", "pubruri_caller")
499 519
 
500 520
    Default value is “NULL”.
501 521
 
502
-   Example 1.14. Set pubruri_callee_dlg_var parameter
522
+   Example 1.15. Set pubruri_callee_dlg_var parameter
503 523
 ...
504 524
 modparam("pua_dialoginfo", "pubruri_callee_dlg_var", "pubruri_callee")
505 525
 ...
506 526
 
507
-5.15. callee_trying (int)
527
+5.16. callee_trying (int)
508 528
 
509 529
    If this parameter is set, a "Trying" state will be sent for both the
510 530
    caller and callee, rather than just the caller.
511 531
 
512 532
    Default value is “0”.
513 533
 
514
-   Example 1.15. Set callee_trying parameter
534
+   Example 1.16. Set callee_trying parameter
515 535
 ...
516 536
 modparam("pua_dialoginfo", "callee_trying", 1)
517 537
 ...
518 538
 
519
-5.16. caller_entity_when_publish_disabled (int)
539
+5.17. caller_entity_when_publish_disabled (int)
520 540
 
521 541
    Must be a valid sip uri. If this parameter is set, this uri is used as
522 542
    caller entity in publish xml body if associated dialog has the flag
... ...
@@ -525,13 +545,13 @@ modparam("pua_dialoginfo", "callee_trying", 1)
525 545
 
526 546
    Default value is “NULL”.
527 547
 
528
-   Example 1.16. Set caller_entity_when_publish_disabled parameter
548
+   Example 1.17. Set caller_entity_when_publish_disabled parameter
529 549
 ...
530 550
 modparam("pua_dialoginfo", "caller_entity_when_publish_disabled", "sip:caller@pu
531 551
 blish.disabled.com")
532 552
 ...
533 553
 
534
-5.17. callee_entity_when_publish_disabled (int)
554
+5.18. callee_entity_when_publish_disabled (int)
535 555
 
536 556
    Must be a valid sip uri. If this parameter is set, this uri is used as
537 557
    callee entity in publish xml body if associated dialog has the flag
... ...
@@ -540,32 +560,44 @@ blish.disabled.com")
540 560
 
541 561
    Default value is “NULL”.
542 562
 
543
-   Example 1.17. Set callee_entity_when_publish_disabled parameter
563
+   Example 1.18. Set callee_entity_when_publish_disabled parameter
544 564
 ...
545 565
 modparam("pua_dialoginfo", "callee_entity_when_publish_disabled", "sip:callee@pu
546 566
 blish.disabled.com")
547 567
 ...
548 568
 
549
-5.18. publish_dialog_req_within (int)
569
+5.19. publish_dialog_req_within (int)
550 570
 
551 571
    If this parameter is set to 1, subsequents requests received in dialog
552 572
    generate corresponding publish request.
553 573
 
554 574
    Default value is “1”.
555 575
 
556
-   Example 1.18. Set publish_dialog_req_within parameter
576
+   Example 1.19. Set publish_dialog_req_within parameter
557 577
 ...
558 578
 modparam("pua_dialoginfo", "publish_dialog_req_within", 0)
559 579
 ...
560 580
 
561
-5.19. attribute_display (int)
581
+5.20. local_identity_dlg_var (str)
582
+
583
+   PUBLISH-requests reporting dialog-information will use the value of the
584
+   dialog variable if exists
585
+
586
+   Default value is “NULL”.
587
+
588
+   Example 1.20. Set local_identity_dlg_var parameter
589
+...
590
+modparam("pua_dialoginfo", "local_identity_dlg_var", "local_identity")
591
+...
592
+
593
+5.21. attribute_display (int)
562 594
 
563 595
    If set to 1, the display name attribute is added with user part of the
564 596
    URI for local and remote targets.
565 597
 
566 598
    Default value is “0”.
567 599
 
568
-   Example 1.19. Set attribute_display parameter
600
+   Example 1.21. Set attribute_display parameter
569 601
 ...
570 602
 modparam("pua_dialoginfo", "attribute_display", 1)
571 603
 ...