You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
kamailio/modules_s/uac/doc/functions.xml

88 lines
2.1 KiB

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<section id="uac.functions" xmlns:xi="http://www.w3.org/2001/XInclude">
<sectioninfo>
</sectioninfo>
<title>Functions</title>
<section id="uac_replace_from2">
<title>
<function>uac_replace_from(display,uri)</function>
</title>
<para>
Replace in FROM header the <emphasis>display</emphasis> name and
the <emphasis>URI</emphasis> part.
</para>
<example>
<title><function>uac_replace_from</function> usage</title>
<programlisting>
...
uac_replace_from("batman","sip:batman@gotham.org");
uac_replace_from("","sip:robin@gotham.org");
uac_replace_from("batman","");
...
</programlisting>
</example>
</section>
<section id="uac_replace_from1">
<title>
<function>uac_replace_from(uri)</function>
</title>
<para>
Replace in FROM header the <emphasis>URI</emphasis> part
without altering the display name.
</para>
<example>
<title><function>uac_replace_from</function> usage</title>
<programlisting>
...
uac_replace_from("sip:batman@gotham.org");
...
</programlisting>
</example>
</section>
<section id="uac_restore_from">
<title>
<function>uac_restore_from()</function>
</title>
<para>
This function will check if the FROM URI was modified and will use
the information stored in header parameter to restore the original
FROM URI value.
</para>
<example>
<title><function>uac_restore_from</function> usage</title>
<programlisting>
...
uac_restore_from();
...
</programlisting>
</example>
</section>
<section id="uac_auth">
<title>
<function>uac_auth()</function>
</title>
<para>
This function can be called only from failure route and will build
the authentication response header and insert it into the request
without sending anything.
</para>
<example>
<title><function>uac_auth</function> usage</title>
<programlisting>
...
uac_auth();
...
</programlisting>
</example>
</section>
</section>