Browse code

dialog: docs - more info about using the flag and dlg_manage()

Daniel-Constantin Mierla authored on 09/01/2019 08:50:12
Showing 1 changed files
... ...
@@ -45,9 +45,10 @@
45 45
 	<section>
46 46
 	<title>How it works</title>
47 47
 	<para>
48
-	To create the dialog associated with an initial request, the flag
49
-	<quote>dlg_flag</quote> (<xref linkend="dialog.p.flag"/>) must be set before
50
-	creating the corresponding transaction.
48
+	To create the dialog associated with an initial INVITE request, execute
49
+	the function <quote>dlg_manage()</quote> or set the flag specified by
50
+	parameter <quote>dlg_flag</quote> (<xref linkend="dialog.p.flag"/>)
51
+	before creating the corresponding transaction.
51 52
 	</para>
52 53
 	<para>
53 54
 	The dialog is automatically destroyed when a <quote>BYE</quote> is
... ...
@@ -256,6 +257,12 @@ modparam("dialog", "rr_param", "xyz")
256 256
 		current request (this make sense only for initial requests).
257 257
 		</para>
258 258
 		<para>
259
+		Note: it is not needed to set this parameter and its corresponding flag
260
+		for initial request in case the <quote>dlg_manage()</quote> function
261
+		is used. In other words, using <quote>dlg_manage()</quote> alone is
262
+		enough.
263
+		</para>
264
+		<para>
259 265
 		<emphasis>
260 266
 			Default value is <quote>none</quote>.
261 267
 		</emphasis>