Skip to content
Back to top
View this page

# XEP-0066: Out of Band Data

class slixmpp.plugins.xep_0066.XEP_0066(xmpp, config=None)

  XEP-0066: Out of Band Data

  Out of Band Data is a basic method for transferring files between XMPP agents. The URL of the resource in question is sent to the receiving entity, which then downloads the resource before responding to the OOB request. OOB is also used as a generic means to transmit URLs in other stanzas to indicate where to find additional information.

  Also see <http://www.xmpp.org/extensions/xep-0066.html>.

  Events:
    oob_transfer – Raised when a request to download a resource

      has been received.

  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-0066: Out of Band Data'

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

  name: str = 'xep_0066'

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

  register_url_handler(jid=None, handler=None)

    Register a handler to process download requests, either for all JIDs or a single JID.

    Parameters:

      - jid – If None, then set the handler as a global default.

      - handler – If None, then remove the existing handler for the given JID, or reset the global handler if the JID is None.

  send_oob(to, url, desc=None, ifrom=None, **iqargs)

    Initiate a basic file transfer by sending the URL of a file or other resource.

    Parameters:

      - url – The URL of the resource to transfer.

      - desc – An optional human readable description of the item that is to be transferred.

## Stanza elements

class slixmpp.plugins.xep_0066.stanza.OOB(xml=None, parent=None)
  interfaces: ClassVar[Set[str]] = {'desc', 'url'}

    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] = 'x'

    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 = 'jabber:x:oob'

    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] = 'oob'

    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']

  sub_interfaces: ClassVar[Set[str]] = {'desc', 'url'}

    A subset of `interfaces` which maps interfaces to direct subelements of the underlying XML object. Using this set, the text of these subelements may be set, retrieved, or removed without needing to define custom methods.

class slixmpp.plugins.xep_0066.stanza.OOBTransfer(xml=None, parent=None)
  interfaces: ClassVar[Set[str]] = {'desc', 'sid', 'url'}

    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] = 'query'

    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 = 'jabber:iq:oob'

    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] = 'oob_transfer'

    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']

  sub_interfaces: ClassVar[Set[str]] = {'desc', 'url'}

    A subset of `interfaces` which maps interfaces to direct subelements of the underlying XML object. Using this set, the text of these subelements may be set, retrieved, or removed without needing to define custom methods.