XEP-0292: vCard4 Over XMPP#
Stanza elements#
- class slixmpp.plugins.xep_0292.stanza.Adr(xml=None, parent=None)[source]#
- interfaces: ClassVar[Set[str]] = {'country', 'locality'}#
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'
.
- 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']
- sub_interfaces: ClassVar[Set[str]] = {'country', 'locality'}#
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_0292.stanza.BDay(xml=None, parent=None)[source]#
-
- interfaces: ClassVar[Set[str]] = {'date'}#
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] = 'bday'#
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- 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']
- class slixmpp.plugins.xep_0292.stanza.Date(xml=None, parent=None)[source]#
- name: ClassVar[str] = 'date'#
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- class slixmpp.plugins.xep_0292.stanza.Email(xml=None, parent=None)[source]#
- 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'
.
- 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']
- class slixmpp.plugins.xep_0292.stanza.Fn(xml=None, parent=None)[source]#
- name: ClassVar[str] = 'fn'#
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- plugin_attrib: ClassVar[str] = 'fn'#
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']
- class slixmpp.plugins.xep_0292.stanza.Impp(xml=None, parent=None)[source]#
- name: ClassVar[str] = 'impp'#
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- plugin_attrib: ClassVar[str] = 'impp'#
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']
- class slixmpp.plugins.xep_0292.stanza.N(xml=None, parent=None)[source]#
- interfaces: ClassVar[Set[str]] = {'additional', 'given', 'surname'}#
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'
.
- 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]] = {'additional', 'given', 'surname'}#
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_0292.stanza.Nickname(xml=None, parent=None)[source]#
- 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'
.
- 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']
- class slixmpp.plugins.xep_0292.stanza.Note(xml=None, parent=None)[source]#
- 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'
.
- 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']
- class slixmpp.plugins.xep_0292.stanza.Parameters(xml=None, parent=None)[source]#
- name: ClassVar[str] = 'parameters'#
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- plugin_attrib: ClassVar[str] = 'parameters'#
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]]] = {'type_': <class 'slixmpp.plugins.xep_0292.stanza.Type'>}#
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)
New 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]]] = {'{urn:ietf:params:xml:ns:vcard-4.0}type': <class 'slixmpp.plugins.xep_0292.stanza.Type'>}#
A mapping of root element tag names (in
'{namespace}elementname'
format) to the plugin classes responsible for them.
- class slixmpp.plugins.xep_0292.stanza.Tel(xml=None, parent=None)[source]#
- 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'
.
- 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_attrib_map: ClassVar[Dict[str, Type[ElementBase]]] = {'parameters': <class 'slixmpp.plugins.xep_0292.stanza.Parameters'>}#
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)
New 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]]] = {'{urn:ietf:params:xml:ns:vcard-4.0}parameters': <class 'slixmpp.plugins.xep_0292.stanza.Parameters'>}#
A mapping of root element tag names (in
'{namespace}elementname'
format) to the plugin classes responsible for them.
- class slixmpp.plugins.xep_0292.stanza.Type(xml=None, parent=None)[source]#
- name: ClassVar[str] = 'type'#
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- plugin_attrib: ClassVar[str] = 'type_'#
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']
- class slixmpp.plugins.xep_0292.stanza.Url(xml=None, parent=None)[source]#
- 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'
.
- 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']
- class slixmpp.plugins.xep_0292.stanza.VCard4(xml=None, parent=None)[source]#
-
- interfaces: ClassVar[Set[str]] = {'birthday', 'full_name', 'given', 'surname'}#
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'
.
- plugin_attrib: ClassVar[str] = 'vcard'#
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_0292.stanza.Adr'>, 'bday': <class 'slixmpp.plugins.xep_0292.stanza.BDay'>, 'email': <class 'slixmpp.plugins.xep_0292.stanza.Email'>, 'fn': <class 'slixmpp.plugins.xep_0292.stanza.Fn'>, 'impp': <class 'slixmpp.plugins.xep_0292.stanza.Impp'>, 'n': <class 'slixmpp.plugins.xep_0292.stanza.N'>, 'nickname': <class 'slixmpp.plugins.xep_0292.stanza.Nickname'>, 'note': <class 'slixmpp.plugins.xep_0292.stanza.Note'>, 'tel': <class 'slixmpp.plugins.xep_0292.stanza.Tel'>, 'url': <class 'slixmpp.plugins.xep_0292.stanza.Url'>}#
A mapping of the
plugin_attrib
values of registered plugins to their respective classes.
- plugin_iterables: ClassVar[Set[Type[ElementBase]]] = {<class 'slixmpp.plugins.xep_0292.stanza.Adr'>, <class 'slixmpp.plugins.xep_0292.stanza.BDay'>, <class 'slixmpp.plugins.xep_0292.stanza.Email'>, <class 'slixmpp.plugins.xep_0292.stanza.Fn'>, <class 'slixmpp.plugins.xep_0292.stanza.Impp'>, <class 'slixmpp.plugins.xep_0292.stanza.N'>, <class 'slixmpp.plugins.xep_0292.stanza.Nickname'>, <class 'slixmpp.plugins.xep_0292.stanza.Note'>, <class 'slixmpp.plugins.xep_0292.stanza.Tel'>, <class 'slixmpp.plugins.xep_0292.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)
New 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]]] = {'{urn:ietf:params:xml:ns:vcard-4.0}adr': <class 'slixmpp.plugins.xep_0292.stanza.Adr'>, '{urn:ietf:params:xml:ns:vcard-4.0}bday': <class 'slixmpp.plugins.xep_0292.stanza.BDay'>, '{urn:ietf:params:xml:ns:vcard-4.0}email': <class 'slixmpp.plugins.xep_0292.stanza.Email'>, '{urn:ietf:params:xml:ns:vcard-4.0}fn': <class 'slixmpp.plugins.xep_0292.stanza.Fn'>, '{urn:ietf:params:xml:ns:vcard-4.0}impp': <class 'slixmpp.plugins.xep_0292.stanza.Impp'>, '{urn:ietf:params:xml:ns:vcard-4.0}n': <class 'slixmpp.plugins.xep_0292.stanza.N'>, '{urn:ietf:params:xml:ns:vcard-4.0}nickname': <class 'slixmpp.plugins.xep_0292.stanza.Nickname'>, '{urn:ietf:params:xml:ns:vcard-4.0}note': <class 'slixmpp.plugins.xep_0292.stanza.Note'>, '{urn:ietf:params:xml:ns:vcard-4.0}tel': <class 'slixmpp.plugins.xep_0292.stanza.Tel'>, '{urn:ietf:params:xml:ns:vcard-4.0}url': <class 'slixmpp.plugins.xep_0292.stanza.Url'>}#
A mapping of root element tag names (in
'{namespace}elementname'
format) to the plugin classes responsible for them.