slixmpp/docs/api/plugins/xep_0153.rst

56 lines
1.3 KiB
ReStructuredText
Raw Permalink Normal View History

2020-12-09 17:09:19 +00:00
2021-01-30 18:01:38 +00:00
XEP-0153: vCard-Based Avatars
=============================
2020-12-09 17:09:19 +00:00
.. module:: slixmpp.plugins.xep_0153
.. autoclass:: XEP_0153
:members:
:exclude-members: session_bind, plugin_init, plugin_end
2021-02-25 23:07:47 +00:00
.. _api-0153:
2020-12-09 17:09:19 +00:00
2021-02-14 11:00:25 +00:00
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.
2020-12-09 17:09:19 +00:00
Stanza elements
---------------
.. automodule:: slixmpp.plugins.xep_0153.stanza
:members:
:undoc-members: