WebEngineDownloadItem QML Type | Qt WebEngine 5.10

Qt 5.10 | Qt WebEngine | QML Types | WebEngineDownloadItem QML Type

Qt 5.10.1 Reference Documentation

# WebEngineDownloadItem QML Type

Provides information about a download. More...

Import Statement: | import QtWebEngine 1.5
Since: | QtWebEngine 1.1

- List of all members, including inherited members

## Properties

- id : int
- interruptReason : enumeration
- interruptReasonString : string
- isFinished : bool
- isPaused : bool
- mimeType : string
- path : string
- receivedBytes : int
- savePageFormat : enumeration
- state : enumeration
- totalBytes : int
- type : enumeration

## Methods

- void accept()
- void cancel()
- void pause()
- void resume()

## Detailed Description

Stores the state of a download to be used to manage requested downloads.

By default, the download is rejected unless the user explicitly accepts it with accept().

## Property Documentation

id : int

Holds the download item's ID.

[read-only] interruptReason : enumeration

Returns the reason why the download was interrupted:

Constant | Description
--- | ---
`WebEngineDownloadItem.NoReason` | Unknown reason or not interrupted.
`WebEngineDownloadItem.FileFailed` | General file operation failure.
`WebEngineDownloadItem.FileAccessDenied` | The file cannot be written locally, due to access restrictions.
`WebEngineDownloadItem.FileNoSpace` | Insufficient space on the target drive.
`WebEngineDownloadItem.FileNameTooLong` | The directory or file name is too long.
`WebEngineDownloadItem.FileTooLarge` | The file size exceeds the file system limitation.
`WebEngineDownloadItem.FileVirusInfected` | The file is infected with a virus.
`WebEngineDownloadItem.FileTransientError` | Temporary problem (for example the file is in use, out of memory, or too many files are opened at once).
`WebEngineDownloadItem.FileBlocked` | The file was blocked due to local policy.
`WebEngineDownloadItem.FileSecurityCheckFailed` | An attempt to check the safety of the download failed due to unexpected reasons.
`WebEngineDownloadItem.FileTooShort` | An attempt was made to seek past the end of a file when opening a file (as part of resuming a previously interrupted download).
`WebEngineDownloadItem.FileHashMismatch` | The partial file did not match the expected hash.
`WebEngineDownloadItem.NetworkFailed` | General network failure.
`WebEngineDownloadItem.NetworkTimeout` | The network operation has timed out.
`WebEngineDownloadItem.NetworkDisconnected` | The network connection has been terminated.
`WebEngineDownloadItem.NetworkServerDown` | The server has gone down.
`WebEngineDownloadItem.NetworkInvalidRequest` | The network request was invalid (for example, the original or redirected URL is invalid, has an unsupported scheme, or is disallowed by policy).
`WebEngineDownloadItem.ServerFailed` | General server failure.
`WebEngineDownloadItem.ServerBadContent` | The server does not have the requested data.
`WebEngineDownloadItem.ServerUnauthorized` | The server did not authorize access to the resource.
`WebEngineDownloadItem.ServerCertProblem` | A problem with the server certificate occurred.
`WebEngineDownloadItem.ServerForbidden` | Access forbidden by the server.
`WebEngineDownloadItem.ServerUnreachable` | Unexpected server response (might indicate that the responding server may not be the intended server).
`WebEngineDownloadItem.UserCanceled` | The user canceled the download.

This QML property was introduced in QtWebEngine 1.5.

See also interruptReasonString.

interruptReasonString : string

Returns a human-readable description of the reason for interrupting the download.

This QML property was introduced in QtWebEngine 1.5.

See also interruptReason.

[read-only] isFinished : bool

Whether this download is finished (completed, cancelled, or non-resumable interrupted state).

This QML property was introduced in QtWebEngine 1.6.

[read-only] isPaused : bool

Whether this download is paused.

This QML property was introduced in QtWebEngine 1.6.

mimeType : string

Holds the MIME type of the download.

This QML property was introduced in QtWebEngine 1.2.

path : string

Holds the full target path where data is being downloaded to.

The path includes the file name. The default suggested path is the standard download location and file name is deduced not to overwrite already existing files.

The download path can only be set in the `WebEngineProfile.onDownloadRequested` handler before the download is accepted.

See also WebEngineProfile::downloadRequested() and accept().

receivedBytes : int

Holds the amount of data in bytes that has been downloaded so far.

savePageFormat : enumeration

Describes the format that is used to save a web page.

Constant | Description
--- | ---
`WebEngineDownloadItem.UnknownSaveFormat` | This is not a request for downloading a complete web page.
`WebEngineDownloadItem.SingleHtmlSaveFormat` | The page is saved as a single HTML page. Resources such as images are not saved.
`WebEngineDownloadItem.CompleteHtmlSaveFormat` | The page is saved as a complete HTML page, for example a directory containing the single HTML page and the resources.
`WebEngineDownloadItem.MimeHtmlSaveFormat` | The page is saved as a complete web page in the MIME HTML format.

This QML property was introduced in QtWebEngine 1.3.

state : enumeration

Describes the state of the download:

Constant | Description
--- | ---
`WebEngineDownloadItem.DownloadRequested` | Download has been requested, but it has not been accepted yet.
`WebEngineDownloadItem.DownloadInProgress` | Download is in progress.
`WebEngineDownloadItem.DownloadCompleted` | Download completed successfully.
`WebEngineDownloadItem.DownloadCancelled` | Download was cancelled by the user.
`WebEngineDownloadItem.DownloadInterrupted` | Download has been interrupted (by the server or because of lost connectivity).

totalBytes : int

Holds the total amount of data to download in bytes.

`-1` means the total size is unknown.

[read-only] type : enumeration

Describes the requested download's type.

Constant | Description
--- | ---
`WebEngineDownloadItem.Attachment` | The web server's response includes a `Content-Disposition` header with the `attachment` directive. If `Content-Disposition` is present in the reply, the web server is indicating that the client should prompt the user to save the content regardless of the content type. See RFC 2616 section 19.5.1 for details.
`WebEngineDownloadItem.DownloadAttribute` | The user clicked a link with the `download` attribute. See HTML download attribute for details.
`WebEngineDownloadItem.UserRequested` | The user initiated the download, for example by selecting a web action.
`WebEngineDownloadItem.SavePage` | Saving of the current page was requested (for example by the WebEngineView.SavePage web action).

This QML property was introduced in QtWebEngine 1.4.

## Method Documentation

void accept()

Accepts the download request, which will start the download.

void cancel()

Cancels the download.

void pause()

Pauses the download.

This QML method was introduced in QtWebEngine 1.6.

void resume()

Resumes the download if it was paused or interrupted.

This QML method was introduced in QtWebEngine 1.6.