XEP 0404¶
- class slixmpp.plugins.xep_0404.XEP_0404(xmpp, config=None)[source]¶
XEP-0404: MIX JID Hidden Channels
- async get_anon_by_id(channel, *, ifrom=None, **pubsubkwargs)[source]¶
Get the jid-participant mapping, by participant id
- async get_anon_by_jid(channel, *, ifrom=None, **pubsubkwargs)[source]¶
Get the jid-participant mapping, by JID
- async get_anon_raw(channel, *, ifrom=None, **pubsubkwargs)[source]¶
Get the jid-participant mapping result (raw). :param JID channel: MIX channel JID
- Return type
- async get_preferences(channel, *, ifrom=None, **iqkwargs)[source]¶
Get channel preferences with default values. :param JID channel: MIX channel JID
- Return type
- async set_preferences(channel, form, *, ifrom=None, **iqkwargs)[source]¶
Set channel preferences :param JID channel: MIX channel JID :param Form form: A 0004 form with updated preferences
- Return type
- stanza = <module 'slixmpp.plugins.xep_0404.stanza' from '/home/docs/checkouts/readthedocs.org/user_builds/slixmpp/checkouts/slix-1.7.1/slixmpp/plugins/xep_0404/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_0404.stanza.Participant(xml=None, parent=None)[source]¶
- interfaces = {'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 = 'participant'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace = 'urn:xmpp:mix:anon:0'¶
The XML namespace for the element. Given
<foo xmlns="bar" />
, thennamespace = "bar"
should be used. The default namespace isjabber:client
since this is being used in an XMPP library.
- plugin_attrib = 'anon_participant'¶
For
ElementBase
subclasses which are intended to be used as plugins, theplugin_attrib
value defines the plugin name. Plugins may be accessed by using theplugin_attrib
value as the interface. An example usingplugin_attrib = 'foo'
:register_stanza_plugin(Message, FooPlugin) msg = Message() msg['foo']['an_interface_from_the_foo_plugin']
- sub_interfaces = {'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)[source]¶
- name = 'user-preference'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace = 'urn:xmpp:mix:anon:0'¶
The XML namespace for the element. Given
<foo xmlns="bar" />
, thennamespace = "bar"
should be used. The default namespace isjabber:client
since this is being used in an XMPP library.
- plugin_attrib = 'user_preference'¶
For
ElementBase
subclasses which are intended to be used as plugins, theplugin_attrib
value defines the plugin name. Plugins may be accessed by using theplugin_attrib
value as the interface. An example usingplugin_attrib = 'foo'
:register_stanza_plugin(Message, FooPlugin) msg = Message() msg['foo']['an_interface_from_the_foo_plugin']