XEP-xxxx: Simple Buttons

Abstract
This specification provides a way to send simple buttons.
Author
Kim Alvefur
Copyright
© 1999 – 2020 XMPP Standards Foundation. SEE LEGAL NOTICES.
Status

ProtoXEP

WARNING: This document has not yet been accepted for consideration or approved in any official manner by the XMPP Standards Foundation, and this document is not yet an XMPP Extension Protocol (XEP). If this document is accepted as a XEP by the XMPP Council, it will be published at <http://xmpp.org/extensions/> and announced on the <standards@xmpp.org> mailing list.
Type
Standards Track
Version
0.0.2 (2018-09-30)
Document Lifecycle
  1. Experimental
  2. Proposed
  3. Draft
  4. Final

1. Introduction

Having actionable buttons in chats is apparently a fashionable thing now. This specification defines a simple protocol for buttons and responses.

2. Requirements

2.1 TODO

3. Glossary

OPTIONAL.

Button
An actionable object that can be invoked.
Click
The act of invoking the actionable object.

4. Use Cases

A chat bot wants to provide fixed choice answers or commands.

5. Elements

5.1 Button element

A button is represented by a <button> element in the urn:xmpp:tmp:buttons.

Example 1.
<button xmlns="urn:xmpp:tmp:buttons" value="button-clicked">
  <label xml:lang="en">Click me</label>
</button>
value
Textual payload to be sent in a message <body> when the button is clicked.
<label>
Text label for the button. Can be repeated per language.

6. Protocol

6.1 Sending a button

A message with buttons is sent by including one or more <button> elements with distinct value attributes. At least one <label> element MUST be included containing a textual description for the button.

Example 2.
<message from="memberbot@example.com">
  <body xml:lang="en">Approve? (yes/no)</body>
  <button xmlns="urn:xmpp:tmp:buttons" value="yes">
    <label xml:lang="en">Yes</label>
    <label xml:lang="sv">Ja</label>
  </button>
  <button xmlns="urn:xmpp:tmp:buttons" value="no">
    <label xml:lang="en">No</label>
    <label xml:lang="sv">Nej</label>
  </button>
</message>

A single message MUST NOT have multiple buttons with the same @value.

6.2 Clicking a button

When the user clicks a button, their client sends a plain text message body containing the @value as <body> text.

Example 3.
<message to="memberbot@example.com">
  <body>yes</body>
</message>

7. Business Rules

OPTIONAL. TODO.

8. Implementation Notes

OPTIONAL. TODO.

9. Accessibility Considerations

Accessibility for whom?

10. Internationalization Considerations

Multiple instances of the <label/> element MAY be included for the purpose of providing alternate versions of the same text in different languages, i.e. with distinct xml:lang attributes.

11. Security Considerations

Do not press the big red button marked "Danger: Do Not Push".

12. IANA Considerations

None.

13. XMPP Registrar Considerations

Register the namespace etc.

14. XML Schema

REQUIRED for protocol specifications.

button
    @value : string
    label+ : string

Appendices

Appendix A: Document Information

Series
XEP
Number
xxxx
Publisher
XMPP Standards Foundation
Status
ProtoXEP
Type
Standards Track
Version
0.0.2
Last Updated
2018-09-30
Approving Body
XMPP Council
Dependencies
XMPP Core
Supersedes
None
Superseded By
None
Short Name
NOT_YET_ASSIGNED

This document in other formats: XML  PDF

Appendix B: Author Information

Kim Alvefur
Email
zash@zash.se
JabberID
zash@zash.se

Copyright

This XMPP Extension Protocol is copyright © 1999 – 2020 by the XMPP Standards Foundation (XSF).

Permissions

Permission is hereby granted, free of charge, to any person obtaining a copy of this specification (the "Specification"), to make use of the Specification without restriction, including without limitation the rights to implement the Specification in a software program, deploy the Specification in a network service, and copy, modify, merge, publish, translate, distribute, sublicense, or sell copies of the Specification, and to permit persons to whom the Specification is furnished to do so, subject to the condition that the foregoing copyright notice and this permission notice shall be included in all copies or substantial portions of the Specification. Unless separate permission is granted, modified works that are redistributed shall not contain misleading information regarding the authors, title, number, or publisher of the Specification, and shall not claim endorsement of the modified works by the authors, any organization or project to which the authors belong, or the XMPP Standards Foundation.

Disclaimer of Warranty

## NOTE WELL: This Specification is provided on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. ##

Limitation of Liability

In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall the XMPP Standards Foundation or any author of this Specification be liable for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising from, out of, or in connection with the Specification or the implementation, deployment, or other use of the Specification (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if the XMPP Standards Foundation or such author has been advised of the possibility of such damages.

IPR Conformance

This XMPP Extension Protocol has been contributed in full conformance with the XSF's Intellectual Property Rights Policy (a copy of which can be found at <https://xmpp.org/about/xsf/ipr-policy> or obtained by writing to XMPP Standards Foundation, P.O. Box 787, Parker, CO 80134 USA).

Visual Presentation

The HTML representation (you are looking at) is maintained by the XSF. It is based on the YAML CSS Framework, which is licensed under the terms of the CC-BY-SA 2.0 license.

Appendix D: Relation to XMPP

The Extensible Messaging and Presence Protocol (XMPP) is defined in the XMPP Core (RFC 6120) and XMPP IM (RFC 6121) specifications contributed by the XMPP Standards Foundation to the Internet Standards Process, which is managed by the Internet Engineering Task Force in accordance with RFC 2026. Any protocol defined in this document has been developed outside the Internet Standards Process and is to be understood as an extension to XMPP rather than as an evolution, development, or modification of XMPP itself.

Appendix E: Discussion Venue

The primary venue for discussion of XMPP Extension Protocols is the <standards@xmpp.org> discussion list.

Discussion on other xmpp.org discussion lists might also be appropriate; see <http://xmpp.org/about/discuss.shtml> for a complete list.

Errata can be sent to <editor@xmpp.org>.

Appendix F: Requirements Conformance

The following requirements keywords as used in this document are to be interpreted as described in RFC 2119: "MUST", "SHALL", "REQUIRED"; "MUST NOT", "SHALL NOT"; "SHOULD", "RECOMMENDED"; "SHOULD NOT", "NOT RECOMMENDED"; "MAY", "OPTIONAL".

Appendix G: Notes

Appendix H: Revision History

Note: Older versions of this specification might be available at http://xmpp.org/extensions/attic/

  1. Version 0.0.2 (2018-09-30)
    Polishing preparing for submission
    ka
  2. Version 0.0.1 (2018-09-02)
    Initial version
    ka

END