XEP-0404: MIX-ANON

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

XEP-0404: MIX JID Hidden Channels

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

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.

iterables: List[ElementBase]

A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]

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.

parent: Optional[ReferenceType[ElementBase]]

A weakref.weakref to the parent stanza, if there is one. If not, then parent is None.

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

plugins: Dict[Tuple[str, Optional[str]], ElementBase]

An ordered dictionary of plugin stanzas, mapped by their plugin_attrib value.

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.

tag: str

The name of the tag for the stanza’s root element. It is the same as calling tag_name() and is formatted as '{namespace}elementname'.

xml: ET.Element

The underlying XML object for the stanza. It is a standard xml.etree.ElementTree object.

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

iterables: List[ElementBase]

A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]

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.

parent: Optional[ReferenceType[ElementBase]]

A weakref.weakref to the parent stanza, if there is one. If not, then parent is None.

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

plugins: Dict[Tuple[str, Optional[str]], ElementBase]

An ordered dictionary of plugin stanzas, mapped by their plugin_attrib value.

tag: str

The name of the tag for the stanza’s root element. It is the same as calling tag_name() and is formatted as '{namespace}elementname'.

xml: ET.Element

The underlying XML object for the stanza. It is a standard xml.etree.ElementTree object.

slixmpp.plugins.xep_0404.stanza.register_plugins()