XEP 0405

1.7 Documentation

«  XEP 0404   ::   Contents   ::   XEP 0421  »

XEP 0405

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

XEP-0405: MIX-PAM

async check_server_capability()[source]

Check if the server is MIX-PAM capable

Return type

bool

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

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)[source]

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

Return type

Iq

stanza = <module 'slixmpp.plugins.xep_0405.stanza' from '/home/docs/checkouts/readthedocs.org/user_builds/slixmpp/checkouts/slix-1.7.1/slixmpp/plugins/xep_0405/stanza.py'>

Stanza elements

Slixmpp: The Slick XMPP Library Copyright (C) 2020 Mathieu Pasquet <mathieui@mathieui.net> This file is part of Slixmpp.

See the file LICENSE for copying permissio

class slixmpp.plugins.xep_0405.stanza.ClientJoin(xml=None, parent=None)[source]
interfaces = {'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 = '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 = '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 = '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)[source]
interfaces = {'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 = '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 = '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 = '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()[source]

«  XEP 0404   ::   Contents   ::   XEP 0421  »