Skip to content
Back to top
View this page

# XEP-0224: Attention

class slixmpp.plugins.xep_0224.XEP_0224(xmpp, config=None)

  XEP-0224: Attention

  dependencies: ClassVar[Set[str]] = {'xep_0030'}

    Some plugins may depend on others in order to function properly. Any plugin names included in `dependencies` will be initialized as needed if this plugin is enabled.

  description: str = 'XEP-0224: Attention'

    A longer name for the plugin, describing its purpose. For example, a plugin for XEP-0030 would use ‘Service Discovery’ as its description value.

  name: str = 'xep_0224'

    A short name for the plugin based on the implemented specification. For example, a plugin for XEP-0030 would use ‘xep_0030’.

  request_attention(to, mfrom=None, mbody='')

    Send an attention message with an optional body.

    Arguments:

      to – The attention request recipient’s JID. mfrom – Optionally specify the sender of the attention request. mbody – An optional message body to include in the request.

## Stanza elements

class slixmpp.plugins.xep_0224.stanza.Attention(xml=None, parent=None)
  del_attention()
  get_attention()
  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 the `plugin_attrib` value to the desired interface name, and that it is the only interface listed in `interfaces`. Requests for the new interface from the parent stanza will be passed to the plugin directly.

    Added 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 use `name = 'message'`.

  namespace: str = 'urn:xmpp:attention: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: ClassVar[str] = 'attention'

    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_attention(value)
  setup(xml)

    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.