XEP-0437: Room Activity Indicators

class slixmpp.plugins.xep_0437.XEP_0437(xmpp, config=None)

description: str = 'XEP-0437: Room Activity Indicators'

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

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

subscribe(service, *, pfrom=None)

Subscribe to room activty on a MUC service. :param JID service: MUC service

unsubscribe(service, *, pfrom=None)

Unsubscribe from room activty on a MUC service. :param JID service: MUC service

Stanza elements

class slixmpp.plugins.xep_0437.stanza.Activity(xml=None, parent=None)

name: ClassVar[str] = 'activity'

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:rai: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] = 'activity'

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

class slixmpp.plugins.xep_0437.stanza.RAI(xml=None, parent=None)

del_activities()

get_activities()

Return type:

Iterable[JID]

interfaces: ClassVar[Set[str]] = {'activities'}

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.

name: ClassVar[str] = 'rai'

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

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_activities(activities)

slixmpp.plugins.xep_0437.stanza.register_plugins()