summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authormathieui <mathieui@mathieui.net>2021-02-14 11:38:44 +0100
committermathieui <mathieui@mathieui.net>2021-02-26 00:08:56 +0100
commit7772e26a8c766c2606b40f4260e406cd3ed56435 (patch)
treeb9a11d715dc116627e801f25936b6a478ae7be3b /docs/api
parent0b6326e1cce9e85430fa8015f35a9c19d5d59aaf (diff)
downloadslixmpp-7772e26a8c766c2606b40f4260e406cd3ed56435.tar.gz
slixmpp-7772e26a8c766c2606b40f4260e406cd3ed56435.tar.bz2
slixmpp-7772e26a8c766c2606b40f4260e406cd3ed56435.tar.xz
slixmpp-7772e26a8c766c2606b40f4260e406cd3ed56435.zip
XEP-0027: API changes
- ``get_keyids`` and ``get_keyid`` are now coroutines. - ``set_keyid`` and ``del_keyid`` now return a Future.
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/plugins/xep_0027.rst42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/api/plugins/xep_0027.rst b/docs/api/plugins/xep_0027.rst
index 418baada..566c9427 100644
--- a/docs/api/plugins/xep_0027.rst
+++ b/docs/api/plugins/xep_0027.rst
@@ -9,6 +9,48 @@ XEP-0027: Current Jabber OpenPGP Usage
:exclude-members: session_bind, plugin_init, plugin_end
+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
---------------