matrix-spec/data/event-schemas/schema/m.room.message$m.image.yaml
Richard van der Hoff 61fb66d5d2 "MXC URI" -> "mxc:// URI"
We're a bit inconsistent with this currently, and IMHO "`mxc://` URI" is more
explicit.
2023-04-25 15:59:40 +01:00

41 lines
1.3 KiB
YAML

---
allOf:
- $ref: core-event-schema/room_event.yaml
description: This message represents a single image and an optional thumbnail.
properties:
content:
properties:
body:
description: "A textual representation of the image. This could be the alt text of the image, the filename of the image, or some kind of content description for accessibility e.g. 'image attachment'."
type: string
info:
allOf:
- $ref: core-event-schema/msgtype_infos/image_info.yaml
description: Metadata about the image referred to in `url`.
msgtype:
enum:
- m.image
type: string
url:
description: |-
Required if the file is unencrypted. The URL (typically [`mxc://` URI](/client-server-api/#matrix-content-mxc-uris))
to the image.
type: string
file:
description: |-
Required if the file is encrypted. Information on the encrypted
file, as specified in
[End-to-end encryption](/client-server-api/#sending-encrypted-attachments).
title: EncryptedFile
type: object
required:
- msgtype
- body
type: object
type:
enum:
- m.room.message
type: string
title: ImageMessage
type: object