XEP-0055: Jabber search

XEP-0055 on xmpp.org

class slixmpp.plugins.xep_0055.XEP_0055(xmpp, config=None)

XEP-0055: Jabber Search

The config options are only useful for a “server-side” search feature, and if the provide_search option is set to True.

API:

• search_get_form: customize the search form content (ie fields)

• search_query: return search results

default_config: ClassVar[dict[str, Any]] = {'form_fields': {'first', 'last'}, 'form_instructions': '', 'form_title': '', 'provide_search': True}

The basic, standard configuration for the plugin, which may be overridden when initializing the plugin. The configuration fields included here may be accessed directly as attributes of the plugin. For example, including the configuration field ‘foo’ would mean accessing plugin.foo returns the current value of plugin.config[‘foo’].

Stanza elements

class slixmpp.plugins.xep_0055.stanza.Search(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] = 'query'

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 = 'jabber:iq:search'

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

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