XEP-0153: vCard-Based Avatars#

class slixmpp.plugins.xep_0153.XEP_0153(xmpp, config=None)[source]#
set_avatar(jid=None, avatar=None, mtype=None, **iqkwargs)[source]#

Set a VCard avatar.

Parameters

  • jid (Optional[JID]) – The JID to set the avatar for.

  • avatar (Optional[bytes]) – Avatar content.

  • mtype (Optional[str]) – Avatar file type (e.g. image/jpeg).

Return type

Future

Internal API methods#

The internal API is used here to maintain an in-memory JID→avatar hash cache.

set_hash#

  • jid: JID of whom to retrieve the last activity

  • node: unused

  • ifrom: unused

  • args: str, avatar hash

Set the avatar hash for a JID.

reset_hash#

  • jid: JID of whom to retrieve the last activity

  • node: unused

  • ifrom: JID of the entity requesting the reset.

  • args: unused

  • returns information.

Reset the avatar hash for a JID. This downloads the vcard and computes the hash.

get_hash#

  • jid: JID of whom to retrieve the last activity

  • node: unused

  • ifrom: unused

  • args: unused

  • returns: Optional[str], the avatar hash

Get the avatar hash for a JID.

Stanza elements#

class slixmpp.plugins.xep_0153.stanza.VCardTempUpdate(xml=None, parent=None)[source]#
get_photo()[source]#
interfaces: ClassVar[Set[str]] = {'photo'}#

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] = 'x'#

The XML tag name of the element, not including any namespace prefixes. For example, an ElementBase object for <message /> would use name = 'message'.

namespace: str = 'vcard-temp:x:update'#

The XML namespace for the element. Given <foo xmlns="bar" />, then namespace = "bar" should be used. The default namespace is jabber: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, then parent is None.

plugin_attrib: ClassVar[str] = 'vcard_temp_update'#

For ElementBase subclasses which are intended to be used as plugins, the plugin_attrib value defines the plugin name. Plugins may be accessed by using the plugin_attrib value as the interface. An example using plugin_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.

set_photo(value)[source]#
sub_interfaces: ClassVar[Set[str]] = {'photo'}#

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.