summaryrefslogtreecommitdiff
path: root/docs/api/plugins/xep_0027.rst
blob: 3a7fb5611d69e533a1cffb20b92db0c2310b9f03 (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
55
56
57
58
59
60
61
62

XEP-0027: Current Jabber OpenPGP Usage
======================================

.. module:: slixmpp.plugins.xep_0027

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


.. _api-0027:

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

The default API here is managing a JID→Keyid dict in-memory.

.. glossary::

    get_keyid
        - **jid**: :class:`~.JID` to get.
        - **node**: unused
        - **ifrom**: unused
        - **args**: unused
        - **returns**: ``Optional[str]``, the keyid or None

        Get the KeyiD for a JID, None if it is not found.

    set_keyid
        - **jid**: :class:`~.JID` to set the id for.
        - **node**: unused
        - **ifrom**: unused
        - **args**: ``str``, keyid to set

        Set the KeyiD for a JID.

    del_keyid
        - **jid**: :class:`~.JID` to delete from the mapping.
        - **node**: unused
        - **ifrom**: unused
        - **args**: unused

        Delete the KeyiD for a JID.

    get_keyids
        - **jid**: unused
        - **node**: unused
        - **ifrom**: unused
        - **args**: unused
        - **returns**: ``Dict[JID, str]`` the full internal mapping

        Get all currently stored KeyIDs.


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

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