Interface UploadClientConfig

interface UploadClientConfig {
    contentType?: string;
    creditLine?: string;
    description?: string;
    extract?: AssetMetadataType[];
    filename?: string;
    label?: string;
    preserveFilename?: boolean;
    source?: { id: string; name: string; url?: string };
    tag?: string;
    timeout?: number;
    title?: string;
}

Properties

contentType? creditLine? description? extract? filename? label? preserveFilename? source? tag? timeout? title?

Properties

OptionalcontentType

contentType?: string

Mime type of the file

OptionalcreditLine

creditLine?: string

The credit to person(s) and/or organization(s) required by the supplier of the asset to be used when published

Optionaldescription

description?: string

Optional description for the asset

Optionalextract

extract?: AssetMetadataType[]

Array of metadata parts to extract from asset

Optionalfilename

filename?: string

Filename for this file (optional)

Optionallabel

label?: string

Optional freeform label for the asset. Generally not used.

OptionalpreserveFilename

preserveFilename?: boolean

Whether or not to preserve the original filename (default: true)

Optionalsource

source?: { id: string; name: string; url?: string }

Source data (when the asset is from an external service)

Type declaration

  • id: string

    The (u)id of the asset within the source, i.e. 'i-f323r1E'

  • name: string

    The name of the source, i.e. 'unsplash'

  • Optionalurl?: string

    A url to where to find the asset, or get more info about it in the source

Optionaltag

tag?: string

Optional request tag for the upload

Optionaltimeout

timeout?: number

Milliseconds to wait before timing the request out

Optionaltitle

title?: string

Optional title for the asset

Settings

Member Visibility

On This Page

Properties