XEP-0221: Data Forms Media Element#

class slixmpp.plugins.xep_0221.XEP_0221(xmpp, config=None)[source]#

XEP-0221: Data Forms Media Element

In certain implementations of Data Forms (XEP-0004), it can be helpful to include media data such as small images. One example is CAPTCHA Forms (XEP-0158). This plugin implements a method for including media data in a data form.

Typical use pattern:

self.register_plugin('xep_0221')
self['xep_0050'].add_command(node="showimage",
                                name="Show my image",
                                handler=self.form_handler)

def form_handler(self,iq,session):
    image_url="https://xmpp.org/images/logos/xmpp-logo.svg"
    form=self['xep_0004'].make_form('result','My Image')
    form.addField(var='myimage', ftype='text-single', label='My Image', value=image_url)
    form.field['myimage']['media'].add_uri(value=image_url, itype="image/svg")
    session['payload']=form
    return session
dependencies: ClassVar[Set[str]] = {'xep_0004'}#

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-0221: Data Forms Media Element'#

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_0221'#

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

Stanza elements#

class slixmpp.plugins.xep_0221.stanza.Media(xml=None, parent=None)[source]#
add_uri(value, itype)[source]#
interfaces: ClassVar[Set[str]] = {'alt', 'height', '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] = 'media'#

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:media-element'#

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

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]]] = {'uri': <class 'slixmpp.plugins.xep_0221.stanza.URI'>, 'uris': <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_0221.stanza.URI'>}#

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 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:media-element}uri': <class 'slixmpp.plugins.xep_0221.stanza.URI'>}#

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

class slixmpp.plugins.xep_0221.stanza.URI(xml=None, parent=None)[source]#
del_value()[source]#
get_value()[source]#
interfaces: ClassVar[Set[str]] = {'type', '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] = 'uri'#

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:media-element'#

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

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

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_value(value)[source]#