XEP-0054: vcard-temp¶
- class slixmpp.plugins.xep_0054.XEP_0054(xmpp, config=None)[source]¶
XEP-0054: vcard-temp
- dependencies: ClassVar[Set[str]] = {'xep_0030', 'xep_0082'}¶
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-0054: vcard-temp'¶
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_vcard(jid=None, *, local=None, cached=False, ifrom=None, **iqkwargs)[source]¶
Retrieve a VCard.
Changed in version 1.8.0: This function is now a coroutine.
- name: str = 'xep_0054'¶
A short name for the plugin based on the implemented specification. For example, a plugin for XEP-0030 would use ‘xep_0030’.
Internal API methods¶
This plugin maintains by default an in-memory cache of the received VCards.
- set_vcard¶
jid:
JID
of whom to set the vcardnode: unused
ifrom: unused
args:
VCardTemp
object to store for this JID.
Set a VCard for a JID.
- get_vcard¶
jid:
JID
of whom to set the vcardnode: unused
ifrom:
JID
the request is coming fromargs: unused
returns:
VCardTemp
object for this JID or None.
Get a stored VCard for a JID.
- del_vcard¶
jid:
JID
of whom to set the vcardnode: unused
ifrom: unused
args: unused
Delete a stored VCard for a JID.
Stanza elements¶
- class slixmpp.plugins.xep_0054.stanza.Address(xml=None, parent=None)[source]¶
- bool_interfaces: ClassVar[Set[str]] = {'DOM', 'HOME', 'INTL', 'PREF', 'WORK'}¶
A subset of
interfaces
which maps the presence of subelements to boolean values. Using this set allows for quickly checking for the existence of empty subelements like<required />
.Added in version 1.1.
- interfaces: ClassVar[Set[str]] = {'CTRY', 'DOM', 'EXTADD', 'HOME', 'INTL', 'LOCALITY', 'PARCEL', 'PCODE', 'POBOX', 'POSTAL', 'PREF', 'REGION', 'STREET', 'WORK'}¶
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] = 'ADR'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'ADR'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'addresses'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- sub_interfaces: ClassVar[Set[str]] = {'CTRY', 'EXTADD', 'LOCALITY', 'PCODE', 'POBOX', 'REGION', 'STREET'}¶
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_0054.stanza.Agent(xml=None, parent=None)[source]¶
- interfaces: ClassVar[Set[str]] = {'EXTVAL'}¶
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] = 'AGENT'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'AGENT'¶
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']
- plugin_attrib_map: ClassVar[Dict[str, Type[ElementBase]]] = {'vcard_temp': <class 'slixmpp.plugins.xep_0054.stanza.VCardTemp'>}¶
A mapping of the
plugin_attrib
values of registered plugins to their respective classes.
- plugin_iterables: ClassVar[Set[Type[ElementBase]]] = {}¶
The set of stanza classes that can be iterated over using the ‘substanzas’ interface. Classes are added to this set when registering a plugin with
iterable=True
:register_stanza_plugin(DiscoInfo, DiscoItem, iterable=True)
Added in version 1.0-Beta5.
- plugin_multi_attrib: ClassVar[str] = 'agents'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- plugin_overrides: ClassVar[Dict[str, str]] = {}¶
A map of interface operations to the overriding functions. For example, after overriding the
set
operation for the interfacebody
,plugin_overrides
would be:{'set_body': <some function>}
- plugin_tag_map: ClassVar[Dict[str, Type[ElementBase]]] = {'{vcard-temp}vCard': <class 'slixmpp.plugins.xep_0054.stanza.VCardTemp'>}¶
A mapping of root element tag names (in
'{namespace}elementname'
format) to the plugin classes responsible for them.
- sub_interfaces: ClassVar[Set[str]] = {'EXTVAL'}¶
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_0054.stanza.BinVal(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'BINVAL'}¶
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.
- is_extension: ClassVar[bool] = True¶
If you need to add a new interface to an existing stanza, you can create a plugin and set
is_extension = True
. Be sure to set theplugin_attrib
value to the desired interface name, and that it is the only interface listed ininterfaces
. Requests for the new interface from the parent stanza will be passed to the plugin directly.Added in version 1.0-Beta5.
- name: ClassVar[str] = 'BINVAL'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'BINVAL'¶
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']
- setup(xml=None)[source]¶
Initialize the stanza’s XML contents.
Will return
True
if XML was generated according to the stanza’s definition instead of building a stanza object from an existing XML object.- Parameters:
xml – An existing XML object to use for the stanza’s content instead of generating new XML.
- class slixmpp.plugins.xep_0054.stanza.Birthday(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'BDAY'}¶
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.
- is_extension: ClassVar[bool] = True¶
If you need to add a new interface to an existing stanza, you can create a plugin and set
is_extension = True
. Be sure to set theplugin_attrib
value to the desired interface name, and that it is the only interface listed ininterfaces
. Requests for the new interface from the parent stanza will be passed to the plugin directly.Added in version 1.0-Beta5.
- name: ClassVar[str] = 'BDAY'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'BDAY'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'birthdays'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- class slixmpp.plugins.xep_0054.stanza.Categories(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'CATEGORIES'}¶
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.
- is_extension: ClassVar[bool] = True¶
If you need to add a new interface to an existing stanza, you can create a plugin and set
is_extension = True
. Be sure to set theplugin_attrib
value to the desired interface name, and that it is the only interface listed ininterfaces
. Requests for the new interface from the parent stanza will be passed to the plugin directly.Added in version 1.0-Beta5.
- name: ClassVar[str] = 'CATEGORIES'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'CATEGORIES'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'categories'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- class slixmpp.plugins.xep_0054.stanza.Classification(xml=None, parent=None)[source]¶
- bool_interfaces: ClassVar[Set[str]] = {'CONFIDENTIAL', 'PRIVATE', 'PUBLIC'}¶
A subset of
interfaces
which maps the presence of subelements to boolean values. Using this set allows for quickly checking for the existence of empty subelements like<required />
.Added in version 1.1.
- interfaces: ClassVar[Set[str]] = {'CONFIDENTIAL', 'PRIVATE', 'PUBLIC'}¶
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] = 'CLASS'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'CLASS'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'classifications'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- class slixmpp.plugins.xep_0054.stanza.Desc(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'DESC'}¶
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.
- is_extension: ClassVar[bool] = True¶
If you need to add a new interface to an existing stanza, you can create a plugin and set
is_extension = True
. Be sure to set theplugin_attrib
value to the desired interface name, and that it is the only interface listed ininterfaces
. Requests for the new interface from the parent stanza will be passed to the plugin directly.Added in version 1.0-Beta5.
- name: ClassVar[str] = 'DESC'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'DESC'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'descriptions'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- class slixmpp.plugins.xep_0054.stanza.Email(xml=None, parent=None)[source]¶
- bool_interfaces: ClassVar[Set[str]] = {'HOME', 'INTERNET', 'PREF', 'WORK', 'X400'}¶
A subset of
interfaces
which maps the presence of subelements to boolean values. Using this set allows for quickly checking for the existence of empty subelements like<required />
.Added in version 1.1.
- interfaces: ClassVar[Set[str]] = {'HOME', 'INTERNET', 'PREF', 'USERID', 'WORK', 'X400'}¶
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] = 'EMAIL'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'EMAIL'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'emails'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- sub_interfaces: ClassVar[Set[str]] = {'USERID'}¶
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_0054.stanza.Geo(xml=None, parent=None)[source]¶
- interfaces: ClassVar[Set[str]] = {'LAT', 'LON'}¶
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] = 'GEO'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'GEO'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'geolocations'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- sub_interfaces: ClassVar[Set[str]] = {'LAT', 'LON'}¶
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_0054.stanza.JabberID(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'JABBERID'}¶
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.
- is_extension: ClassVar[bool] = True¶
If you need to add a new interface to an existing stanza, you can create a plugin and set
is_extension = True
. Be sure to set theplugin_attrib
value to the desired interface name, and that it is the only interface listed ininterfaces
. Requests for the new interface from the parent stanza will be passed to the plugin directly.Added in version 1.0-Beta5.
- name: ClassVar[str] = 'JABBERID'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'JABBERID'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'jids'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- class slixmpp.plugins.xep_0054.stanza.Label(xml=None, parent=None)[source]¶
-
- bool_interfaces: ClassVar[Set[str]] = {'DOM', 'HOME', 'INT', 'PARCEL', 'POSTAL', 'PREF', 'WORK'}¶
A subset of
interfaces
which maps the presence of subelements to boolean values. Using this set allows for quickly checking for the existence of empty subelements like<required />
.Added in version 1.1.
- interfaces: ClassVar[Set[str]] = {'DOM', 'HOME', 'INT', 'PARCEL', 'POSTAL', 'PREF', 'WORK', 'lines'}¶
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] = 'LABEL'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'LABEL'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'labels'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- class slixmpp.plugins.xep_0054.stanza.Logo(xml=None, parent=None)[source]¶
- interfaces: ClassVar[Set[str]] = {'EXTVAL', 'TYPE'}¶
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] = 'LOGO'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'LOGO'¶
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']
- plugin_attrib_map: ClassVar[Dict[str, Type[ElementBase]]] = {'BINVAL': <class 'slixmpp.plugins.xep_0054.stanza.BinVal'>}¶
A mapping of the
plugin_attrib
values of registered plugins to their respective classes.
- plugin_iterables: ClassVar[Set[Type[ElementBase]]] = {}¶
The set of stanza classes that can be iterated over using the ‘substanzas’ interface. Classes are added to this set when registering a plugin with
iterable=True
:register_stanza_plugin(DiscoInfo, DiscoItem, iterable=True)
Added in version 1.0-Beta5.
- plugin_multi_attrib: ClassVar[str] = 'logos'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- plugin_overrides: ClassVar[Dict[str, str]] = {}¶
A map of interface operations to the overriding functions. For example, after overriding the
set
operation for the interfacebody
,plugin_overrides
would be:{'set_body': <some function>}
- plugin_tag_map: ClassVar[Dict[str, Type[ElementBase]]] = {'{vcard-temp}BINVAL': <class 'slixmpp.plugins.xep_0054.stanza.BinVal'>}¶
A mapping of root element tag names (in
'{namespace}elementname'
format) to the plugin classes responsible for them.
- sub_interfaces: ClassVar[Set[str]] = {'EXTVAL', 'TYPE'}¶
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_0054.stanza.Mailer(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'MAILER'}¶
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.
- is_extension: ClassVar[bool] = True¶
If you need to add a new interface to an existing stanza, you can create a plugin and set
is_extension = True
. Be sure to set theplugin_attrib
value to the desired interface name, and that it is the only interface listed ininterfaces
. Requests for the new interface from the parent stanza will be passed to the plugin directly.Added in version 1.0-Beta5.
- name: ClassVar[str] = 'MAILER'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'MAILER'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'mailers'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- class slixmpp.plugins.xep_0054.stanza.Name(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'FAMILY', 'GIVEN', 'MIDDLE', 'PREFIX', 'SUFFIX'}¶
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] = 'N'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'N'¶
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: ClassVar[Set[str]] = {'FAMILY', 'GIVEN', 'MIDDLE', 'PREFIX', 'SUFFIX'}¶
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_0054.stanza.Nickname(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'NICKNAME'}¶
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.
- is_extension: ClassVar[bool] = True¶
If you need to add a new interface to an existing stanza, you can create a plugin and set
is_extension = True
. Be sure to set theplugin_attrib
value to the desired interface name, and that it is the only interface listed ininterfaces
. Requests for the new interface from the parent stanza will be passed to the plugin directly.Added in version 1.0-Beta5.
- name: ClassVar[str] = 'NICKNAME'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'NICKNAME'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'nicknames'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- class slixmpp.plugins.xep_0054.stanza.Note(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'NOTE'}¶
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.
- is_extension: ClassVar[bool] = True¶
If you need to add a new interface to an existing stanza, you can create a plugin and set
is_extension = True
. Be sure to set theplugin_attrib
value to the desired interface name, and that it is the only interface listed ininterfaces
. Requests for the new interface from the parent stanza will be passed to the plugin directly.Added in version 1.0-Beta5.
- name: ClassVar[str] = 'NOTE'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'NOTE'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'notes'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- class slixmpp.plugins.xep_0054.stanza.Org(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'ORGNAME', 'ORGUNIT', 'orgunits'}¶
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] = 'ORG'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'ORG'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'organizations'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- sub_interfaces: ClassVar[Set[str]] = {'ORGNAME', 'ORGUNIT'}¶
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_0054.stanza.Photo(xml=None, parent=None)[source]¶
- interfaces: ClassVar[Set[str]] = {'EXTVAL', 'TYPE'}¶
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] = 'PHOTO'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'PHOTO'¶
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']
- plugin_attrib_map: ClassVar[Dict[str, Type[ElementBase]]] = {'BINVAL': <class 'slixmpp.plugins.xep_0054.stanza.BinVal'>}¶
A mapping of the
plugin_attrib
values of registered plugins to their respective classes.
- plugin_iterables: ClassVar[Set[Type[ElementBase]]] = {}¶
The set of stanza classes that can be iterated over using the ‘substanzas’ interface. Classes are added to this set when registering a plugin with
iterable=True
:register_stanza_plugin(DiscoInfo, DiscoItem, iterable=True)
Added in version 1.0-Beta5.
- plugin_multi_attrib: ClassVar[str] = 'photos'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- plugin_overrides: ClassVar[Dict[str, str]] = {}¶
A map of interface operations to the overriding functions. For example, after overriding the
set
operation for the interfacebody
,plugin_overrides
would be:{'set_body': <some function>}
- plugin_tag_map: ClassVar[Dict[str, Type[ElementBase]]] = {'{vcard-temp}BINVAL': <class 'slixmpp.plugins.xep_0054.stanza.BinVal'>}¶
A mapping of root element tag names (in
'{namespace}elementname'
format) to the plugin classes responsible for them.
- sub_interfaces: ClassVar[Set[str]] = {'EXTVAL', 'TYPE'}¶
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_0054.stanza.ProdID(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'PRODID'}¶
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.
- is_extension: ClassVar[bool] = True¶
If you need to add a new interface to an existing stanza, you can create a plugin and set
is_extension = True
. Be sure to set theplugin_attrib
value to the desired interface name, and that it is the only interface listed ininterfaces
. Requests for the new interface from the parent stanza will be passed to the plugin directly.Added in version 1.0-Beta5.
- name: ClassVar[str] = 'PRODID'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'PRODID'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'product_ids'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- class slixmpp.plugins.xep_0054.stanza.Rev(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'REV'}¶
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.
- is_extension: ClassVar[bool] = True¶
If you need to add a new interface to an existing stanza, you can create a plugin and set
is_extension = True
. Be sure to set theplugin_attrib
value to the desired interface name, and that it is the only interface listed ininterfaces
. Requests for the new interface from the parent stanza will be passed to the plugin directly.Added in version 1.0-Beta5.
- name: ClassVar[str] = 'REV'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'REV'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'revision_dates'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- class slixmpp.plugins.xep_0054.stanza.Role(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'ROLE'}¶
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.
- is_extension: ClassVar[bool] = True¶
If you need to add a new interface to an existing stanza, you can create a plugin and set
is_extension = True
. Be sure to set theplugin_attrib
value to the desired interface name, and that it is the only interface listed ininterfaces
. Requests for the new interface from the parent stanza will be passed to the plugin directly.Added in version 1.0-Beta5.
- name: ClassVar[str] = 'ROLE'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'ROLE'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'roles'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- class slixmpp.plugins.xep_0054.stanza.SortString(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'SORT-STRING'}¶
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.
- is_extension: ClassVar[bool] = True¶
If you need to add a new interface to an existing stanza, you can create a plugin and set
is_extension = True
. Be sure to set theplugin_attrib
value to the desired interface name, and that it is the only interface listed ininterfaces
. Requests for the new interface from the parent stanza will be passed to the plugin directly.Added in version 1.0-Beta5.
- name: ClassVar[str] = 'SORT-STRING'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'SORT_STRING'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'sort_strings'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- class slixmpp.plugins.xep_0054.stanza.Sound(xml=None, parent=None)[source]¶
- interfaces: ClassVar[Set[str]] = {'EXTVAL', 'PHONETC'}¶
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] = 'SOUND'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'SOUND'¶
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']
- plugin_attrib_map: ClassVar[Dict[str, Type[ElementBase]]] = {'BINVAL': <class 'slixmpp.plugins.xep_0054.stanza.BinVal'>}¶
A mapping of the
plugin_attrib
values of registered plugins to their respective classes.
- plugin_iterables: ClassVar[Set[Type[ElementBase]]] = {}¶
The set of stanza classes that can be iterated over using the ‘substanzas’ interface. Classes are added to this set when registering a plugin with
iterable=True
:register_stanza_plugin(DiscoInfo, DiscoItem, iterable=True)
Added in version 1.0-Beta5.
- plugin_multi_attrib: ClassVar[str] = 'sounds'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- plugin_overrides: ClassVar[Dict[str, str]] = {}¶
A map of interface operations to the overriding functions. For example, after overriding the
set
operation for the interfacebody
,plugin_overrides
would be:{'set_body': <some function>}
- plugin_tag_map: ClassVar[Dict[str, Type[ElementBase]]] = {'{vcard-temp}BINVAL': <class 'slixmpp.plugins.xep_0054.stanza.BinVal'>}¶
A mapping of root element tag names (in
'{namespace}elementname'
format) to the plugin classes responsible for them.
- sub_interfaces: ClassVar[Set[str]] = {'EXTVAL', 'PHONETC'}¶
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_0054.stanza.Telephone(xml=None, parent=None)[source]¶
- bool_interfaces: ClassVar[Set[str]] = {'BBS', 'CELL', 'FAX', 'HOME', 'ISDN', 'MODEM', 'MSG', 'PAGER', 'PCS', 'PREF', 'VIDEO', 'VOICE', 'WORK'}¶
A subset of
interfaces
which maps the presence of subelements to boolean values. Using this set allows for quickly checking for the existence of empty subelements like<required />
.Added in version 1.1.
- interfaces: ClassVar[Set[str]] = {'BBS', 'CELL', 'FAX', 'HOME', 'ISDN', 'MODEM', 'MSG', 'NUMBER', 'PAGER', 'PCS', 'PREF', 'VIDEO', 'VOICE', 'WORK'}¶
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] = 'TEL'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'TEL'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'telephone_numbers'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- setup(xml=None)[source]¶
Initialize the stanza’s XML contents.
Will return
True
if XML was generated according to the stanza’s definition instead of building a stanza object from an existing XML object.- Parameters:
xml – An existing XML object to use for the stanza’s content instead of generating new XML.
- sub_interfaces: ClassVar[Set[str]] = {'NUMBER'}¶
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_0054.stanza.TimeZone(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'TZ'}¶
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.
- is_extension: ClassVar[bool] = True¶
If you need to add a new interface to an existing stanza, you can create a plugin and set
is_extension = True
. Be sure to set theplugin_attrib
value to the desired interface name, and that it is the only interface listed ininterfaces
. Requests for the new interface from the parent stanza will be passed to the plugin directly.Added in version 1.0-Beta5.
- name: ClassVar[str] = 'TZ'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'TZ'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'timezones'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- class slixmpp.plugins.xep_0054.stanza.Title(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'TITLE'}¶
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.
- is_extension: ClassVar[bool] = True¶
If you need to add a new interface to an existing stanza, you can create a plugin and set
is_extension = True
. Be sure to set theplugin_attrib
value to the desired interface name, and that it is the only interface listed ininterfaces
. Requests for the new interface from the parent stanza will be passed to the plugin directly.Added in version 1.0-Beta5.
- name: ClassVar[str] = 'TITLE'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'TITLE'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'titles'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- class slixmpp.plugins.xep_0054.stanza.UID(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'UID'}¶
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.
- is_extension: ClassVar[bool] = True¶
If you need to add a new interface to an existing stanza, you can create a plugin and set
is_extension = True
. Be sure to set theplugin_attrib
value to the desired interface name, and that it is the only interface listed ininterfaces
. Requests for the new interface from the parent stanza will be passed to the plugin directly.Added in version 1.0-Beta5.
- name: ClassVar[str] = 'UID'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'UID'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'uids'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- class slixmpp.plugins.xep_0054.stanza.URL(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'URL'}¶
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.
- is_extension: ClassVar[bool] = True¶
If you need to add a new interface to an existing stanza, you can create a plugin and set
is_extension = True
. Be sure to set theplugin_attrib
value to the desired interface name, and that it is the only interface listed ininterfaces
. Requests for the new interface from the parent stanza will be passed to the plugin directly.Added in version 1.0-Beta5.
- name: ClassVar[str] = 'URL'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'URL'¶
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']
- plugin_multi_attrib: ClassVar[str] = 'urls'¶
For
ElementBase
subclasses that are intended to be an iterable group of items, theplugin_multi_attrib
value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:# Given stanza class Foo, with plugin_multi_attrib = 'foos' parent['foos'] filter(isinstance(item, Foo), parent['substanzas'])
- class slixmpp.plugins.xep_0054.stanza.VCardTemp(xml=None, parent=None)[source]¶
- interfaces: ClassVar[Set[str]] = {'FN', 'VERSION'}¶
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] = 'vCard'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'vcard-temp'¶
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: ClassVar[str] = 'vcard_temp'¶
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']
- plugin_attrib_map: ClassVar[Dict[str, Type[ElementBase]]] = {'ADR': <class 'slixmpp.plugins.xep_0054.stanza.Address'>, 'AGENT': <class 'slixmpp.plugins.xep_0054.stanza.Agent'>, 'BDAY': <class 'slixmpp.plugins.xep_0054.stanza.Birthday'>, 'CATEGORIES': <class 'slixmpp.plugins.xep_0054.stanza.Categories'>, 'DESC': <class 'slixmpp.plugins.xep_0054.stanza.Desc'>, 'EMAIL': <class 'slixmpp.plugins.xep_0054.stanza.Email'>, 'GEO': <class 'slixmpp.plugins.xep_0054.stanza.Geo'>, 'JABBERID': <class 'slixmpp.plugins.xep_0054.stanza.JabberID'>, 'LABEL': <class 'slixmpp.plugins.xep_0054.stanza.Label'>, 'LOGO': <class 'slixmpp.plugins.xep_0054.stanza.Logo'>, 'MAILER': <class 'slixmpp.plugins.xep_0054.stanza.Mailer'>, 'N': <class 'slixmpp.plugins.xep_0054.stanza.Name'>, 'NICKNAME': <class 'slixmpp.plugins.xep_0054.stanza.Nickname'>, 'NOTE': <class 'slixmpp.plugins.xep_0054.stanza.Note'>, 'ORG': <class 'slixmpp.plugins.xep_0054.stanza.Org'>, 'PHOTO': <class 'slixmpp.plugins.xep_0054.stanza.Photo'>, 'PRODID': <class 'slixmpp.plugins.xep_0054.stanza.ProdID'>, 'REV': <class 'slixmpp.plugins.xep_0054.stanza.Rev'>, 'ROLE': <class 'slixmpp.plugins.xep_0054.stanza.Role'>, 'SORT_STRING': <class 'slixmpp.plugins.xep_0054.stanza.SortString'>, 'SOUND': <class 'slixmpp.plugins.xep_0054.stanza.Sound'>, 'TEL': <class 'slixmpp.plugins.xep_0054.stanza.Telephone'>, 'TITLE': <class 'slixmpp.plugins.xep_0054.stanza.Title'>, 'TZ': <class 'slixmpp.plugins.xep_0054.stanza.TimeZone'>, 'UID': <class 'slixmpp.plugins.xep_0054.stanza.UID'>, 'URL': <class 'slixmpp.plugins.xep_0054.stanza.URL'>, 'addresses': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'agents': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'birthdays': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'categories': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'descriptions': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'emails': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'geolocations': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'jids': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'labels': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'logos': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'mailers': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'nicknames': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'notes': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'organizations': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'photos': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'product_ids': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'revision_dates': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'roles': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'sort_strings': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'sounds': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'telephone_numbers': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'timezones': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'titles': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'uids': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'urls': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>}¶
A mapping of the
plugin_attrib
values of registered plugins to their respective classes.
- plugin_iterables: ClassVar[Set[Type[ElementBase]]] = {<class 'slixmpp.plugins.xep_0054.stanza.Address'>, <class 'slixmpp.plugins.xep_0054.stanza.Agent'>, <class 'slixmpp.plugins.xep_0054.stanza.Birthday'>, <class 'slixmpp.plugins.xep_0054.stanza.Categories'>, <class 'slixmpp.plugins.xep_0054.stanza.Desc'>, <class 'slixmpp.plugins.xep_0054.stanza.Email'>, <class 'slixmpp.plugins.xep_0054.stanza.Geo'>, <class 'slixmpp.plugins.xep_0054.stanza.JabberID'>, <class 'slixmpp.plugins.xep_0054.stanza.Label'>, <class 'slixmpp.plugins.xep_0054.stanza.Logo'>, <class 'slixmpp.plugins.xep_0054.stanza.Mailer'>, <class 'slixmpp.plugins.xep_0054.stanza.Nickname'>, <class 'slixmpp.plugins.xep_0054.stanza.Note'>, <class 'slixmpp.plugins.xep_0054.stanza.Org'>, <class 'slixmpp.plugins.xep_0054.stanza.Photo'>, <class 'slixmpp.plugins.xep_0054.stanza.ProdID'>, <class 'slixmpp.plugins.xep_0054.stanza.Rev'>, <class 'slixmpp.plugins.xep_0054.stanza.Role'>, <class 'slixmpp.plugins.xep_0054.stanza.SortString'>, <class 'slixmpp.plugins.xep_0054.stanza.Sound'>, <class 'slixmpp.plugins.xep_0054.stanza.Telephone'>, <class 'slixmpp.plugins.xep_0054.stanza.TimeZone'>, <class 'slixmpp.plugins.xep_0054.stanza.Title'>, <class 'slixmpp.plugins.xep_0054.stanza.UID'>, <class 'slixmpp.plugins.xep_0054.stanza.URL'>}¶
The set of stanza classes that can be iterated over using the ‘substanzas’ interface. Classes are added to this set when registering a plugin with
iterable=True
:register_stanza_plugin(DiscoInfo, DiscoItem, iterable=True)
Added in version 1.0-Beta5.
- plugin_overrides: ClassVar[Dict[str, str]] = {}¶
A map of interface operations to the overriding functions. For example, after overriding the
set
operation for the interfacebody
,plugin_overrides
would be:{'set_body': <some function>}
- plugin_tag_map: ClassVar[Dict[str, Type[ElementBase]]] = {'{jabber:client}stanza': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, '{vcard-temp}ADR': <class 'slixmpp.plugins.xep_0054.stanza.Address'>, '{vcard-temp}AGENT': <class 'slixmpp.plugins.xep_0054.stanza.Agent'>, '{vcard-temp}BDAY': <class 'slixmpp.plugins.xep_0054.stanza.Birthday'>, '{vcard-temp}CATEGORIES': <class 'slixmpp.plugins.xep_0054.stanza.Categories'>, '{vcard-temp}DESC': <class 'slixmpp.plugins.xep_0054.stanza.Desc'>, '{vcard-temp}EMAIL': <class 'slixmpp.plugins.xep_0054.stanza.Email'>, '{vcard-temp}GEO': <class 'slixmpp.plugins.xep_0054.stanza.Geo'>, '{vcard-temp}JABBERID': <class 'slixmpp.plugins.xep_0054.stanza.JabberID'>, '{vcard-temp}LABEL': <class 'slixmpp.plugins.xep_0054.stanza.Label'>, '{vcard-temp}LOGO': <class 'slixmpp.plugins.xep_0054.stanza.Logo'>, '{vcard-temp}MAILER': <class 'slixmpp.plugins.xep_0054.stanza.Mailer'>, '{vcard-temp}N': <class 'slixmpp.plugins.xep_0054.stanza.Name'>, '{vcard-temp}NICKNAME': <class 'slixmpp.plugins.xep_0054.stanza.Nickname'>, '{vcard-temp}NOTE': <class 'slixmpp.plugins.xep_0054.stanza.Note'>, '{vcard-temp}ORG': <class 'slixmpp.plugins.xep_0054.stanza.Org'>, '{vcard-temp}PHOTO': <class 'slixmpp.plugins.xep_0054.stanza.Photo'>, '{vcard-temp}PRODID': <class 'slixmpp.plugins.xep_0054.stanza.ProdID'>, '{vcard-temp}REV': <class 'slixmpp.plugins.xep_0054.stanza.Rev'>, '{vcard-temp}ROLE': <class 'slixmpp.plugins.xep_0054.stanza.Role'>, '{vcard-temp}SORT-STRING': <class 'slixmpp.plugins.xep_0054.stanza.SortString'>, '{vcard-temp}SOUND': <class 'slixmpp.plugins.xep_0054.stanza.Sound'>, '{vcard-temp}TEL': <class 'slixmpp.plugins.xep_0054.stanza.Telephone'>, '{vcard-temp}TITLE': <class 'slixmpp.plugins.xep_0054.stanza.Title'>, '{vcard-temp}TZ': <class 'slixmpp.plugins.xep_0054.stanza.TimeZone'>, '{vcard-temp}UID': <class 'slixmpp.plugins.xep_0054.stanza.UID'>, '{vcard-temp}URL': <class 'slixmpp.plugins.xep_0054.stanza.URL'>}¶
A mapping of root element tag names (in
'{namespace}elementname'
format) to the plugin classes responsible for them.
- sub_interfaces: ClassVar[Set[str]] = {'FN', 'VERSION'}¶
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.