Browse code

dialog: docs for attrs parameter of dlg.briefing rpc command

Daniel-Constantin Mierla authored on 09/04/2020 07:42:58
Showing 1 changed files
... ...
@@ -2865,19 +2865,58 @@ dlg_reset_property("timeout-noreset");
2865 2865
 		<section id="dlg.r.briefing">
2866 2866
 		<title>dlg.briefing</title>
2867 2867
 		<para>
2868
-		Lists fewer attributes for dialog records in memory.
2868
+		Lists fewer attributes for dialog records in memory. The dialog hash
2869
+		entry and id are added always, the rest of them are a matter of 'attrs'
2870
+		parameter.
2869 2871
 		</para>
2870 2872
 		<para>Name: <emphasis>dlg.briefing</emphasis></para>
2871 2873
 		<para>Parameters:</para>
2872 2874
 		<itemizedlist>
2873 2875
 			<listitem><para>
2874
-				<emphasis>none</emphasis> - no parameter
2875
-			</para></listitem>
2876
+			<emphasis>attrs</emphasis> - (optional) a list of characters (flags)
2877
+			representing the fields to be added to the response. If is missing,
2878
+			its default value is 'ftcFT' (note the characters are case sensitive).
2879
+			</para>
2880
+			<para>
2881
+				The characters can be:
2882
+				<itemizedlist>
2883
+				<listitem><para>
2884
+					<emphasis>f</emphasis> - From URI
2885
+				</para></listitem>
2886
+				<listitem><para>
2887
+					<emphasis>t</emphasis> - To URI
2888
+				</para></listitem>
2889
+				<listitem><para>
2890
+					<emphasis>c</emphasis> - Call-ID
2891
+				</para></listitem>
2892
+				<listitem><para>
2893
+					<emphasis>F</emphasis> - From tag
2894
+				</para></listitem>
2895
+				<listitem><para>
2896
+					<emphasis>T</emphasis> - To tag
2897
+				</para></listitem>
2898
+				<listitem><para>
2899
+					<emphasis>I</emphasis> - Init time
2900
+				</para></listitem>
2901
+				<listitem><para>
2902
+					<emphasis>S</emphasis> - Start time
2903
+				</para></listitem>
2904
+				<listitem><para>
2905
+					<emphasis>E</emphasis> - End time
2906
+				</para></listitem>
2907
+				<listitem><para>
2908
+					<emphasis>s</emphasis> - State
2909
+				</para></listitem>
2910
+				</itemizedlist>
2911
+			</para>
2912
+			</listitem>
2876 2913
 		</itemizedlist>
2877 2914
 		<para>RPC Command Example:</para>
2878 2915
 		<programlisting  format="linespecific">
2879 2916
 ...
2880 2917
 kamctl rpc dlg.briefing
2918
+...
2919
+kamctl rpc dlg.briefing "ft"
2881 2920
 ...
2882 2921
 		</programlisting>
2883 2922
 		</section>