:right-sidebar: True Download =================================================================== .. currentmodule:: gi.repository.WebKit .. class:: Download(**properties: ~typing.Any) :no-contents-entry: Superclasses: :class:`~gi.repository.GObject.Object` Object used to communicate with the application when downloading. :obj:`~gi.repository.WebKit.Download` carries information about a download request and response, including a :obj:`~gi.repository.WebKit.URIRequest` and a :obj:`~gi.repository.WebKit.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. Methods ------- .. rst-class:: interim-class .. class:: Download :no-index: .. method:: cancel() -> None Cancels the download. When the ongoing download operation is effectively cancelled the signal :obj:`~gi.repository.WebKit.Download`\::failed is emitted with :const:`~gi.repository.WebKit.DownloadError.CANCELLED_BY_USER` error. .. method:: get_allow_overwrite() -> bool Returns the current value of the :obj:`~gi.repository.WebKit.Download`\:allow-overwrite property. Returns the current value of the :obj:`~gi.repository.WebKit.Download`\:allow-overwrite property, which determines whether the download will overwrite an existing file on disk, or if it will fail if the destination already exists. .. versionadded:: 2.6 .. method:: get_destination() -> str | None Obtains the destination to which the downloaded file will be written. You can connect to :obj:`~gi.repository.WebKit.Download`\::created-destination to make sure this method returns a valid destination. .. method:: get_elapsed_time() -> float Gets the elapsed time in seconds, including any fractional part. If the download finished, had an error or was cancelled this is the time between its start and the event. .. method:: get_estimated_progress() -> float Gets the value of the :obj:`~gi.repository.WebKit.Download`\:estimated-progress property. Gets the value of the :obj:`~gi.repository.WebKit.Download`\:estimated-progress property. You can monitor the estimated progress of the download operation by connecting to the notify::estimated-progress signal of ``download``\. .. method:: get_received_data_length() -> int Gets the length of the data already downloaded for ``download``\. Gets the length of the data already downloaded for ``download`` in bytes. .. method:: get_request() -> ~gi.repository.WebKit.URIRequest Retrieves the :obj:`~gi.repository.WebKit.URIRequest` object that backs the download process. .. method:: get_response() -> ~gi.repository.WebKit.URIResponse Retrieves the :obj:`~gi.repository.WebKit.URIResponse` object that backs the download process. Retrieves the :obj:`~gi.repository.WebKit.URIResponse` object that backs the download process. This method returns :const:`None` if called before the response is received from the server. You can connect to notify::response signal to be notified when the response is received. .. method:: get_web_view() -> ~gi.repository.WebKit.WebView Get the :obj:`~gi.repository.WebKit.WebView` that initiated the download. .. method:: set_allow_overwrite(allowed: bool) -> None Sets the :obj:`~gi.repository.WebKit.Download`\:allow-overwrite property. Sets the :obj:`~gi.repository.WebKit.Download`\:allow-overwrite property, which determines whether the download may overwrite an existing file on disk, or if it will fail if the destination already exists. .. versionadded:: 2.6 :param allowed: the new value for the :obj:`~gi.repository.WebKit.Download`\:allow-overwrite property .. method:: set_destination(destination: str) -> None Sets the destination to which the downloaded file will be written. This method should be called before the download transfer starts or it will not have any effect on the ongoing download operation. To set the destination using the filename suggested by the server connect to :obj:`~gi.repository.WebKit.Download`\::decide-destination signal and call :func:`~gi.repository.WebKit.Download.set_destination`. If you want to set a fixed destination that doesn't depend on the suggested filename you can connect to notify::response signal and call :func:`~gi.repository.WebKit.Download.set_destination`. If :obj:`~gi.repository.WebKit.Download`\::decide-destination signal is not handled and destination is not set when the download transfer starts, the file will be saved with the filename suggested by the server in %G_USER_DIRECTORY_DOWNLOAD directory. :param destination: the destination Properties ---------- .. rst-class:: interim-class .. class:: Download :no-index: .. attribute:: props.allow_overwrite :type: bool The type of the None singleton. .. versionadded:: 2.6 .. attribute:: props.destination :type: str The type of the None singleton. .. attribute:: props.estimated_progress :type: float The type of the None singleton. .. attribute:: props.response :type: ~gi.repository.WebKit.URIResponse The type of the None singleton. Signals ------- .. rst-class:: interim-class .. class:: Download.signals :no-index: .. method:: created_destination(destination: str) -> None The type of the None singleton. :param destination: the destination .. method:: decide_destination(suggested_filename: str) -> bool The type of the None singleton. :param suggested_filename: the filename suggested for the download .. method:: failed(error: ~gi.repository.GLib.GError) -> None The type of the None singleton. :param error: the :obj:`~gi.repository.GLib.Error` that was triggered .. method:: finished() -> None The type of the None singleton. .. method:: received_data(data_length: int) -> None The type of the None singleton. :param data_length: the length of data received in bytes