Sticker messages (m.sticker)

event-schemas/examples/m.sticker

@@ -0,0 +1,25 @@
+{
+  "age": 242352,
+  "content": {
+    "body": "Landing",
+    "info": {
+      "mimetype": "image/png",
+      "thumbnail_info": {
+        "mimetype": "image/png",
+        "h": 200,
+        "w": 140,
+        "size": 73602
+      },
+      "h": 200,
+      "thumbnail_url": "mxc://matrix.org/sHhqkFCvSkFwtmvtETOtKnLP",
+      "w": 140,
+      "size": 73602
+    },
+    "url": "mxc://matrix.org/sHhqkFCvSkFwtmvtETOtKnLP"
+  },
+  "origin_server_ts": 1431961217939,
+  "event_id": "$WLGTSEFSEF:localhost",
+  "type": "m.sticker",
+  "room_id": "!Cuyf34gef24t:localhost",
+  "sender": "@example:localhost"
+}

event-schemas/schema/m.sticker

@@ -0,0 +1,28 @@
+---
+allOf:
+  - $ref: core-event-schema/room_event.yaml
+description: This message represents a single sticker image.
+properties:
+  content:
+    properties:
+      body:
+        description: "A textual representation or associated description of the sticker image. This could be the alt text of the original image, or a message to accompany and further describe the sticker."
+        type: string
+      info:
+        allOf:
+          - $ref: core-event-schema/msgtype_infos/image_info.yaml
+        description: Metadata about the image referred to in ``url`` including a thumbnail representation.
+      url:
+        description: The URL to the sticker image.
+        type: string
+    required:
+      - body
+      - info
+      - url
+    type: object
+  type:
+    enum:
+      - m.sticker
+    type: string
+title: StickerMessage
+type: object

specification/modules/stickers.rst

@@ -0,0 +1,40 @@
+.. Copyright 2018 New Vector Ltd.
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+..     http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+
+Sticker Messages
+================
+
+.. _module:stickers:
+
+This module allows users to send sticker messages in to rooms or direct messaging sessions.
+
+Sticker messages are specialised image messages that are displayed without controls (e.g. no "download" link, or light-box view on click, as would be displayed for for m.room.message#m.image events).
+
+Sticker messages are intended to provide simple "reaction" events in the message timeline. The matrix client should provide some mechanism to display the sticker "body" e.g. as a tooltip on hover, or in a modal when the sticker image is clicked.
+
+Events
+------
+Sticker events are received as single ``m.sticker`` event in the
+``timeline`` section of a room in a ``/sync``.
+
+{{m_sticker_event}}
+
+Client behaviour
+----------------
+
+Clients supporting this message type should display the image content from the event URL directly in the timeline.
+
+A thumbnail image should be provided in the message info. object. This is largely intended as a fallback for clients that do not fully support the m.sticker event type. Im most cases it is fine to set the thumbnail URL to the same URL as the main event content.
+
+It is recommended that sticker image content should be approximately 400x400 pixels in size (or smaller). The image dimensions specified in the info. object of the message should be half of the original image dimensions in order to display correctly on retina displays.

specification/targets.yaml

@@ -62,6 +62,7 @@ groups:  # reusable blobs of files when prefixed with 'group:'
     - modules/cas_login.rst
     - modules/dm.rst
     - modules/ignore_users.rst
+    - modules/stickers.rst
 
 
 title_styles: ["=", "-", "~", "+", "^", "`", "@", ":"]