dialog: docs - more info about using the flag and dlg_manage()
authorDaniel-Constantin Mierla <miconda@gmail.com>
Wed, 9 Jan 2019 08:50:12 +0000 (09:50 +0100)
committerDaniel-Constantin Mierla <miconda@gmail.com>
Wed, 9 Jan 2019 08:50:12 +0000 (09:50 +0100)
src/modules/dialog/doc/dialog_admin.xml

index ca0109b..9adca73 100644 (file)
        <section>
        <title>How it works</title>
        <para>
-       To create the dialog associated with an initial request, the flag
-       <quote>dlg_flag</quote> (<xref linkend="dialog.p.flag"/>) must be set before
-       creating the corresponding transaction.
+       To create the dialog associated with an initial INVITE request, execute
+       the function <quote>dlg_manage()</quote> or set the flag specified by
+       parameter <quote>dlg_flag</quote> (<xref linkend="dialog.p.flag"/>)
+       before creating the corresponding transaction.
        </para>
        <para>
        The dialog is automatically destroyed when a <quote>BYE</quote> is
@@ -256,6 +257,12 @@ modparam("dialog", "rr_param", "xyz")
                current request (this make sense only for initial requests).
                </para>
                <para>
+               Note: it is not needed to set this parameter and its corresponding flag
+               for initial request in case the <quote>dlg_manage()</quote> function
+               is used. In other words, using <quote>dlg_manage()</quote> alone is
+               enough.
+               </para>
+               <para>
                <emphasis>
                        Default value is <quote>none</quote>.
                </emphasis>