2020-12-09 17:09:19 +00:00
|
|
|
|
2021-01-30 18:01:38 +00:00
|
|
|
XEP-0231: Bits of Binary
|
|
|
|
|
========================
|
2020-12-09 17:09:19 +00:00
|
|
|
|
|
|
|
|
.. module:: slixmpp.plugins.xep_0231
|
|
|
|
|
|
|
|
|
|
.. autoclass:: XEP_0231
|
|
|
|
|
:members:
|
|
|
|
|
:exclude-members: session_bind, plugin_init, plugin_end
|
|
|
|
|
|
2021-02-25 23:07:47 +00:00
|
|
|
.. _api-0231:
|
2020-12-09 17:09:19 +00:00
|
|
|
|
2021-02-14 11:02:13 +00:00
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
2020-12-09 17:09:19 +00:00
|
|
|
Stanza elements
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
.. automodule:: slixmpp.plugins.xep_0231.stanza
|
|
|
|
|
:members:
|
|
|
|
|
:undoc-members:
|
|
|
|
|
|
