IDownloadOptions

interface IDownloadOptions extends IProgressOptions

export interface IDownloadOptions extends IProgressOptions {
    fileName?: string,
    fnRename?: (entry: IListEntry) => string,
    replaceFileExtension?: boolean,
    flattenTargetPath?: boolean,
    renderOptions?: IRenderOptions,
    renderingQuery?: string,
    overwriteExisting?: boolean,
    getICCProfile?: boolean,
    archiveType?: IArchiveType,
    createArchiveOnly?: boolean,
    fnOnArchiveID?: IFnOnDownloadID,
    _downloadFiles?: string[],
    queued?: boolean,
    downloadProgress?: boolean,
    scheduleDate?: number,
    archiveName?: string
}

• fnRename: optional function receiving the IListEntry of the download and returning the desired file name for the download
• replaceFileExtension: when downloading rendered images only. Replace the original file extension (e.g. ".tif") with the file extension of the rendered format (e.g. ".jpg")
• flattenTargetPath: all downloads will be placed in the target directory without creating the subdirectories they used to reside in on the server
• renderOptions: define the way images are rendered before download (see IRenderOptions)
• renderingQuery: same as renderOptions, but in form of a query string like: width=200&format=gif