XEP-0016

class slixmpp.plugins.xep_0016.XEP_0016(xmpp, config=None)

Stanza elements

class slixmpp.plugins.xep_0016.stanza.Active(xml=None, parent=None)

interfaces: ClassVar[set[str]] = {'name'}

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

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:privacy'

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

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

class slixmpp.plugins.xep_0016.stanza.Default(xml=None, parent=None)

interfaces: ClassVar[set[str]] = {'name'}

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

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:privacy'

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

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

class slixmpp.plugins.xep_0016.stanza.Item(xml=None, parent=None)

action_values = ('allow', 'deny')

bool_interfaces: ClassVar[set[str]] = {'iq', 'message', 'presence_in', 'presence_out'}

A subset of interfaces which maps the presence of subelements to boolean values. Using this set allows for quickly checking for the existence of empty subelements like <required />.

Added in version 1.1.

del_presence_in()

del_presence_out()

get_presence_in()

get_presence_out()

interfaces: ClassVar[set[str]] = {'action', 'iq', 'message', 'order', 'presence_in', 'presence_out', 'type', 'value'}

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

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:privacy'

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

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_multi_attrib: ClassVar[str] = 'items'

For ElementBase subclasses that are intended to be an iterable group of items, the plugin_multi_attrib value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:

# Given stanza class Foo, with plugin_multi_attrib = 'foos'
parent['foos']
filter(isinstance(item, Foo), parent['substanzas'])

set_action(value)

set_presence_in(value)

set_presence_out(value)

set_type(value)

type_values = ('', 'jid', 'group', 'subscription')

class slixmpp.plugins.xep_0016.stanza.List(xml=None, parent=None)

add_item(value, action, order, itype=None, iq=False, message=False, presence_in=False, presence_out=False)

interfaces: ClassVar[set[str]] = {'name'}

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

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:privacy'

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

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]]] = {'item': <class 'slixmpp.plugins.xep_0016.stanza.Item'>, 'items': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>}

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

plugin_iterables: ClassVar[set[type[ElementBase]]] = {<class 'slixmpp.plugins.xep_0016.stanza.Item'>}

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_multi_attrib: ClassVar[str] = 'lists'

For ElementBase subclasses that are intended to be an iterable group of items, the plugin_multi_attrib value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:

# Given stanza class Foo, with plugin_multi_attrib = 'foos'
parent['foos']
filter(isinstance(item, Foo), parent['substanzas'])

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]]] = {'{jabber:client}stanza': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, '{jabber:iq:privacy}item': <class 'slixmpp.plugins.xep_0016.stanza.Item'>}

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

class slixmpp.plugins.xep_0016.stanza.Privacy(xml=None, parent=None)

add_list(name)

interfaces: ClassVar[set[str]] = {}

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:privacy'

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

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]]] = {'active': <class 'slixmpp.plugins.xep_0016.stanza.Active'>, 'default': <class 'slixmpp.plugins.xep_0016.stanza.Default'>, 'list': <class 'slixmpp.plugins.xep_0016.stanza.List'>, 'lists': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>}

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

plugin_iterables: ClassVar[set[type[ElementBase]]] = {<class 'slixmpp.plugins.xep_0016.stanza.List'>}

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 interface body, plugin_overrides would be:

{'set_body': <some function>}

plugin_tag_map: ClassVar[dict[str, type[ElementBase]]] = {'{jabber:client}stanza': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, '{jabber:iq:privacy}active': <class 'slixmpp.plugins.xep_0016.stanza.Active'>, '{jabber:iq:privacy}default': <class 'slixmpp.plugins.xep_0016.stanza.Default'>, '{jabber:iq:privacy}list': <class 'slixmpp.plugins.xep_0016.stanza.List'>}

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