AboutSupportDeveloper GuideVersion 40.130.101.1

Interface FileDownloadEvent

A general file download event without event type.

interface FileDownloadEvent {
    contentDisposition: string;
    downloadedBytes: number;
    eTag: string;
    fileName: string;
    fileUuid: string;
    lastModifiedTime: Date;
    mimeType: string;
    name: string;
    originalFileName: string;
    startTime: number;
    state:
        | "started"
        | "progressing"
        | "cancelled"
        | "interrupted"
        | "completed";
    topic: string;
    totalBytes: number;
    type: string;
    url: string;
    uuid: string;
}

Properties

contentDisposition downloadedBytes eTag fileName fileUuid lastModifiedTime mimeType name originalFileName startTime state topic totalBytes type url uuid

Properties

contentDisposition

contentDisposition: string

The value of the Content-Disposition field from the response header.

downloadedBytes

downloadedBytes: number

The number of bytes of the item that have already been downloaded.

eTag

eTag: string

The value of the ETag header.

fileName

fileName: string

The name used to save the file locally.

fileUuid

fileUuid: string

Unique identifier for the downloaded file.

lastModifiedTime

lastModifiedTime: Date

The value of the Last-Modified header.

mimeType

mimeType: string

The file mime type.

name

name: string

originalFileName

originalFileName: string

The original name of the file.

startTime

startTime: number

The number of seconds since the UNIX epoch when the download was started.

state

state:
    | "started"
    | "progressing"
    | "cancelled"
    | "interrupted"
    | "completed"

The file download state.

topic

topic: string

The "kebab-case" classname of the emitter that raised the event.

Remarks

OpenFin.Frame is represented as iframe.

totalBytes

totalBytes: number

The total size in bytes of the file.

type

type: string

The type of event that was raised. Equal to the typename of the event payload in "kebab case".

Remarks

Guaranteed to be unique within each topic, but can be repeated between topics (e.g. WebContentsEvents.CrashedEvent and ApplicationEvents.CrashedEvent).

url

url: string

The url from which the file is being downloaded.

uuid

uuid: string

Settings

On This Page

Properties