summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2021-02-14 12:00:25 +0100
committermathieui <mathieui@mathieui.net>2021-02-26 00:08:56 +0100
commitab87b2503042ec9cf226574fa68af1b5b9809cc7 (patch)
tree285f4c588de15d37a5d7be361a6d46bc640dfde3 /docs/api
parente24e2f58d4e9c71ef005a4dfe88abac7bff1cc6b (diff)
downloadslixmpp-ab87b2503042ec9cf226574fa68af1b5b9809cc7.tar.gz
slixmpp-ab87b2503042ec9cf226574fa68af1b5b9809cc7.tar.bz2
slixmpp-ab87b2503042ec9cf226574fa68af1b5b9809cc7.tar.xz
slixmpp-ab87b2503042ec9cf226574fa68af1b5b9809cc7.zip
XEP-0153: API changes
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/plugins/xep_0153.rst36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/api/plugins/xep_0153.rst b/docs/api/plugins/xep_0153.rst
index 00e22098..bdcbc07c 100644
--- a/docs/api/plugins/xep_0153.rst
+++ b/docs/api/plugins/xep_0153.rst
@@ -9,6 +9,42 @@ XEP-0153: vCard-Based Avatars
:exclude-members: session_bind, plugin_init, plugin_end
+Internal API methods
+--------------------
+
+The internal API is used here to maintain an in-memory JID→avatar hash
+cache.
+
+.. glossary::
+
+ set_hash
+ - **jid**: :class:`~.JID` of whom to retrieve the last activity
+ - **node**: unused
+ - **ifrom**: unused
+ - **args**: ``str``, avatar hash
+
+ Set the avatar hash for a JID.
+
+ reset_hash
+ - **jid**: :class:`~.JID` of whom to retrieve the last activity
+ - **node**: unused
+ - **ifrom**: :class:`~.JID` of the entity requesting the reset.
+ - **args**: unused
+ - **returns**
+ information.
+
+ Reset the avatar hash for a JID. This downloads the vcard and computes
+ the hash.
+
+ get_hash
+ - **jid**: :class:`~.JID` of whom to retrieve the last activity
+ - **node**: unused
+ - **ifrom**: unused
+ - **args**: unused
+ - **returns**: ``Optional[str]``, the avatar hash
+
+ Get the avatar hash for a JID.
+
Stanza elements
---------------