XEP-0033: Extended Stanza Addressing¶
- class slixmpp.plugins.xep_0033.XEP_0033(xmpp, config=None)[source]¶
XEP-0033: Extended Stanza Addressing
- 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-0033: Extended Stanza Addressing'¶
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_0033'¶
A short name for the plugin based on the implemented specification. For example, a plugin for XEP-0030 would use ‘xep_0030’.
Stanza elements¶
- class slixmpp.plugins.xep_0033.stanza.Address(xml=None, parent=None)[source]¶
- address_types = {'bcc', 'cc', 'noreply', 'replyroom', 'replyto', 'to'}¶
- 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.
- name: ClassVar[str] = 'address'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'http://jabber.org/protocol/address'¶
The XML namespace for the element. Given
<foo xmlns="bar" />
, thennamespace = "bar"
should be used. The default namespace isjabber:client
since this is being used in an XMPP library.
- plugin_attrib: ClassVar[str] = 'address'¶
For
ElementBase
subclasses which are intended to be used as plugins, theplugin_attrib
value defines the plugin name. Plugins may be accessed by using theplugin_attrib
value as the interface. An example usingplugin_attrib = 'foo'
:register_stanza_plugin(Message, FooPlugin) msg = Message() msg['foo']['an_interface_from_the_foo_plugin']
- class slixmpp.plugins.xep_0033.stanza.Addresses(xml=None, parent=None)[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.
- name: ClassVar[str] = 'addresses'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'http://jabber.org/protocol/address'¶
The XML namespace for the element. Given
<foo xmlns="bar" />
, thennamespace = "bar"
should be used. The default namespace isjabber:client
since this is being used in an XMPP library.
- plugin_attrib: ClassVar[str] = 'addresses'¶
For
ElementBase
subclasses which are intended to be used as plugins, theplugin_attrib
value defines the plugin name. Plugins may be accessed by using theplugin_attrib
value as the interface. An example usingplugin_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)
Added 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 interfacebody
,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.
- 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)¶