AboutSupportDeveloper GuideVersion 38.126.82.64

A general file download event without event type.

interface FileDownloadEvent {
    contentDisposition: string;
    downloadedBytes: number;
    eTag: string;
    fileName: 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: string

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

downloadedBytes: number

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

eTag: string

The value of the ETag header.

fileName: string

The name used to save the file locally.

lastModifiedTime: Date

The value of the Last-Modified header.

mimeType: string

The file mime type.

name: string
originalFileName: string

The original name of the file.

startTime: number

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

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

The file download state.

topic: string

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

Remarks

OpenFin.Frame is represented as iframe.

totalBytes: number

The total size in bytes of the file.

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: string

The url from which the file is being downloaded.

uuid: string