Stanza elements¶

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

See the file LICENSE for copying permission.

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

add_rule(action, condition, value)[source]¶

del_per_hop()[source]¶

get_from()[source]¶

get_per_hop()[source]¶

get_to()[source]¶

interfaces = {'from', 'per_hop', 'status', '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 = 'amp'¶

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/amp'¶

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

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 = {'rule': <class 'slixmpp.plugins.xep_0079.stanza.Rule'>, 'rules': <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_0079.stanza.Rule'>}¶

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/amp}rule': <class 'slixmpp.plugins.xep_0079.stanza.Rule'>, '{jabber:client}stanza': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>}¶

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

set_from(value)[source]¶

set_per_hop(value)[source]¶

set_to(value)[source]¶

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

name = 'amp'¶

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/features/amp'¶

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.

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

namespace = 'http://jabber.org/protocol/amp#errors'¶

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.

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

name = 'failed-rules'¶

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/amp#errors'¶

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

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 = {'rule': <class 'slixmpp.plugins.xep_0079.stanza.FailedRule'>, 'rules': <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_0079.stanza.FailedRule'>}¶

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/amp#errors}rule': <class 'slixmpp.plugins.xep_0079.stanza.FailedRule'>, '{jabber:client}stanza': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>}¶

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

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

name = 'invalid-rules'¶

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/amp'¶

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

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 = {'rule': <class 'slixmpp.plugins.xep_0079.stanza.Rule'>, 'rules': <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_0079.stanza.Rule'>}¶

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/amp}rule': <class 'slixmpp.plugins.xep_0079.stanza.Rule'>, '{jabber:client}stanza': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>}¶

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

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

interfaces = {'action', 'condition', '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 = 'rule'¶

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/amp'¶

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

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

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

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

name = 'unsupported-actions'¶

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/amp'¶

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

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 = {'rule': <class 'slixmpp.plugins.xep_0079.stanza.Rule'>, 'rules': <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_0079.stanza.Rule'>}¶

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/amp}rule': <class 'slixmpp.plugins.xep_0079.stanza.Rule'>, '{jabber:client}stanza': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>}¶

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

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

name = 'unsupported-conditions'¶

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/amp'¶

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

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 = {'rule': <class 'slixmpp.plugins.xep_0079.stanza.Rule'>, 'rules': <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_0079.stanza.Rule'>}¶

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/amp}rule': <class 'slixmpp.plugins.xep_0079.stanza.Rule'>, '{jabber:client}stanza': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>}¶

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