diff options
Diffstat (limited to 'doc/guide.tex')
| -rw-r--r-- | doc/guide.tex | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doc/guide.tex b/doc/guide.tex index 37a6c8bc6..455f6e912 100644 --- a/doc/guide.tex +++ b/doc/guide.tex @@ -98,6 +98,7 @@ \newcommand{\modvcard}{\module{mod\_vcard}} \newcommand{\modvcardldap}{\module{mod\_vcard\_ldap}} \newcommand{\modvcardodbc}{\module{mod\_vcard\_odbc}} +\newcommand{\modvcardxupdate}{\module{mod\_vcard\_xupdate}} \newcommand{\modversion}{\module{mod\_version}} %% Contributed modules @@ -2490,6 +2491,7 @@ The following table lists all modules included in \ejabberd{}. \hline \ahrefloc{modvcard}{\modvcard{}} & vcard-temp (\xepref{0054}) & \\ \hline \ahrefloc{modvcardldap}{\modvcardldap{}} & vcard-temp (\xepref{0054}) & LDAP server \\ \hline \ahrefloc{modvcard}{\modvcardodbc{}} & vcard-temp (\xepref{0054}) & supported DB (*) \\ + \hline \ahrefloc{modvcardxupdate}{\modvcardxupdate{}} & vCard-Based Avatars (\xepref{0153}) & \modvcard{} or \modvcardodbc{} \\ \hline \ahrefloc{modversion}{\modversion{}} & Software Version (\xepref{0092}) & \\ \hline \end{tabular} @@ -4321,6 +4323,27 @@ searching his info in LDAP. \end{verbatim} \end{itemize} +\makesubsection{modvcardxupdate}{\modvcardxupdate{}} +\ind{modules!\modvcardxupdate{}}\ind{protocols!XEP-0153: vCard-Based Avatars} + +The user's client can store an avatar in the user vCard. +The vCard-Based Avatars protocol (\xepref{0153}) +provides a method for clients to inform the contacts what is the avatar hash value. +However, simple or small clients may not implement that protocol. + +If this module is enabled, all the outgoing client presence stanzas get automatically +the avatar hash on behalf of the client. +So, the contacts receive the presence stanzas with the Update Data described +in \xepref{0153} as if the client would had inserted it itself. +If the client had already included such element in the presence stanza, +it is replaced with the element generated by ejabberd. + +By enabling this module, each vCard modification produces a hash recalculation, +and each presence sent by a client produces hash retrieval and a +presence stanza rewrite. +For this reason, enabling this module will introduce a computational overhead +in servers with clients that change frequently their presence. + \makesubsection{modversion}{\modversion{}} \ind{modules!\modversion{}}\ind{protocols!XEP-0092: Software Version} |