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_0258.stanza.Catalog(xml=None, parent=None)[source]¶

get_from()[source]¶

get_restrict()[source]¶

get_to()[source]¶

interfaces = {'desc', 'from', 'id', 'name', 'restrict', 'size', '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 = 'catalog'¶

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

namespace = 'urn:xmpp:sec-label:catalog:2'¶

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 = 'security_label_catalog'¶

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

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

plugin_iterables = {<class 'slixmpp.plugins.xep_0258.stanza.CatalogItem'>}¶

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 = {'{jabber:client}stanza': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, '{urn:xmpp:sec-label:catalog:2}catalog': <class 'slixmpp.plugins.xep_0258.stanza.CatalogItem'>}¶

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

set_from(value)[source]¶

set_restrict(value)[source]¶

set_to(value)[source]¶

class slixmpp.plugins.xep_0258.stanza.CatalogItem(xml=None, parent=None)[source]¶

get_default()[source]¶

interfaces = {'default', 'selector'}¶

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 = 'catalog'¶

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

namespace = 'urn:xmpp:sec-label:catalog:2'¶

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 = '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_attrib_map = {'security_label': <class 'slixmpp.plugins.xep_0258.stanza.SecurityLabel'>}¶

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

plugin_iterables = {}¶

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_multi_attrib = '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'])

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 = {'{urn:xmpp:sec-label:0}securitylabel': <class 'slixmpp.plugins.xep_0258.stanza.SecurityLabel'>}¶

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

set_default(value)[source]¶

class slixmpp.plugins.xep_0258.stanza.DisplayMarking(xml=None, parent=None)[source]¶

del_value()[source]¶

get_bgcolor()[source]¶

get_fgcolor()[source]¶

get_value()[source]¶

interfaces = {'bgcolor', 'fgcolor', '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 = 'displaymarking'¶

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

namespace = 'urn:xmpp:sec-label:0'¶

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 = 'display_marking'¶

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_value(value)[source]¶

class slixmpp.plugins.xep_0258.stanza.ESSLabel(xml=None, parent=None)[source]¶

del_value()[source]¶

get_value()[source]¶

interfaces = {'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 = 'esssecuritylabel'¶

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

namespace = 'urn:xmpp:sec-label:ess:0'¶

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 = 'ess'¶

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_value(value)[source]¶

class slixmpp.plugins.xep_0258.stanza.EquivalentLabel(xml=None, parent=None)[source]¶

name = 'equivalentlabel'¶

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

namespace = 'urn:xmpp:sec-label:0'¶

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 = 'equivalent_label'¶

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 = {'ess': <class 'slixmpp.plugins.xep_0258.stanza.ESSLabel'>}¶

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

plugin_iterables = {}¶

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_multi_attrib = 'equivalent_labels'¶

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 = {}¶

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 = {'{urn:xmpp:sec-label:ess:0}esssecuritylabel': <class 'slixmpp.plugins.xep_0258.stanza.ESSLabel'>}¶

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

class slixmpp.plugins.xep_0258.stanza.Label(xml=None, parent=None)[source]¶

name = 'label'¶

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

namespace = 'urn:xmpp:sec-label:0'¶

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 = 'label'¶

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 = {'ess': <class 'slixmpp.plugins.xep_0258.stanza.ESSLabel'>}¶

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

plugin_iterables = {}¶

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 = {'{urn:xmpp:sec-label:ess:0}esssecuritylabel': <class 'slixmpp.plugins.xep_0258.stanza.ESSLabel'>}¶

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

class slixmpp.plugins.xep_0258.stanza.SecurityLabel(xml=None, parent=None)[source]¶

add_equivalent(label)[source]¶

name = 'securitylabel'¶

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

namespace = 'urn:xmpp:sec-label:0'¶

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 = 'security_label'¶

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 = {'display_marking': <class 'slixmpp.plugins.xep_0258.stanza.DisplayMarking'>, 'equivalent_label': <class 'slixmpp.plugins.xep_0258.stanza.EquivalentLabel'>, 'equivalent_labels': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'label': <class 'slixmpp.plugins.xep_0258.stanza.Label'>}¶

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

plugin_iterables = {<class 'slixmpp.plugins.xep_0258.stanza.EquivalentLabel'>}¶

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 = {'{jabber:client}stanza': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, '{urn:xmpp:sec-label:0}displaymarking': <class 'slixmpp.plugins.xep_0258.stanza.DisplayMarking'>, '{urn:xmpp:sec-label:0}equivalentlabel': <class 'slixmpp.plugins.xep_0258.stanza.EquivalentLabel'>, '{urn:xmpp:sec-label:0}label': <class 'slixmpp.plugins.xep_0258.stanza.Label'>}¶

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