matrix-js-sdk
    Preparing search index...

    Interface FileContent

    Content format of media events with msgtype m.file

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

    interface FileContent {
        body: string;
        file?: EncryptedFile;
        filename?: string;
        format?: "org.matrix.custom.html";
        formatted_body?: string;
        info?: FileInfo;
        msgtype: File;
        "org.matrix.msc3089.leaf"?: EmptyObject;
        url?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    body file? filename? format? formatted_body? info? msgtype org.matrix.msc3089.leaf? url?

    Properties

    body

    body: string

    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.

    file?: EncryptedFile

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

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

    filename?: string

    The original filename of the uploaded file.

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

    The format used in the formatted_body.

    Optionalformatted_body

    formatted_body?: string

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

    info?: FileInfo

    Information about the file referred to in url.

    msgtype: File

    One of: [m.file].

    "org.matrix.msc3089.leaf"?: EmptyObject
    url?: string

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

    Settings

    Member Visibility

    On This Page

    Properties