FileContent

Defined in: src/@types/media.ts:183

Content format of media events with msgtype m.file

See

https://spec.matrix.org/v1.11/client-server-api/#mfile

Extends

• BaseContent

Properties

body

body: string

Defined in: src/@types/media.ts:163

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

Inherited from

BaseContent.body

---

file?

optional file?: EncryptedFile

Defined in: src/@types/media.ts:153

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

See

https://spec.matrix.org/v1.11/client-server-api/#sending-encrypted-attachments

Inherited from

BaseContent.file

---

filename?

optional filename?: string

Defined in: src/@types/media.ts:167

The original filename of the uploaded file.

Inherited from

BaseContent.filename

---

format?

optional format?: "org.matrix.custom.html"

Defined in: src/@types/media.ts:171

The format used in the formatted_body.

Inherited from

BaseContent.format

---

formatted_body?

optional formatted_body?: string

Defined in: src/@types/media.ts:175

The formatted version of the body, when it acts as a caption. This is required if format is specified.

Inherited from

BaseContent.formatted_body

---

info?

optional info?: FileInfo

Defined in: src/@types/media.ts:187

Information about the file referred to in url.

---

msgtype

msgtype: File

Defined in: src/@types/media.ts:191

One of: [m.file].

---

org.matrix.msc3089.leaf?

optional org.matrix.msc3089.leaf?: EmptyObject

Defined in: src/models/MSC3089TreeSpace.ts:83

---

url?

optional url?: string

Defined in: src/@types/media.ts:157

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

Inherited from

BaseContent.url