XEP-0231: API changes

- ``get_bob`` and ``set_bob`` are now coroutines.
- ``del_bob`` returns a Future.
This commit is contained in:
mathieui
2021-02-14 12:02:13 +01:00
parent ab87b25030
commit 9947d3db85
3 changed files with 64 additions and 22 deletions

View File

@@ -9,6 +9,40 @@ XEP-0231: Bits of Binary
:exclude-members: session_bind, plugin_init, plugin_end
Internal API methods
--------------------
The default API handlers for this plugin manage an in-memory cache of
bits of binary by content-id.
.. glossary::
set_bob
- **jid**: :class:`~.JID` sending the bob
- **node**: unused
- **ifrom**: :class:`~JID` receiving the bob
- **args**: :class:`~.BitsOfBinary` element.
Set a BoB in the cache.
get_bob
- **jid**: :class:`~.JID` receiving the bob
- **node**: unused
- **ifrom**: :class:`~JID` sending the bob
- **args**: ``str`` content-id of the bob
- **returns**: :class:`~.BitsOfBinary` element.
Get a BoB from the cache.
del_bob
- **jid**: unused
- **node**: unused
- **ifrom**: :class:`~JID` sending the bob
- **args**: ``str`` content-id of the bob
Delete a BoB from the cache.
Stanza elements
---------------