Browse code

dialog: docs for rpc commmands dlg.list_match and dlg.list_match_ctx

Daniel-Constantin Mierla authored on 05/12/2018 16:45:29
Showing 1 changed files
... ...
@@ -2401,6 +2401,56 @@ if(has_totag()) {
2401 2401
 		</programlisting>
2402 2402
 		</section>
2403 2403
 
2404
+		<section id="dlg.r.list_match">
2405
+		<title>dlg.list_match</title>
2406
+		<para>
2407
+		Lists the details of matching dialogs. The paramters specify the matching
2408
+		key, operator, value and optionally a limit of matched dialogs.
2409
+		</para>
2410
+		<para>Name: <emphasis>dlg.list_match</emphasis></para>
2411
+		<para>Parameters:</para>
2412
+		<itemizedlist>
2413
+			<listitem><para>
2414
+				<emphasis>mkey</emphasis> - matching key. It can be: 'ruri' -
2415
+				match against R-URI of the dialog; 'furi' - match against From
2416
+				header URI of the dialog; 'turi' - match against the To header
2417
+				URI of the dialog; 'callid' - match against Call-Id value.
2418
+			</para></listitem>
2419
+			<listitem><para>
2420
+				<emphasis>mop</emphasis> - matching operator. It can be: 'eq' -
2421
+				match using string comparison; 're' - match using regular
2422
+				expression; 'sw' - match using starts-with (prefix) comparison.
2423
+			</para></listitem>
2424
+			<listitem><para>
2425
+				<emphasis>mval</emphasis> - matching value.
2426
+			</para></listitem>
2427
+		</itemizedlist>
2428
+		<para>RPC Command Format:</para>
2429
+		<programlisting  format="linespecific">
2430
+...
2431
+&kamcmd; dlg.list_match furi eq sip:alice@test.com 2
2432
+...
2433
+&kamcmd; dlg.list_match furi sw sip:alice@
2434
+...
2435
+		</programlisting>
2436
+		</section>
2437
+
2438
+		<section id="dlg.r.list_match_ctx">
2439
+		<title>dlg.list_match_ctx</title>
2440
+		<para>
2441
+		Similar to <quote>dlg.list_match</quote>, but including in the
2442
+		attributes associated with the dialog context from modules sitting on
2443
+		top of the dialog module.
2444
+		</para>
2445
+		<para>Name: <emphasis>dlg.list_match_ctx</emphasis></para>
2446
+		<para>RPC Command Format:</para>
2447
+		<programlisting  format="linespecific">
2448
+...
2449
+&kamcmd; dlg.list_match_ctx furi sw sip:alice@
2450
+...
2451
+		</programlisting>
2452
+		</section>
2453
+
2404 2454
 		<section id="dlg.r.dlg_list">
2405 2455
 		<title>dlg.dlg_list</title>
2406 2456
 		<para>
... ...
@@ -2430,7 +2480,7 @@ if(has_totag()) {
2430 2430
 		<section id="dlg.r.dlg_list_ctx">
2431 2431
 		<title>dlg.dlg_list_ctx</title>
2432 2432
 		<para>
2433
-		The same as the <quote>dlg.list_ctx</quote> but including in the dialog
2433
+		The same as the <quote>dlg.list_list</quote> but including in the dialog
2434 2434
 		description the associated context from modules sitting on top of
2435 2435
 		the dialog module.
2436 2436
 		</para>