summaryrefslogtreecommitdiff
path: root/docs/api/plugins/xep_0054.rst
blob: f9c964a8f223039280264a9082377e656411d612 (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

XEP-0054: vcard-temp
====================

.. module:: slixmpp.plugins.xep_0054

.. autoclass:: XEP_0054
    :members:
    :exclude-members: session_bind, plugin_init, plugin_end

Internal API methods
--------------------

This plugin maintains by default an in-memory cache of the received
VCards.

.. glossary::

    set_vcard
        - **jid**: :class:`~.JID` of whom to set the vcard
        - **node**: unused
        - **ifrom**: unused
        - **args**: :class:`~.VCardTemp` object to store for this JID.

        Set a VCard for a JID.

    get_vcard
        - **jid**: :class:`~.JID` of whom to set the vcard
        - **node**: unused
        - **ifrom**: :class:`~.JID` the request is coming from
        - **args**: unused
        - **returns**: :class:`~.VCardTemp` object for this JID or None.

        Get a stored VCard for a JID.

    del_vcard
        - **jid**: :class:`~.JID` of whom to set the vcard
        - **node**: unused
        - **ifrom**: unused
        - **args**: unused

        Delete a stored VCard for a JID.

Stanza elements
---------------

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