matrix-spec/data/event-schemas/schema/m.room.message$m.image.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: |-
          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`. 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