XEP-0439: Quick Response#

class slixmpp.plugins.xep_0439.XEP_0439(xmpp, config=None)[source]#

XEP-0439: Quick Response

ask_for_actions(mto, body, actions, mtype='chat', lang=None, *, mfrom=None)[source]#

Send a message with a set of actions.

Parameters:
  • mto (JID) – The JID of the entity which will receive the message

  • body (str) – The message body of the question

  • actions (Iterable[Tuple[str, str]]) – A set of tuples containing (action, label) for each action

  • mtype (str) – The message type

  • lang (str) – The lang of the message (if not use, the default for this session will be used.

ask_for_response(mto, body, responses, mtype='chat', lang=None, *, mfrom=None)[source]#

Send a message with a set of responses.

Parameters:
  • mto (JID) – The JID of the entity which will receive the message

  • body (str) – The message body of the question

  • responses (Iterable[Tuple[str, str]]) – A set of tuples containing (value, label) for each response

  • mtype (str) – The message type

  • lang (str) – The lang of the message (if not use, the default for this session will be used.

dependencies: ClassVar[Set[str]] = {}#

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-0439: Quick Response'#

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

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_0439.stanza.Action(xml=None, parent=None)[source]#
interfaces: ClassVar[Set[str]] = {'id', 'label'}#

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

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:tmp:quick-response'#

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

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']
class slixmpp.plugins.xep_0439.stanza.ActionSelected(xml=None, parent=None)[source]#
interfaces: ClassVar[Set[str]] = {'id'}#

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

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:tmp:quick-response'#

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

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']
class slixmpp.plugins.xep_0439.stanza.Response(xml=None, parent=None)[source]#
interfaces: ClassVar[Set[str]] = {'label', '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] = 'response'#

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:tmp:quick-response'#

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

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']
slixmpp.plugins.xep_0439.stanza.register_plugins()[source]#