XEP-0033: Extended Stanza Addressing#

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

XEP-0033: Extended Stanza Addressing

Stanza elements#

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: ClassVar[Set[str]] = {'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.

iterables: List[ElementBase]#

A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]#
name: ClassVar[str] = '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: str = '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.

parent: Optional[ReferenceType[ElementBase]]#

A weakref.weakref to the parent stanza, if there is one. If not, then parent is None.

plugin_attrib: ClassVar[str] = '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']
plugins: Dict[Tuple[str, Optional[str]], ElementBase]#

An ordered dictionary of plugin stanzas, mapped by their plugin_attrib value.

set_delivered(delivered)[source]#
set_jid(value)[source]#
set_uri(uri)[source]#
tag: str#

The name of the tag for the stanza’s root element. It is the same as calling tag_name() and is formatted as '{namespace}elementname'.

xml: ET.Element#

The underlying XML object for the stanza. It is a standard xml.etree.ElementTree object.

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: ClassVar[Set[str]] = {'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.

iterables: List[ElementBase]#

A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]#
name: ClassVar[str] = '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: str = '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.

parent: Optional[ReferenceType[ElementBase]]#

A weakref.weakref to the parent stanza, if there is one. If not, then parent is None.

plugin_attrib: ClassVar[str] = '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: ClassVar[Dict[str, Type[ElementBase]]] = {'address': <class 'slixmpp.plugins.xep_0033.stanza.Address'>}#

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

plugin_iterables: ClassVar[Set[Type[ElementBase]]] = {<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: ClassVar[Dict[str, str]] = {}#

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: ClassVar[Dict[str, Type[ElementBase]]] = {'{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.

plugins: Dict[Tuple[str, Optional[str]], ElementBase]#

An ordered dictionary of plugin stanzas, mapped by their plugin_attrib value.

set_addresses(value)#
set_all(value)#
set_bcc(value)#
set_cc(value)#
set_noreply(value)#
set_replyroom(value)#
set_replyto(value)#
set_to(value)#
tag: str#

The name of the tag for the stanza’s root element. It is the same as calling tag_name() and is formatted as '{namespace}elementname'.

xml: ET.Element#

The underlying XML object for the stanza. It is a standard xml.etree.ElementTree object.

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)#