XEP-0405: MIX-PAM

class slixmpp.plugins.xep_0405.XEP_0405(xmpp, config=None)

XEP-0405: MIX-PAM

async check_server_capability()

Check if the server is MIX-PAM capable

Return type:

bool

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

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-0405: MIX-PAM'

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

async get_mix_roster(*, ito=None, ifrom=None, **iqkwargs)

Get the annotated roster, with MIX channels.

Return type:

Tuple[List[RosterItem], List[RosterItem]]

Returns:

A tuple of (contacts, mix channels) as RosterItem elements

async join_channel(room, nick, subscribe=None, *, ito=None, ifrom=None, **iqkwargs)

Join a MIX channel.

Parameters:

• room (JID) – JID of the MIX channel

• nick (str) – Desired nickname on that channel

• subscribe (Set[str]) – Set of nodes to subscribe to when joining. If empty, all nodes will be subscribed by default.

Return type:

Set[str]

Returns:

The nodes that failed to subscribe, if any

async leave_channel(room, *, ito=None, ifrom=None, **iqkwargs)

” :rtype: Iq

Leave a MIX channel :param JID room: JID of the channel to leave

name: str = 'xep_0405'

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_0405.stanza.Annotate(xml=None, parent=None)

name: ClassVar[str] = 'annotate'

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:mix:roster: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] = 'annotate'

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_0405.stanza.Channel(xml=None, parent=None)

interfaces: ClassVar[Set[str]] = {'participant-id'}

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

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:mix:roster: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] = 'channel'

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_0405.stanza.ClientJoin(xml=None, parent=None)

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

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

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:mix:pam:2'

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

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_0405.stanza.ClientLeave(xml=None, parent=None)

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

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

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:mix:pam:2'

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

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_0405.stanza.register_plugins()