mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-20 16:38:37 +01:00
6e16a19ac9
Some checks failed
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled
64 lines
2 KiB
YAML
64 lines
2 KiB
YAML
---
|
|
$schema: https://json-schema.org/draft/2020-12/schema
|
|
|
|
allOf:
|
|
- $ref: core-event-schema/room_event.yaml
|
|
description: This message represents a single image and an optional thumbnail.
|
|
properties:
|
|
content:
|
|
properties:
|
|
body:
|
|
description: |-
|
|
If `filename` is not set or the value of both properties are
|
|
identical, this is the filename of the original upload. Otherwise,
|
|
this is a caption for the image.
|
|
type: string
|
|
x-changedInMatrixVersion:
|
|
"1.10": This property can act as a caption for the image.
|
|
format:
|
|
description: |-
|
|
The format used in the `formatted_body`. This is required if `formatted_body`
|
|
is specified. Currently only `org.matrix.custom.html` is supported.
|
|
type: string
|
|
x-addedInMatrixVersion: "1.10"
|
|
formatted_body:
|
|
description: |-
|
|
The formatted version of the `body`, when it acts as a caption. This
|
|
is required if `format` is specified.
|
|
type: string
|
|
x-addedInMatrixVersion: "1.10"
|
|
filename:
|
|
description: The original filename of the uploaded file.
|
|
type: string
|
|
x-addedInMatrixVersion: "1.10"
|
|
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
|