XEP 0033

1.7 Documentation

«  XEP 0030   ::   Contents   ::   XEP 0045  »

XEP 0033

class slixmpp.plugins.xep_0033.XEP_0033(xmpp, config=None)[source]

XEP-0033: Extended Stanza Addressing

stanza = <module 'slixmpp.plugins.xep_0033.stanza' from '/home/docs/checkouts/readthedocs.org/user_builds/slixmpp/checkouts/slix-1.7.1/slixmpp/plugins/xep_0033/stanza.py'>

Stanza elements

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

See the file LICENSE for copying permission.

class slixmpp.plugins.xep_0033.stanza.Address(xml=None, parent=None)[source]
address_types = {'bcc', 'cc', 'noreply', 'replyroom', 'replyto', 'to'}
get_delivered()[source]
get_jid()[source]
interfaces = {'delivered', 'desc', 'jid', 'node', 'type', 'uri'}

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 = 'address'

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

namespace = 'http://jabber.org/protocol/address'

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 = 'address'

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_delivered(delivered)[source]
set_jid(value)[source]
set_uri(uri)[source]
class slixmpp.plugins.xep_0033.stanza.Addresses(xml=None, parent=None)[source]
add_address(atype='to', jid='', node='', uri='', desc='', delivered=False)[source]
del_addresses()
del_all()
del_bcc()
del_cc()
del_noreply()
del_replyroom()
del_replyto()
del_to()
get_addresses()
get_all()
get_bcc()
get_cc()
get_noreply()
get_replyroom()
get_replyto()
get_to()
interfaces = {'addresses', 'all', 'bcc', 'cc', 'noreply', 'replyroom', 'replyto', 'to'}

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 = 'addresses'

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

namespace = 'http://jabber.org/protocol/address'

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 = 'addresses'

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']
plugin_attrib_map = {'address': <class 'slixmpp.plugins.xep_0033.stanza.Address'>}

A mapping of the plugin_attrib values of registered plugins to their respective classes.

plugin_iterables = {<class 'slixmpp.plugins.xep_0033.stanza.Address'>}

The set of stanza classes that can be iterated over using the ‘substanzas’ interface. Classes are added to this set when registering a plugin with iterable=True:

register_stanza_plugin(DiscoInfo, DiscoItem, iterable=True)

New in version 1.0-Beta5.

plugin_overrides = {}

A map of interface operations to the overriding functions. For example, after overriding the set operation for the interface body, plugin_overrides would be:

{'set_body': <some function>}
plugin_tag_map = {'{http://jabber.org/protocol/address}address': <class 'slixmpp.plugins.xep_0033.stanza.Address'>}

A mapping of root element tag names (in '{namespace}elementname' format) to the plugin classes responsible for them.

set_addresses(value)
set_all(value)
set_bcc(value)
set_cc(value)
set_noreply(value)
set_replyroom(value)
set_replyto(value)
set_to(value)
slixmpp.plugins.xep_0033.stanza.del_multi(self)
slixmpp.plugins.xep_0033.stanza.get_multi(self)
slixmpp.plugins.xep_0033.stanza.set_multi(self, value)

«  XEP 0030   ::   Contents   ::   XEP 0045  »