docs-matrix-spec/event-schemas/schema/m.room.message#m.emote
Travis Ralston 55e4e90ab1 Document message formats as-is
This is likely to later be replaced by mixins, however this is being documented now so clients aren't left in the dark.

Fixes https://github.com/matrix-org/matrix-doc/issues/917
2018-07-10 12:52:11 -06:00

34 lines
1.1 KiB
Text

---
allOf:
- $ref: core-event-schema/room_event.yaml
description: "This message is similar to ``m.text`` except that the sender is 'performing' the action contained in the ``body`` key, similar to ``/me`` in IRC. This message should be prefixed by the name of the sender. This message could also be represented in a different colour to distinguish it from regular ``m.text`` messages."
properties:
content:
properties:
body:
description: The emote action to perform.
type: string
msgtype:
enum:
- m.emote
type: string
format:
description: |-
The format used in the ``formatted_body``. Currently only
``org.matrix.custom.html`` is supported.
type: string
formatted_body:
description: |-
The formatted version of the ``body``. This is required if ``format``
is specified.
type: string
required:
- msgtype
- body
type: object
type:
enum:
- m.room.message
type: string
title: EmoteMessage
type: object