Skip to content
Back to top
View this page

# XEP-0085: Chat State Notifications

XEP-0085 on xmpp.org

class slixmpp.plugins.xep_0085.XEP_0085(xmpp, config=None)

  XEP-0085 Chat State Notifications

## Stanza elements

class slixmpp.plugins.xep_0085.stanza.Active(xml=None, parent=None)
  name: ClassVar[str] = 'active'

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

class slixmpp.plugins.xep_0085.stanza.ChatState(xml=None, parent=None)

  Example chat state stanzas:

      <message>
        <active xmlns="http://jabber.org/protocol/chatstates" />
      </message>

      <message>
        <paused xmlns="http://jabber.org/protocol/chatstates" />
      </message>

  del_chat_state()
  get_chat_state()
  interfaces: ClassVar[set[str]] = {'chat_state'}

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

    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 = 'http://jabber.org/protocol/chatstates'

    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] = 'chat_state'

    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_chat_state(state)
  setup(xml=None)

    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.

  states = {'active', 'composing', 'gone', 'inactive', 'paused'}
  sub_interfaces: ClassVar[set[str]] = {'chat_state'}

    A subset of `interfaces` which maps interfaces to direct subelements of the underlying XML object. Using this set, the text of these subelements may be set, retrieved, or removed without needing to define custom methods.

class slixmpp.plugins.xep_0085.stanza.Composing(xml=None, parent=None)
  name: ClassVar[str] = 'composing'

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

class slixmpp.plugins.xep_0085.stanza.Gone(xml=None, parent=None)
  name: ClassVar[str] = 'gone'

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

class slixmpp.plugins.xep_0085.stanza.Inactive(xml=None, parent=None)
  name: ClassVar[str] = 'inactive'

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

class slixmpp.plugins.xep_0085.stanza.Paused(xml=None, parent=None)
  name: ClassVar[str] = 'paused'

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