XEP-0084: User Avatar

class slixmpp.plugins.xep_0084.XEP_0084(xmpp, config=None)

dependencies: ClassVar[Set[str]] = {'xep_0060', 'xep_0163'}

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-0084: User Avatar'

A longer name for the plugin, describing its purpose. For example, a plugin for XEP-0030 would use ‘Service Discovery’ as its description value.

name: str = 'xep_0084'

A short name for the plugin based on the implemented specification. For example, a plugin for XEP-0030 would use ‘xep_0030’.

publish_avatar(data, **pubsubkwargs)

Publish an avatar.

Parameters:

data (bytes) – The avatar, in bytes representation.

Return type:

Future

publish_avatar_metadata(items=None, pointers=None, **pubsubkwargs)

Publish avatar metadata.

Parameters:

• items (Union[AvatarMetadataItem, List[AvatarMetadataItem], Set[AvatarMetadataItem], None]) – Metadata items to store

• pointers (Optional[Iterable[Pointer]]) – Optional pointers

Return type:

Future

retrieve_avatar(jid, id, **pubsubkwargs)

Retrieve an avatar.

Parameters:

• jid (JID) – JID of the entity to get the avatar from.

• id (str) – Identifier of the item containing the avatar.

Return type:

Future

stop(**pubsubkwargs)

Clear existing avatar metadata information to stop notifications.

Return type:

Future

Stanza elements

class slixmpp.plugins.xep_0084.stanza.Data(xml=None, parent=None)

del_value()

get_value()

interfaces: ClassVar[Set[str]] = {'value'}

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] = 'data'

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 = 'urn:xmpp:avatar:data'

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.

plugin_attrib: ClassVar[str] = 'avatar_data'

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']

set_value(value)

class slixmpp.plugins.xep_0084.stanza.Info(xml=None, parent=None)

get_bytes()

Return type:

int

get_height()

Return type:

int

get_width()

Return type:

int

interfaces: ClassVar[Set[str]] = {'bytes', 'height', 'id', 'type', 'url', 'width'}

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] = 'info'

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 = 'urn:xmpp:avatar:metadata'

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.

plugin_attrib: ClassVar[str] = 'info'

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']

plugin_multi_attrib: ClassVar[str] = 'items'

For ElementBase subclasses that are intended to be an iterable group of items, the plugin_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'])

set_height(value)

set_width(value)

class slixmpp.plugins.xep_0084.stanza.MetaData(xml=None, parent=None)

add_info(id, itype, ibytes, height=None, width=None, url=None)

add_pointer(xml)

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.

name: ClassVar[str] = 'metadata'

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 = 'urn:xmpp:avatar:metadata'

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.

plugin_attrib: ClassVar[str] = 'avatar_metadata'

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']

plugin_attrib_map: ClassVar[Dict[str, Type[ElementBase]]] = {'info': <class 'slixmpp.plugins.xep_0084.stanza.Info'>, 'items': <class 'slixmpp.xmlstream.stanzabase.multifactory.<locals>.Multi'>, 'pointer': <class 'slixmpp.plugins.xep_0084.stanza.Pointer'>, 'pointers': <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_0084.stanza.Info'>, <class 'slixmpp.plugins.xep_0084.stanza.Pointer'>}

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 interface body, 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'>, '{urn:xmpp:avatar:metadata}info': <class 'slixmpp.plugins.xep_0084.stanza.Info'>, '{urn:xmpp:avatar:metadata}pointer': <class 'slixmpp.plugins.xep_0084.stanza.Pointer'>}

A mapping of root element tag names (in '{namespace}elementname' format) to the plugin classes responsible for them.

class slixmpp.plugins.xep_0084.stanza.Pointer(xml=None, parent=None)

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.

name: ClassVar[str] = 'pointer'

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 = 'urn:xmpp:avatar:metadata'

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.

plugin_attrib: ClassVar[str] = 'pointer'

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']

plugin_multi_attrib: ClassVar[str] = 'pointers'

For ElementBase subclasses that are intended to be an iterable group of items, the plugin_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'])