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/speeddial/doc/params.xml

163 lines
4.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="speeddial.parameters" xmlns:xi="http://www.w3.org/2001/XInclude">
<sectioninfo>
</sectioninfo>
<title>Parameters</title>
<section id="speeddial.db_url">
<title><varname>db_url</varname> (string)</title>
<para>
The URL of database where the table containing speed dial records.
</para>
<para>
Default value is DEFAULT_RODB_URL.
</para>
<example>
<title>Set <varname>db_url</varname> parameter</title>
<programlisting>
...
modparam("speeddial", "db_url", "mysql://ser:xxx@localhost/ser")
...
</programlisting>
</example>
</section>
<section id="speeddial.user_column">
<title><varname>user_column</varname> (string)</title>
<para>
The name of column storing the user name of the owner of the speed
dial record.
</para>
<para>
Default value is "username".
</para>
<example>
<title>Set <varname>user_column</varname> parameter</title>
<programlisting>
...
modparam("speeddial", "user_column", "userid")
...
</programlisting>
</example>
</section>
<section id="speeddial.domain_column">
<title><varname>domain_column</varname> (string)</title>
<para>
The name of column storing the domain of the owner of the speed
dial record.
</para>
<para>
Default value is "domain".
</para>
<example>
<title>Set <varname>domain_column</varname> parameter</title>
<programlisting>
...
modparam("speeddial", "domain_column", "userdomain")
...
</programlisting>
</example>
</section>
<section id="sd_user_column">
<title><varname>sd_user_column</varname> (string)</title>
<para>
The name of the column storing the user part of the short dial address.
</para>
<para>
Default value is "sd_username".
</para>
<example>
<title>Set <varname>sd_user_column</varname> parameter</title>
<programlisting>
...
modparam("speeddial", "sd_user_column", "short_user")
...
</programlisting>
</example>
</section>
<section id="sd_domain_column">
<title><varname>sd_domain_column</varname> (string)</title>
<para>
The name of the column storing the domain of the short dial address.
</para>
<para>
Default value is "sd_domain".
</para>
<example>
<title>Set <varname>sd_domain_column</varname> parameter</title>
<programlisting>
...
modparam("speeddial", "sd_domain_column", "short_domain")
...
</programlisting>
</example>
</section>
<section id="new_uri_column">
<title><varname>new_uri_column</varname> (string)</title>
<para>
The name of the column containing the URI that will be use to
replace the short dial URI.
</para>
<para>
Default value is "new_uri".
</para>
<example>
<title>Set <varname>new_uri_column</varname> parameter</title>
<programlisting>
...
modparam("speeddial", "new_uri_column", "real_uri")
...
</programlisting>
</example>
</section>
<section id="domain_prefix">
<title><varname>domain_prefix</varname> (string)</title>
<para>
If the domain of the owner (From URI) starts with the value of this
parameter, then it is stripped before performing the lookup of the
short number.
</para>
<para>
Default value is NULL.
</para>
<example>
<title>Set <varname>domain_prefix</varname> parameter</title>
<programlisting>
...
modparam("speeddial", "domain_prefix", "tel.")
...
</programlisting>
</example>
</section>
<section id="speeddial.use_domain">
<title><varname>use_domain</varname> (int)</title>
<para>
The parameter specifies wheter or not to use the domain when
searching a speed dial record (0 - no domain, 1 - use domain from
From URI, 2 - use both domains, from From URI and from request
URI).
</para>
<para>
Default value is 0.
</para>
<example>
<title>Set <varname>use_domain</varname> parameter</title>
<programlisting>
...
modparam("speeddial", "use_domain", 1)
...
</programlisting>
</example>
</section>
</section>