Back to Seed Clases

WebKit

Classes

Interfaces

DOMEventTarget

Structs

Unions

Enums

GObject.Object
parent-child marker WebKit.Download

Class WebKit.Download

Import line:	WebKit = imports.gi.WebKit;
GIR File:	WebKit-3.0.gir
C documentation:	WebKitDownload
Class :	Download
Extends:	GObject.Object

WebKitDownload carries information about a download request,
including a WebKitNetworkRequest object. The application may use
this object to control the download process, or to simply figure
out what is to be downloaded, and do it itself.

Properties
Properties		Defined By
	current_size : guint64 read only The length of the data already downloaded The length of the data already downloaded	WebKit.Download
	destination_uri : String The URI of the save location for this download. The URI of the save location for this download.	WebKit.Download
	network_request : WebKit.NetworkRequest The WebKitNetworkRequest instance associated with the download. The WebKitNetworkRequest instance associated with the download.	WebKit.Download
	network_response : WebKit.NetworkResponse The WebKitNetworkResponse instance associated with the download. The WebKitNetworkResponse instance associated with the download.	WebKit.Download
	parent_instance : GObject.Object read only	WebKit.Download
	priv : WebKit.DownloadPrivate read only	WebKit.Download
	progress : gdouble read only Determines the current progress of the download. Determines the current progress of the download. Notice that, although the progress changes are reported as soon as possible, the emission of the notify signal for this property is throttled, for the benefit of download managers. If you care about every update, use WebKitDownload:current-size.	WebKit.Download
	status : WebKit.DownloadStatus read only Determines the current status of the download. Determines the current status of the download.	WebKit.Download
	suggested_filename : String read only The file name suggested as default when saving The file name suggested as default when saving	WebKit.Download
	total_size : guint64 read only The total size of the file The total size of the file	WebKit.Download

Methods / Constructors
Method / Constructor		Defined By
	new WebKit.Download (Object *properties) Create a new WebKit.Download Create a new WebKit.Download Parameters: Object properties*
	new WebKit.Download.c_new (NetworkRequest *request) : WebKit.Download Create a new WebKit.Download Create a new WebKit.Download Parameters: WebKit.NetworkRequest request* Required (not null) a WebKitNetworkRequest Returns: WebKit.Download the new WebKitDownload
	cancel () : none Cancels the download. Cancels the download. Calling this will not free the WebKitDownload object, so you still need to call g_object_unref() on it, if you are the owner of a reference. Notice that cancelling the download provokes the emission of the WebKitDownload::error signal, reporting that the download was cancelled. Returns: none	WebKit.Download
	get_current_size () : guint64 Current already downloaded size. Current already downloaded size. Returns: guint64 the already downloaded size	WebKit.Download
	get_destination_uri () : String Obtains the URI to which the downloaded file will be written. Obtains the URI to which the downloaded file will be written. This must have been set by the application before calling webkit_download_start(), and may be NULL. Returns: String the destination URI or NULL	WebKit.Download
	get_elapsed_time () : gdouble Elapsed time for the download in seconds, including any fractional part. Elapsed time for the download in seconds, including any fractional part. If the download is finished, had an error or was cancelled this is the time between its start and the event. Returns: gdouble seconds since the download was started, as a gdouble	WebKit.Download
	get_network_request () : WebKit.NetworkRequest Retrieves the WebKitNetworkRequest object that backs the download process. Retrieves the WebKitNetworkRequest object that backs the download process. Returns: WebKit.NetworkRequest the WebKitNetworkRequest instance	WebKit.Download
	get_network_response () : WebKit.NetworkResponse Retrieves the WebKitNetworkResponse object that backs the download process. Retrieves the WebKitNetworkResponse object that backs the download process. Returns: WebKit.NetworkResponse the WebKitNetworkResponse instance	WebKit.Download
	get_progress () : gdouble Determines the current progress of the download. Determines the current progress of the download. Returns: gdouble a gdouble ranging from 0.0 to 1.0.	WebKit.Download
	get_status () : WebKit.DownloadStatus Obtains the current status of the download, as a WebKitDownloadStatus. Obtains the current status of the download, as a WebKitDownloadStatus. Returns: WebKit.DownloadStatus the current WebKitDownloadStatus	WebKit.Download
	get_suggested_filename () : String Retrieves the filename that was suggested by the server, or the one derived by WebKit from the URI. Retrieves the filename that was suggested by the server, or the one derived by WebKit from the URI. Returns: String the suggested filename	WebKit.Download
	get_total_size () : guint64 Returns the expected total size of the download. Returns the expected total size of the download. This is expected because the server may provide incorrect or missing Content-Length. Notice that this may grow over time, as it will be always the same as current_size in the cases where current size surpasses it. Returns: guint64 the expected total size of the downloaded file	WebKit.Download
	get_uri () : String Convenience method to retrieve the URI from the WebKitNetworkRequest which is being downloaded. Convenience method to retrieve the URI from the WebKitNetworkRequest which is being downloaded. Returns: String the uri	WebKit.Download
	set_destination_uri (String *destination_uri) : none Defines the URI that should be used to save the downloaded file to. Defines the URI that should be used to save the downloaded file to. Parameters: String destination_uri* Required (not null) the destination URI Returns: none	WebKit.Download
	start () : none Initiates the download. Initiates the download. Notice that you must have set the destination-uri property before calling this method. Returns: none	WebKit.Download

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	error (Download *self, gint32 error_code, gint32 error_detail, String reason) : gboolean Emitted when download* is interrupted either by user action or by network errors, error_detail will take any value of WebKitDownloadError. Emitted when download is interrupted either by user action or by network errors, error_detail will take any value of WebKitDownloadError. Parameters: WebKit.Download self gint32 error_code gint32 error_detail String reason Returns: {gboolean}	WebKit.Download