summaryrefslogtreecommitdiff
path: root/docs/api/plugins/xep_0153.rst
blob: bdcbc07c13dee198b97d1baafeb96b81d6625b42 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

XEP-0153: vCard-Based Avatars
=============================

.. module:: slixmpp.plugins.xep_0153

.. autoclass:: XEP_0153
    :members:
    :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
---------------

.. automodule:: slixmpp.plugins.xep_0153.stanza
    :members:
    :undoc-members: