XEP-0404: MIX-ANON

class slixmpp.plugins.xep_0404.XEP_0404(xmpp, config=None)

XEP-0404: MIX JID Hidden Channels

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-0404: MIX-ANON'

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_anon_by_id(channel, *, ifrom=None, **pubsubkwargs)

Get the jid-participant mapping, by participant id

Parameters:

channel (JID) – MIX channel JID

Return type:

Dict[str, JID]

async get_anon_by_jid(channel, *, ifrom=None, **pubsubkwargs)

Get the jid-participant mapping, by JID

Parameters:

channel (JID) – MIX channel JID

Return type:

Dict[JID, str]

async get_anon_raw(channel, *, ifrom=None, **pubsubkwargs)

Get the jid-participant mapping result (raw). :param JID channel: MIX channel JID

Return type:

Iq

async get_preferences(channel, *, ifrom=None, **iqkwargs)

Get channel preferences with default values. :param JID channel: MIX channel JID

Return type:

Form

name: str = 'xep_0404'

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

async set_preferences(channel, form, *, ifrom=None, **iqkwargs)

Set channel preferences :param JID channel: MIX channel JID :param Form form: A 0004 form with updated preferences

Return type:

Form

Stanza elements

class slixmpp.plugins.xep_0404.stanza.Participant(xml=None, parent=None)

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

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

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

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

sub_interfaces: ClassVar[Set[str]] = {'jid'}

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

name: ClassVar[str] = 'user-preference'

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

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