Interface ImageContent

Content format of media events with msgtype m.image

interface ImageContent {
    body: string;
    file?: EncryptedFile;
    info?: ImageInfo;
    msgtype: Image;
    url?: string;
}

Hierarchy (view full)

Properties

body: string

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’.

Required if the file is encrypted. Information on the encrypted file, as specified in End-to-end encryption.

info?: ImageInfo

Metadata about the image referred to in url.

msgtype: Image

One of: [m.image].

url?: string

Required if the file is unencrypted. The URL (typically mxc:// URI) to the file.

Generated using TypeDoc