webkit_download_cancel ()

void
webkit_download_cancel (WebKitDownload *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.

Since: 1.1.2

webkit_download_get_current_size ()

guint64
webkit_download_get_current_size (WebKitDownload *download);

Current already downloaded size.

Since: 1.1.2

webkit_download_get_destination_uri ()

const gchar *
webkit_download_get_destination_uri (WebKitDownload *download);

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.

Since: 1.1.2

webkit_download_get_elapsed_time ()

gdouble
webkit_download_get_elapsed_time (WebKitDownload *download);

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.

Since: 1.1.2

webkit_download_get_network_request ()

WebKitNetworkRequest *
webkit_download_get_network_request (WebKitDownload *download);

Retrieves the WebKitNetworkRequest object that backs the download process.

Since: 1.1.2

webkit_download_get_network_response ()

WebKitNetworkResponse *
webkit_download_get_network_response (WebKitDownload *download);

Retrieves the WebKitNetworkResponse object that backs the download process.

Since: 1.1.16

webkit_download_get_progress ()

gdouble
webkit_download_get_progress (WebKitDownload *download);

Determines the current progress of the download.

Since: 1.1.2

webkit_download_get_status ()

WebKitDownloadStatus
webkit_download_get_status (WebKitDownload *download);

Obtains the current status of the download, as a WebKitDownloadStatus.

Since: 1.1.2

webkit_download_get_suggested_filename ()

const gchar *
webkit_download_get_suggested_filename
                               (WebKitDownload *download);

Retrieves the filename that was suggested by the server, or the one derived by WebKit from the URI.

Since: 1.1.2

webkit_download_get_total_size ()

guint64
webkit_download_get_total_size (WebKitDownload *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.

Since: 1.1.2

webkit_download_get_uri ()

const gchar *
webkit_download_get_uri (WebKitDownload *download);

Convenience method to retrieve the URI from the WebKitNetworkRequest which is being downloaded.

Since: 1.1.2

webkit_download_new ()

WebKitDownload *
webkit_download_new (WebKitNetworkRequest *request);

Creates a new WebKitDownload object for the given WebKitNetworkRequest object.

Since: 1.1.2

webkit_download_set_destination_uri ()

void
webkit_download_set_destination_uri (WebKitDownload *download,
                                     const gchar *destination_uri);

Defines the URI that should be used to save the downloaded file to.

Since: 1.1.2

webkit_download_start ()

void
webkit_download_start (WebKitDownload *download);

Initiates the download. Notice that you must have set the destination-uri property before calling this method.

Since: 1.1.2

enum WebKitDownloadError

Enum values used to denote the various download errors.

enum WebKitDownloadStatus

Enum values used to denote the various states of a download.

WebKitDownload

typedef struct _WebKitDownload WebKitDownload;

The “current-size” property

  “current-size”             guint64

The length of the data already downloaded

Flags: Read

Default value: 0

Since: 1.1.2

The “destination-uri” property

  “destination-uri”          gchar *

The URI of the save location for this download.

Flags: Read / Write

Default value: ""

Since: 1.1.2

The “network-request” property

  “network-request”          WebKitNetworkRequest *

The WebKitNetworkRequest instance associated with the download.

Flags: Read / Write / Construct Only

Since: 1.1.2

The “network-response” property

  “network-response”         WebKitNetworkResponse *

The WebKitNetworkResponse instance associated with the download.

Flags: Read / Write / Construct Only

Since: 1.1.16

The “progress” property

  “progress”                 gdouble

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.

Flags: Read

Allowed values: [0,1]

Default value: 1

Since: 1.1.2

The “status” property

  “status”                   WebKitDownloadStatus

Determines the current status of the download.

Flags: Read

Default value: WEBKIT_DOWNLOAD_STATUS_CREATED

Since: 1.1.2

The “suggested-filename” property

  “suggested-filename”       gchar *

The file name suggested as default when saving

Flags: Read

Default value: ""

Since: 1.1.2

The “total-size” property

  “total-size”               guint64

The total size of the file

Flags: Read

Default value: 0

Since: 1.1.2

The “error” signal

gboolean
user_function (WebKitDownload *download,
               gint            error_code,
               gint            error_detail,
               gchar          *reason,
               gpointer        user_data)

Emitted when download is interrupted either by user action or by network errors, error_detail will take any value of WebKitDownloadError.

Flags: Run Last

Since: 1.1.2