<!-- Module User's Guide -->

<chapter>
    <chapterinfo>
	<revhistory>
	    <revision>
		<revnumber>$Revision: 1.3.2.1 $</revnumber>
		<date>$Date: 2005/06/22 23:12:09 $</date>
	    </revision>
	</revhistory>
    </chapterinfo>
    <title>User's Guide</title>
    
    <section>
	<title>Overview</title>
	<para>Various checks related to &sip; &uri;.</para>
    </section>
    <section>
	<title>Dependencies</title>
	<section>
	    <title>&ser; Modules</title>
	    <para>None.</para>
	</section>
	<section>
	    <title>External Libraries or Applications</title>
	    <para>
		The following libraries or applications must be installed before running
		&ser; with this module loaded:
	    	<itemizedlist>
		    <listitem>
			<para>
			    <emphasis>None</emphasis>.
			</para>
		    </listitem>
	    	</itemizedlist>
	    </para>
	</section>
    </section>
    <section>
	<title>Exported Parameters</title>
	<para>
	    None.
	</para>
    </section>
    <section>
	<title>Exported Functions</title>
	<section>
	    <title>
		<function moreinfo="none">is_user(username)</function>
	    </title>
	    <para>
		Check if the username in credentials matches the given username.
	    </para>
	    <para>Meaning of the parameters is as follows:</para>
	    <itemizedlist>
		<listitem>
		    <para><emphasis>username</emphasis> - Username string.
		    </para>
		</listitem>
	    </itemizedlist>
	    <example>
		<title><function>is_user</function> usage</title>
		<programlisting format="linespecific">
...
if (is_user("jan")) {
    ...
};
...
</programlisting>
	    </example>
	</section>
	<section>
	    <title>
		<function moreinfo="none">has_totag()</function>
	    </title>
	    <para>
		Check if To header field uri contains tag parameter.
	    </para>
	    <example>
		<title><function>has_totag</function> usage</title>
		<programlisting format="linespecific">
...
if (has_totag()) {
    ...
};
...
</programlisting>
	    </example>
	</section>

	<section>
	    <title>
		<function moreinfo="none">uri_param(param)</function>
	    </title>
	    <para>
		Check for existence of a specific parameter in a SIP URI.
	    </para>
	    <para>Meaning of the parameters is as follows:</para>
	    <itemizedlist>
		<listitem>
		    <para><emphasis>param</emphasis> - Name of parameter.
		    </para>
		</listitem>
	    </itemizedlist>
	</section>

	<section>
	    <title>
		<function moreinfo="none">uri_param(param, value)</function>
	    </title>
	    <para>
		Check for existence of a parameter with given value in SIP URI.
	    </para>
	    <para>Meaning of the parameters is as follows:</para>
	    <itemizedlist>
		<listitem>
		    <para><emphasis>param</emphasis> - Name of parameter.
		    </para>
		</listitem>
		<listitem>
		    <para><emphasis>value</emphasis> - Desired value of the parameter.
		    </para>
		</listitem>
	    </itemizedlist>
	</section>

	<section>
	    <title>
		<function moreinfo="none">add_uri_param(param)</function>
	    </title>
	    <para>
		Add a parameter to SIP URI.
	    </para>
	    <para>Meaning of the parameters is as follows:</para>
	    <itemizedlist>
		<listitem>
		    <para><emphasis>param</emphasis> - Complete parameter
		    including value, if any. The parameter will be added
		    verbatim to the SIP URI.
		    </para>
		</listitem>
	    </itemizedlist>
	</section>

	<section>
	    <title>
		<function moreinfo="none">tel2sip()</function>
	    </title>
	    <para>
		Convert tel URI into SIP URI.
	    </para>
	</section>

    </section>
</chapter>

<!-- Keep this element at the end of the file
Local Variables:
sgml-parent-document: ("uri.sgml" "Book" "chapter")
End:
-->
