diff --git a/inbox/quick-response.xml b/inbox/quick-response.xml new file mode 100644 index 00000000..75319bca --- /dev/null +++ b/inbox/quick-response.xml @@ -0,0 +1,210 @@ + + + + +%ents; +]> + + + +
+ &xepname; + Quickly respond to automated messages. + &LEGALNOTICE; + xxxx + ProtoXEP + Standards Track + Standards + + XMPP Core + + + + NOT_YET_ASSIGNED + + Kim + Alvefur + zash@zash.se + zash@zash.se + + + Tim + Henkes + me@syndace.dev + + + 0.1.0 + 2020-04-20 + th + +
    +
  • Renamed to better reflect the use-case
    • +
  • Split into two use-cases, one for textual responses and one for quick access to actions
    • +
  • Clarified i18n and general behavioral details
    • +
+ + + + 0.0.2 + 2018-09-30 + ka + Polishing preparing for submission + + + 0.0.1 + 2018-09-02 + ka + Initial version + +
+ + +

Interactions with bots often require sending one of multiple predefined (plaintext) messages. This specification offers a way for XMPP entities to list possible responses to a message, so that entities that receive such a list can offer convenient UI to quickly respond with one of them. Additionally, this specification provides a way for entities to provide generic actions in similar fashion to quick responses.

+ + + + + + + +

A chat bot wants to provide a list of possible responses to a message it sends.

+

A chat bot wants to provide quick access to certain actions for convenience.

+ + + + +

Each possible response is represented by a <response> element in the &ns; namespace.

+ +&ns;]]> + +
+ +
value
+
The value is the internationalized textual payload to put into the <body> of the message stanza that is sent when this response is selected.
+ + +
label
+
The label is an optional internationalized textual label for this response. Clients that offer UI for quick selection of one of the possible responses MAY refer to this response by label instead of value. Topic for discussion: are labels required or should UIs just show the value? Are labels maybe even harmful because they could show something totally different than the value?
+ + +
xml:lang
+
The xml:lang set on this element MUST mirror the xml:lang of the <body> included in the message stanza next to the <response> element. Refer to the Internationalization Considerations for details. This includes not setting an xml:lang at all if not present on the <body>.
+ +
+ + + +

Each available action is represented by an <action> element in the &ns; namespace.

+ +&ns;]]> + +
+
id
A string identifying the action. When selected, this id is sent in an <action-selected> element as part of a message stanza without any <body> elements.
 +
label
Internationalized textual label for this action. The xml:lang attribute and the language of the label should mirror those of the <body> element included in this <message>.
 + +
xml:lang
+
The xml:lang set on this element MUST mirror the xml:lang of the <body> included in the message stanza next to the <action> element. Refer to the Internationalization Considerations for details. This includes not setting an xml:lang at all if not present on the <body>.
+ +
+ + + +

A selected action is represented by an <action-selected> element in the &ns; namespace.

+ +&ns;]]> + +
+
id
The id of the selected action, as defined in the selected <action>.
 +
+ + + + + +

A message with possible responses is sent by including one or more <response> elements with distinct values.

+ + + Execute `rm -rf /`? (yes/no) + + +]]> + +

A single message MUST NOT contain multiple <response> elements with the same values for the value or the label attributes.

+

Clients that receive a message containing possible responses MAY offer UI to quickly and conveniently select one of the responses. Clients MUST NOT limit the allowed responses to only these responses: the sending entity could accept responses that are not explicitly listed, for example free text responses in addition to a few fixed possibilities.

+ + + +

When the user selects a response, their client sends a plaintext message body containing the value as <body> text, also copying the xml:lang of the <response> to the <body>.

+ + + no +]]> + +

The sender of the original message, in this example rootbot@example.com, checks incoming messages for a <body> that only contains the value of a <response> and matches in xml:lang to see if a response was selected. In this example, the <body> matches the value of the English translation for the response "No".

+ + + +

A message with available actions is sent by including one or more <action> elements with distinct ids.

+ + + New merge request opened by ExampleUser: https://git.example.com/example/mrs/3/ + +]]> + +

A single message MUST NOT contain multiple <action> elements with the same values for the id or label attributes.

+

Clients that receive a message containing available actions SHOULD offer UI to select one of the actions.

+ + + +

When the user selects an action, their client sends a message containing an <action-selected> element which identifies the selected action. The message does not contain a <body>.

+ + + +]]> + + + + +

All message bodies SHOULD always list the (internationalized) possible responses too, so that users of clients that don't support &xepname; can still know what the possible responses are.

+

Actions SHOULD only be a quicker way to access a feature that could also be accessed using information in the message body. For example, a bot that notifies about a new merge request includes in its notification message body a link to the web interface where manual merging is possible. An action could offer a more convenient way to merge, without taking the route via the web interface. In summary, users of clients that don't support &xepname; SHOULD still have a way to manually trigger the action.

+

Clients MUST only provide quick responses for the most recently received message that contains text content.

+

Clients SHOULD provide actions not only for the most recently received message that contains actions, but also for previous messages with actions. Sending clients MUST keep in mind that they have to choose/generate ids for each <action> accordingly, if they need to differentiate between messages.

+ + + +

The elements introduced in this specification carry clear semantics that allow clients to implement UI flexibly for their target user group and hardware platform capabilites.

+ + + +

While it is generally possible to include multiple <body> elements with different xml:langs in a single message stanza, this is intentionally not supported by this specification. Message stanzas that also contain elements in the &ns; namespace MUST NOT contain more than one <body> element.

+ + + +

This specification only adds quicker/more convenient access to features that are accessible anyway.

+ + + +

This document requires no interaction with the Internet Assigned Numbers Authority (IANA).

+ + + + +

This specification defines the following XMPP namespaces:

+
    +
  • &ns;
    • +
+ + + + &NSVER; + + + + + TODO + +