Module: kamailio
Branch: master
Commit: 1e97167477b7a8a4b436fa6c1b07c6346afa3204
URL:
https://github.com/kamailio/kamailio/commit/1e97167477b7a8a4b436fa6c1b07c63…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2024-12-13T19:50:44+01:00
dialog: docs for dlg_set_state(...) function
---
Modified: src/modules/dialog/doc/dialog_admin.xml
---
Diff:
https://github.com/kamailio/kamailio/commit/1e97167477b7a8a4b436fa6c1b07c63…
Patch:
https://github.com/kamailio/kamailio/commit/1e97167477b7a8a4b436fa6c1b07c63…
---
diff --git a/src/modules/dialog/doc/dialog_admin.xml
b/src/modules/dialog/doc/dialog_admin.xml
index 180a25623eb..4a522cd553e 100644
--- a/src/modules/dialog/doc/dialog_admin.xml
+++ b/src/modules/dialog/doc/dialog_admin.xml
@@ -2708,6 +2708,50 @@ dlg_reset_property("timeout-noreset");
</example>
</section>
+ <section id="dialog.f.dlg_set_state">
+ <title>
+ <function moreinfo="none">dlg_set_state(newstate)</function>
+ </title>
+ <para>
+ Set the state for dialog matching current message.
+ </para>
+ <para>Meaning of the parameters is as follows:</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis>newstate</emphasis> - the new state. It can be:
+ <itemizedlist>
+ <listitem>
+ 'unconfirmed'
+ </listitem>
+ <listitem>
+ 'early'
+ </listitem>
+ <listitem>
+ 'answered'
+ </listitem>
+ <listitem>
+ 'confirmed'
+ </listitem>
+ <listitem>
+ 'deleted'
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ This function can be used from ANY_ROUTE.
+ </para>
+ <example>
+ <title><function>dlg_set_state</function> usage</title>
+ <programlisting format="linespecific">
+...
+dlg_set_state("early");
+...
+</programlisting>
+ </example>
+ </section>
+
</section>