diff options
| author | mathieui <mathieui@mathieui.net> | 2021-02-27 13:16:18 +0100 |
|---|---|---|
| committer | mathieui <mathieui@mathieui.net> | 2021-02-27 13:16:18 +0100 |
| commit | 059cb290d8ae567ef189d83c45a1e38b1f3ab9dc (patch) | |
| tree | b8a85ab9a91bf7663701a077607a67a07fcc485a /docs/api/plugins/xep_0153.rst | |
| parent | 5f9ab45a5e161c3035a844184736b3180dae6047 (diff) | |
| parent | 3cdec464a550b775d8c251f37b863a6e2212c5d5 (diff) | |
| download | slixmpp-059cb290d8ae567ef189d83c45a1e38b1f3ab9dc.tar.gz slixmpp-059cb290d8ae567ef189d83c45a1e38b1f3ab9dc.tar.bz2 slixmpp-059cb290d8ae567ef189d83c45a1e38b1f3ab9dc.tar.xz slixmpp-059cb290d8ae567ef189d83c45a1e38b1f3ab9dc.zip | |
Merge branch 'async-interal-api-break-everything' into 'master'
Make the internal "api" async
See merge request poezio/slixmpp!128
Diffstat (limited to 'docs/api/plugins/xep_0153.rst')
| -rw-r--r-- | docs/api/plugins/xep_0153.rst | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/api/plugins/xep_0153.rst b/docs/api/plugins/xep_0153.rst index 00e22098..d4ce342f 100644 --- a/docs/api/plugins/xep_0153.rst +++ b/docs/api/plugins/xep_0153.rst @@ -8,6 +8,43 @@ XEP-0153: vCard-Based Avatars :members: :exclude-members: session_bind, plugin_init, plugin_end +.. _api-0153: + +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 --------------- |