XEP 0439

1.7 Documentation

«  XEP 0437   ::   Contents   ::   XEP 0444  »

XEP 0439

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.

stanza = <module 'slixmpp.plugins.xep_0439.stanza' from '/home/docs/checkouts/readthedocs.org/user_builds/slixmpp/checkouts/slix-1.7.1/slixmpp/plugins/xep_0439/stanza.py'>

Stanza elements

Slixmpp: The Slick XMPP Library Copyright (C) 2020 Mathieu Pasquet <mathieui@mathieui.net> This file is part of Slixmpp.

See the file LICENSE for copying permissio

class slixmpp.plugins.xep_0439.stanza.Action(xml=None, parent=None)[source]
interfaces = {'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 = '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 = '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 = '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 = {'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 = '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 = '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 = '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 = {'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 = '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 = '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 = '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]

«  XEP 0437   ::   Contents   ::   XEP 0444  »