Editor API Reference - v1.1.24
    Preparing search index...

    Type Alias AssetUploadArguments

    Arguments passed when uploading an asset file.

    type AssetUploadArguments = {
        data?: object;
        file?: File | Blob;
        filename?: string;
        folder?: Asset;
        folderId?: number;
        id?: number;
        name?: string;
        preload?: boolean;
        sourceAssetId?: number;
        tags?: string[];
        type?: string;
    }
    Index

    Properties

    data? file? filename? folder? folderId? id? name? preload? sourceAssetId? tags? type?

    Properties

    data?: object

    The asset data. This depends on the asset type. See Asset for asset data depending on the type.

    file?: File | Blob

    The file being uploaded.

    filename?: string

    The filename of the uploaded file.

    folder?: Asset

    The parent folder asset where the asset should be placed.

    folderId?: number

    The id of the parent folder asset.

    id?: number

    If an asset id is specified then this asset will be updated instead of creating a new asset.

    name?: string

    The name of the asset.

    preload?: boolean

    Whether to preload the asset. Defaults to true.

    sourceAssetId?: number

    The id of the source asset.

    tags?: string[]

    The tags of the asset.

    type?: string

    The type of the asset we are uploading. See Asset for available asset types.

    Settings

    Member Visibility

    On This Page

    Properties