[sr-dev] git:master:08e67665: uac: updated docs for uac_req_request_to()

Module: kamailio Branch: master Commit: 08e676654d901644724f52478a88c6d0258304cc URL: https://github.com/kamailio/kamailio/commit/08e676654d901644724f52478a88c6d… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2019-10-29T08:49:27+01:00 uac: updated docs for uac_req_request_to() --- Modified: src/modules/uac/doc/uac_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/08e676654d901644724f52478a88c6d… Patch: https://github.com/kamailio/kamailio/commit/08e676654d901644724f52478a88c6d… --- diff --git a/src/modules/uac/doc/uac_admin.xml b/src/modules/uac/doc/uac_admin.xml index 8ddf26ca0f..e0ea527776 100644 --- a/src/modules/uac/doc/uac_admin.xml +++ b/src/modules/uac/doc/uac_admin.xml @@ -951,12 +951,27 @@ $var(status) = uac_reg_status("$rU"); <function moreinfo="none">uac_reg_request_to(user, mode)</function> </title> <para> - This function can be used to send an authenticated request to a remote user in + This function can be used to send an authenticated request to a remote user in the uac registrations table. It sets the request-uri, dst-uri and auth_*_avp - pv's to the values that correspond to the supplied user. + variables to the values that correspond to the supplied user. </para> <para> - The mode indicates whether the user should match the local uuid (mode=0), or the username (mode=1). + The mode is a bitwise set of flags controlling how the matching of + the record is done and what field is used to set auth_password_avp: + <itemizedlist> + <listitem> + <para> + indicates whether the user should match the local uuid (bit value=0), + or the username (bit value=1, int value=1). + </para> + </listitem> + <listitem> + <para> + indicates whether the auth_password value is used to set auth_password_avp + (bit value=0), or the auth_ha1 value (bit value=1, int value=2). + </para> + </listitem> + </itemizedlist> </para> <para> The auth_*_avp module parameters must be set to valid pv&apos;s.