Skip to content
Back to top
View this page

# XEP-0231: Bits of Binary

class slixmpp.plugins.xep_0231.XEP_0231(xmpp, config=None)

  XEP-0231 Bits of Binary

  del_bob(cid)

    Delete a stored BoB.

    Changed in version 1.8.0: This function now returns a Future.

    Return type:

      `Future`

  dependencies: ClassVar[set[str]] = {'xep_0030'}

    Some plugins may depend on others in order to function properly. Any plugin names included in `dependencies` will be initialized as needed if this plugin is enabled.

  description: str = 'XEP-0231: Bits of Binary'

    A longer name for the plugin, describing its purpose. For example, a plugin for XEP-0030 would use ‘Service Discovery’ as its description value.

  async get_bob(jid=None, cid=None, cached=True, ifrom=None, **iqkwargs)

    Get a BOB.

    Changed in version 1.8.0: Results not in cache do not raise an error when `cached` is True. This function is now a coroutine.

    Parameters:

      - jid (`JID` | `None`) – JID to fetch the BOB from.

      - cid (`str` | `None`) – Content ID (actually required).

      - cached (`bool`) – To fetch the BOB from the local cache first (from CID only)

    Return type:

      `Iq`

  name: str = 'xep_0231'

    A short name for the plugin based on the implemented specification. For example, a plugin for XEP-0030 would use ‘xep_0030’.

  async set_bob(data, mtype, cid=None, max_age=None)

    Register a blob of binary data as a BOB.

    Changed in version 1.8.0: If `max_age` is specified, the registered data will be destroyed after that time. This function is now a coroutine.

    Parameters:

      - data (`bytes`) – Data to register.

      - mtype (`str`) – Mime Type of the data (e.g. `image/jpeg`).

      - cid (`str` | `None`) – Content-ID (will be auto-generated if left out).

      - max_age (`int` | `None`) – Duration of content availability.

    Return type:

      `str`

    Returns:

      The cid value.

## Internal API methods

The default API handlers for this plugin manage an in-memory cache of bits of binary by content-id.

set_bob

  - jid: `JID` sending the bob

  - node: unused

  - ifrom: `JID` receiving the bob

  - args: `BitsOfBinary` element.

  Set a BoB in the cache.

get_bob

  - jid: `JID` receiving the bob

  - node: unused

  - ifrom: `JID` sending the bob

  - args: `str` content-id of the bob

  - returns: `BitsOfBinary` element.

  Get a BoB from the cache.

del_bob

  - jid: unused

  - node: unused

  - ifrom: `JID` sending the bob

  - args: `str` content-id of the bob

  Delete a BoB from the cache.

## Stanza elements

class slixmpp.plugins.xep_0231.stanza.BitsOfBinary(xml=None, parent=None)
  del_data()
  get_data()
  get_max_age()
  interfaces: ClassVar[set[str]] = {'cid', 'data', 'max_age', 'type'}

    The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the `plugin_attrib` value of any registered stanza plugins.

  name: ClassVar[str] = 'data'

    The XML tag name of the element, not including any namespace prefixes. For example, an `ElementBase` object for `<message />` would use `name = 'message'`.

  namespace: str = 'urn:xmpp:bob'

    The XML namespace for the element. Given `<foo xmlns="bar" />`, then `namespace = "bar"` should be used. The default namespace is `jabber:client` since this is being used in an XMPP library.

  plugin_attrib: ClassVar[str] = 'bob'

    For `ElementBase` subclasses which are intended to be used as plugins, the `plugin_attrib` value defines the plugin name. Plugins may be accessed by using the `plugin_attrib` value as the interface. An example using `plugin_attrib = 'foo'`:

        register_stanza_plugin(Message, FooPlugin)
        msg = Message()
        msg['foo']['an_interface_from_the_foo_plugin']

  set_data(value)
  set_max_age(value)