XEP 0066

1.6 Documentation

«  XEP 0065   ::   Contents   ::   XEP 0070  »

XEP 0066

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

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.

register_url_handler(jid=None, handler=None)[source]

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)[source]

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 = <module 'slixmpp.plugins.xep_0066.stanza' from '/home/docs/checkouts/readthedocs.org/user_builds/slixmpp/checkouts/slix-1.6.0/slixmpp/plugins/xep_0066/stanza.py'>

Stanza elements

Slixmpp: The Slick XMPP Library Copyright (C) 2011 Nathanael C. Fritz, Lance J.T. Stout This file is part of Slixmpp.

See the file LICENSE for copying permission.

class slixmpp.plugins.xep_0066.stanza.OOB(xml=None, parent=None)[source]
interfaces = {'desc', 'url'}
name = 'x'
namespace = 'jabber:x:oob'
plugin_attrib = 'oob'
sub_interfaces = {'desc', 'url'}
class slixmpp.plugins.xep_0066.stanza.OOBTransfer(xml=None, parent=None)[source]
interfaces = {'desc', 'sid', 'url'}
name = 'query'
namespace = 'jabber:iq:oob'
plugin_attrib = 'oob_transfer'
sub_interfaces = {'desc', 'url'}

«  XEP 0065   ::   Contents   ::   XEP 0070  »