XEP-0224: Attention¶
Stanza elements¶
- class slixmpp.plugins.xep_0224.stanza.Attention(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'attention'}¶
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.
- is_extension: ClassVar[bool] = True¶
If you need to add a new interface to an existing stanza, you can create a plugin and set
is_extension = True
. Be sure to set theplugin_attrib
value to the desired interface name, and that it is the only interface listed ininterfaces
. Requests for the new interface from the parent stanza will be passed to the plugin directly.New in version 1.0-Beta5.
- name: ClassVar[str] = 'attention'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'urn:xmpp:attention:0'¶
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] = 'attention'¶
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']
- setup(xml)[source]¶
Initialize the stanza’s XML contents.
Will return
True
if XML was generated according to the stanza’s definition instead of building a stanza object from an existing XML object.- Parameters
xml – An existing XML object to use for the stanza’s content instead of generating new XML.