Ubuntu.DownloadManager.SingleDownload

Manage file downloads and tracking the progress. More...

Properties

• allowMobileDownload : bool
• autoStart : bool
• downloadId : string
• downloadInProgress : bool
• downloading : bool
• errorMessage : string
• headers : QVariantMap
• isCompleted : bool
• metadata : Metadata
• progress : int
• throttle : long

Signals

• finished(QString path)

Methods

• void cancel()
• void download(string url)
• void pause()
• void resume()
• void start()

Detailed Description

SingleDownload provides facilities for downloading a single file, track the process, react to error conditions, etc.

Example usage:

import QtQuick 2.0
import Ubuntu.Components 1.2
import Ubuntu.DownloadManager 1.2
Rectangle {
width: units.gu(100)
height: units.gu(20)
TextField {
id: text
placeholderText: "File URL to download..."
height: 50
anchors {
left: parent.left
right: button.left
rightMargin: units.gu(2)
}
}
Button {
id: button
text: "Download"
height: 50
anchors.right: parent.right
onClicked: {
single.download(text.text);
}
}
ProgressBar {
minimumValue: 0
maximumValue: 100
value: single.progress
anchors {
left: parent.left
right: parent.right
bottom: parent.bottom
}
SingleDownload {
id: single
}
}
}

See also DownloadManager.

Property Documentation

This property sets if the download handled by this object will work under mobile data connection.

This property sets if the downloads should start automatically, or let the user decide when to start them calling the "start()" method.

This property provides the unique identifier that represents the download within the download manager.

This property represents if the download is active, no matter if it's paused or anything. If a download is active, the value will be True. It will become False when the download finished or get canceled.

This property represents the current state of the download. False if paused or not downloading anything. True if the file is currently being downloaded.

The error message associated with the current download, if there is any.

This property allows to get and set the headers that will be used to perform the download request. All headers must be strings or at least QVariant should be able to convert them to strings.

The current state of the download. True if the download already finished, False otherwise.

This property allows to get and set the metadata that will be linked to the download request.

This property reports the current progress in percentage of the download, from 0 to 100.

This property can be used to limit the bandwidth used for the download.

Signal Documentation

This signal is emitted when a download has finished. The downloaded file path is provided via the 'path' paremeter. The corresponding handler is onFinished

Method Documentation

Cancels a download.

Creates the download for the given url and reports the different states through the properties.

Pauses the download. An error is returned if the download was already paused.

Resumes and already paused download. An error is returned if the download was already resumed or not paused.

Starts the download, used when autoStart is False.