Interface CommitChunksRequestOptions

Description

This interface shows the minimum data needed to create a commit chunks request

Export

Interface

CommitChunksRequestOptions

Hierarchy

Properties

action? data failureCb? fallbackProperties? key? progressCb? query? successCb?

Properties

Optional action

action?: string

data

data: {
    blobStorageProviderName: string;
    chunkedFileUploadSessionId: string;
    contentType: string;
    fileTotalSize: number;
    itemId?: string;
    name: string;
    numberOfChunks: number;
    uploadProperties: {
        [key: string]: string;
    };
}

Description

the data needed to construct the request

Memberof

CommitChunksRequestOptions

Type declaration

  • blobStorageProviderName: string

    Description

    the target blob storage provider's name

  • chunkedFileUploadSessionId: string

    Description

    the current chunk upload session Id

  • contentType: string

    Description

    the file's mime type

  • fileTotalSize: number

    Description

    the total size of the file

  • Optional itemId?: string

    Description

    Optional. Used when updating a media item, can be null when used to create a new media file.

  • name: string

    Description

    the file's name

  • numberOfChunks: number

    Description

    the total number of chunks

  • uploadProperties: {
        [key: string]: string;
    }

    Description

    the properties of the uploaded file like the Title, UrlName, etc

    • [key: string]: string

Optional failureCb

failureCb?: Function

Optional fallbackProperties

fallbackProperties?: string[]

Optional key

key?: string | number

Optional progressCb

progressCb?: Function

Optional query

query?: Query

Optional successCb

successCb?: Function

Settings

Member Visibility

Theme

Generated using TypeDoc