diff options
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/plugins/xep_0153.rst | 36 |
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 --------------- |