XEP-0441: Message Archive Management Preferences#
- class slixmpp.plugins.xep_0441.XEP_0441(xmpp, config=None)[source]#
XEP-0441: Message Archive Management Preferences
Stanza elements#
- class slixmpp.plugins.xep_0441.stanza.Preferences(xml=None, parent=None)[source]#
MAM Preferences payload.
<iq type='set' id='juliet3'> <prefs xmlns='urn:xmpp:mam:2' default='roster'> <always> <jid>romeo@montague.lit</jid> </always> <never> <jid>montague@montague.lit</jid> </never> </prefs> </iq>
- interfaces: ClassVar[Set[str]] = {'always', 'default', 'never'}#
Available interfaces:
default
: Default MAM policy (must be one of ‘roster’, ‘always’, ‘never’always
(List[JID]
): list of JIDs to always store conversations with.never
(List[JID]
): list of JIDs to never store conversations with.
- iterables: List[ElementBase]#
A list of child stanzas whose class is included in
plugin_iterables
.
- name: ClassVar[str] = 'prefs'#
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'urn:xmpp:mam:2'#
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.
- parent: Optional[ReferenceType[ElementBase]]#
A
weakref.weakref
to the parent stanza, if there is one. If not, thenparent
isNone
.
- plugin_attrib: ClassVar[str] = 'mam_prefs'#
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']
- plugins: Dict[Tuple[str, Optional[str]], ElementBase]#
An ordered dictionary of plugin stanzas, mapped by their
plugin_attrib
value.
- sub_interfaces: ClassVar[Set[str]] = {'always', 'never'}#
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.