From 9947d3db85e98a44a495f749d96b8632a10bde8d Mon Sep 17 00:00:00 2001 From: mathieui Date: Sun, 14 Feb 2021 12:02:13 +0100 Subject: XEP-0231: API changes - ``get_bob`` and ``set_bob`` are now coroutines. - ``del_bob`` returns a Future. --- docs/api/plugins/xep_0231.rst | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) (limited to 'docs/api/plugins/xep_0231.rst') diff --git a/docs/api/plugins/xep_0231.rst b/docs/api/plugins/xep_0231.rst index 29f403ca..bed0e4bb 100644 --- a/docs/api/plugins/xep_0231.rst +++ b/docs/api/plugins/xep_0231.rst @@ -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 --------------- -- cgit v1.2.3 From 9927e69435e4e451722184d5b73107554a4df5c6 Mon Sep 17 00:00:00 2001 From: mathieui Date: Fri, 26 Feb 2021 00:07:47 +0100 Subject: docs: add references to API docs --- docs/api/plugins/xep_0231.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'docs/api/plugins/xep_0231.rst') diff --git a/docs/api/plugins/xep_0231.rst b/docs/api/plugins/xep_0231.rst index bed0e4bb..c8a863cb 100644 --- a/docs/api/plugins/xep_0231.rst +++ b/docs/api/plugins/xep_0231.rst @@ -8,6 +8,7 @@ XEP-0231: Bits of Binary :members: :exclude-members: session_bind, plugin_init, plugin_end +.. _api-0231: Internal API methods -------------------- -- cgit v1.2.3