XEP-0122: Data Forms Validation

class slixmpp.plugins.xep_0122.XEP_0122(xmpp, config=None)

XEP-0122: Data Forms

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-0122: Data Forms Validation'

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

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_0122.stanza.FormValidation(xml=None, parent=None)

Validation values for form fields.

Example:

<field var='evt.date' type='text-single' label='Event Date/Time'>
  <validate xmlns='http://jabber.org/protocol/xdata-validate'
            datatype='xs:dateTime'/>
  <value>2003-10-06T11:22:00-07:00</value>
</field>

Questions:

• Should this look at the datatype value and convert the range values as appropriate?

• Should this stanza provide a pass/fail for a value from the field, or convert field value to datatype?

get_basic()

get_open()

get_range()

get_regex()

interfaces: ClassVar[Set[str]] = {'basic', 'datatype', 'open', 'range', 'regex'}

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

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 = 'http://jabber.org/protocol/xdata-validate'

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

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]]] = {}

A mapping of the plugin_attrib values of registered plugins to their respective classes.

plugin_tag_map: ClassVar[Dict[str, Type[ElementBase]]] = {}

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

remove_all(except_tag=None)

set_basic(value)

set_open(value)

set_range(value, minimum=None, maximum=None)

set_regex(regex)

sub_interfaces: ClassVar[Set[str]] = {'basic', 'open', 'range', 'regex'}

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.