Skip to content

Commit

Permalink
Added documentation for recent changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
dsandras authored and bogdan-iancu committed Aug 13, 2013
1 parent 9d4bc28 commit c13a50d
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions modules/pua_dialoginfo/doc/pua_dialoginfo_admin.xml
Expand Up @@ -293,6 +293,51 @@ modparam("pua_dialoginfo", "caller_confirmed", 1)
</example>
</section>

<section>
<title><varname>publish_on_trying</varname> (int)</title>
<para>
Usually the dialog-info of the caller will be
"trying -> early -> confirmed". "trying" will be triggered as soon
as you call dialoginfo_set on the caller, while "early" is triggered
as soon as the callee is ringing.
Sometimes, it is advisable to be notified only when the callee reaches
the early state and not before. In other cases, it is advisable to
notify the early state. This setting allows controlling the behavior.
</para>
<para>
<emphasis>Default value is <quote>0</quote>.</emphasis>
</para>
<example>
<title>Set <varname>publish_on_trying</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("pua_dialoginfo", "publish_on_trying", 1)
...
</programlisting>
</example>
</section>

<section>
<title><varname>nopublish_flag</varname> (int)</title>
<para>
By default, reINVITEs will trigger a PUBLISH. They are actually
the only in-dialog request for which it makes sense.
In some cases, it does not make sense to republish a dialog state.
(e.g. when handling a B2BUA reINVITE).
This setting defines the flag that needs to be set in the request
route to prevent the generation of a PUBLISH request in case of a
specific reINVITE.
</para>
<example>
<title>Set <varname>nopublish_flag</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("pua_dialoginfo", "nopublish_flag", 5)
...
</programlisting>
</example>
</section>

<section>
<title><varname>presence_server</varname> (string)</title>
<para>
Expand Down

0 comments on commit c13a50d

Please sign in to comment.