XEP-0334: Message Processing Hints#

class slixmpp.plugins.xep_0334.XEP_0334(xmpp, config=None)[source]#

stanza = <module 'slixmpp.plugins.xep_0334.stanza' from '/home/docs/checkouts/readthedocs.org/user_builds/slixmpp/checkouts/latest/slixmpp/plugins/xep_0334/stanza.py'>#

Stanza elements#

slixmpp: The Slick XMPP Library Implementation of Message Processing Hints http://xmpp.org/extensions/xep-0334.html This file is part of slixmpp.

See the file LICENSE for copying permission.

class slixmpp.plugins.xep_0334.stanza.NoCopy(xml=None, parent=None)[source]#

iterables: List[ElementBase]#: A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]#

name: ClassVar[str] = 'no-copy'#: 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 = 'urn:xmpp:hints'#: 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] = 'no-copy'#

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.

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_0334.stanza.NoPermanentStore(xml=None, parent=None)[source]#

iterables: List[ElementBase]#: A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]#

name: ClassVar[str] = 'no-permanent-store'#: 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 = 'urn:xmpp:hints'#: 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] = 'no-permanent-store'#

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.

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_0334.stanza.NoStore(xml=None, parent=None)[source]#

iterables: List[ElementBase]#: A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]#

name: ClassVar[str] = 'no-store'#: 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 = 'urn:xmpp:hints'#: 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] = 'no-store'#

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.

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_0334.stanza.Store(xml=None, parent=None)[source]#

iterables: List[ElementBase]#: A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]#

name: ClassVar[str] = 'store'#: 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 = 'urn:xmpp:hints'#: 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] = 'store'#

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.

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.