XEP-0490: Message Displayed Synchronization

class slixmpp.plugins.xep_0490.XEP_0490(xmpp, config=None)

XEP-0490: Message Displayed Synchronization

catch_up(**kwargs)

Get all displayed status.

Can take any keyword parameters from XEP-0060’s get_items().

Return type:

Future[Iq]

dependencies: ClassVar[set[str]] = {'xep_0060', 'xep_0163', 'xep_0223', 'xep_0359'}

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-0490: Message Displayed Synchronization'

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

flag_chat(chat, stanza_id, **kwargs)

Flag a chat as displayed.

Parameters:

• chat (str | JID) – JID of the chat to set as displayed.

• stanza_id (str) – stanza-id of which to set the display marker.

Return type:

Future[Iq]

name: str = 'xep_0490'

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

Stanza elements

class slixmpp.plugins.xep_0490.stanza.Displayed(xml=None, parent=None)

Displayed element.

<displayed xmlns='urn:xmpp:mds:displayed:0'>
  <stanza-id xmlns='urn:xmpp:sid:0'
             id='ca21deaf-812c-48f1-8f16-339a674f2864'
             by='example@conference.shakespeare.lit'/>
</displayed>

name: ClassVar[str] = 'displayed'

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:mds:displayed: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] = 'displayed'

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

slixmpp.plugins.xep_0490.stanza.register_plugin()