XEP-0049: Private XML Storage¶
- class slixmpp.plugins.xep_0049.XEP_0049(xmpp, config=None)[source]¶
- retrieve(name, ifrom=None, **iqkwargs)[source]¶
Get previously stored data from Private XML Storage.
- Parameters
name (
str
) – Name of the payload to retrieve (slixmpp plugin attribute)- Return type
Future
- store(data, ifrom=None, **iqkwargs)[source]¶
Store data in Private XML Storage.
- Parameters
data (
Union
[List
[ElementBase
],ElementBase
]) – An XML element or list of xml element to store.- Return type
Future
Stanza elements¶
- class slixmpp.plugins.xep_0049.stanza.PrivateXML(xml=None, parent=None)[source]¶
- interfaces: ClassVar[Set[str]] = {}¶
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] = 'query'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'jabber:iq:private'¶
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] = 'private'¶
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.
- 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.