Download

Object Hierarchy:

Description:

[ CCode ( type_id = "webkit_download_get_type ()" ) ]
public class Download : Object

Object used to communicate with the application when downloading.

Download carries information about a download request and response, including a URIRequest and a URIResponse objects. The application may use this object to control the download process, or to simply figure out what is to be downloaded, and handle the download process itself.

Namespace: WebKit

Package: webkit2gtk-4.0

Content:

Properties:

public bool allow_overwrite { get; set; }
Whether or not the download is allowed to overwrite an existing file on disk.
public string destination { get; }
The local path to where the download will be saved.
public double estimated_progress { get; }
An estimate of the percent completion for the download operation.
public URIResponse response { get; }
The URIResponse associated with this download.

Creation methods:

protected Download ()

Methods:

public void cancel ()
Cancels the download.
public bool get_allow_overwrite ()
Returns the current value of the allow_overwrite property.
public unowned string? get_destination ()
Obtains the destination to which the downloaded file will be written.
public double get_elapsed_time ()
Gets the elapsed time in seconds, including any fractional part.
public double get_estimated_progress ()
Gets the value of the estimated_progress property.
public uint64 get_received_data_length ()
Gets the length of the data already downloaded for this.
public unowned URIRequest get_request ()
Retrieves the URIRequest object that backs the download process.
public unowned URIResponse get_response ()
Retrieves the URIResponse object that backs the download process.
public unowned WebView get_web_view ()
Get the WebView that initiated the download.
public void set_allow_overwrite (bool allowed)
Sets the allow_overwrite property.
public void set_destination (string destination)
Sets the destination to which the downloaded file will be written.

Signals:

public signal void created_destination (string destination)
This signal is emitted after decide_destination and before received_data to notify that destination file has been created successfully at destination.
public virtual signal bool decide_destination (string suggested_filename)
This signal is emitted after response is received to decide a destination for the download using set_destination.
public signal void failed (DownloadError error)
This signal is emitted when an error occurs during the download operation.
public signal void finished ()
This signal is emitted when download finishes successfully or due to an error.
public signal void received_data (uint64 data_length)
This signal is emitted after response is received, every time new data has been written to the destination.

Inherited Members:

All known members inherited from class GLib.Object