GI.WebKit2.Objects.Download

No description available in the introspection data.

Exported types

newtype Download

Memory-managed wrapper type.

Constructors

Download (ManagedPtr Download)

Instances

GObject Download

Defined in GI.WebKit2.Objects.Download

Methods

gobjectType :: IO GType

HasParentTypes Download

Defined in GI.WebKit2.Objects.Download

type ParentTypes Download

Defined in GI.WebKit2.Objects.Download

type ParentTypes Download = Object ': ([] :: [Type])

class (GObject o, IsDescendantOf Download o) => IsDownload o

Type class for types which can be safely cast to Download, for instance with toDownload.

Instances

(GObject o, IsDescendantOf Download o) => IsDownload o

Defined in GI.WebKit2.Objects.Download

toDownload :: (MonadIO m, IsDownload o) => o -> m Download

Cast to Download, for types for which this is known to be safe. For general casts, use castTo.

noDownload :: Maybe Download

A convenience alias for Nothing :: Maybe Download.

Methods

cancel

downloadCancel

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: a Download

-> m ()

Cancels the download. When the ongoing download operation is effectively cancelled the signal Download::failed is emitted with DownloadErrorCancelledByUser error.

getAllowOverwrite

downloadGetAllowOverwrite

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: a Download

-> m Bool

Returns: the current value of the Download:allow-overwrite property

Returns the current value of the 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.

Since: 2.6

getDestination

downloadGetDestination

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: a Download

-> m (Maybe Text)

Returns: the destination URI or Nothing

Obtains the URI to which the downloaded file will be written. You can connect to Download::created-destination to make sure this method returns a valid destination.

getElapsedTime

downloadGetElapsedTime

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: a Download

-> m Double

Returns: seconds since the download was started

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.

getEstimatedProgress

downloadGetEstimatedProgress

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: a Download

-> m Double

Returns: an estimate of the of the percent complete for a download as a range from 0.0 to 1.0.

Gets the value of the Download:estimated-progress property. You can monitor the estimated progress of the download operation by connecting to the notify::estimated-progress signal of download.

getReceivedDataLength

downloadGetReceivedDataLength

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: a Download

-> m Word64

Returns: the amount of bytes already downloaded.

Gets the length of the data already downloaded for download in bytes.

getRequest

downloadGetRequest

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: a Download

-> m URIRequest

Returns: the URIRequest of download

Retrieves the URIRequest object that backs the download process.

getResponse

downloadGetResponse

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: a Download

-> m (Maybe URIResponse)

Returns: the URIResponse, or Nothing if the response hasn't been received yet.

Retrieves the URIResponse object that backs the download process. This method returns Nothing 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.

getWebView

downloadGetWebView

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: a Download

-> m (Maybe WebView)

Returns: the WebView that initiated download, or Nothing if download was not initiated by a WebView.

Get the WebView that initiated the download.

setAllowOverwrite

downloadSetAllowOverwrite

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: a Download

-> Bool

allowed: the new value for the Download:allow-overwrite property

-> m ()

Sets the 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.

Since: 2.6

setDestination

downloadSetDestination

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: a Download

-> Text

uri: the destination URI

-> m ()

Sets the URI 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 Download::decide-destination signal and call downloadSetDestination. If you want to set a fixed destination URI that doesn't depend on the suggested filename you can connect to notify::response signal and call downloadSetDestination. If Download::decide-destination signal is not handled and destination URI is not set when the download transfer starts, the file will be saved with the filename suggested by the server in UserDirectoryDirectoryDownload directory.

Properties

allowOverwrite

Whether or not the download is allowed to overwrite an existing file on disk. If this property is False and the destination already exists, the download will fail.

Since: 2.6

constructDownloadAllowOverwrite :: IsDownload o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “allow-overwrite” property. This is rarely needed directly, but it is used by new.

getDownloadAllowOverwrite :: (MonadIO m, IsDownload o) => o -> m Bool

Get the value of the “allow-overwrite” property. When overloading is enabled, this is equivalent to

get download #allowOverwrite

setDownloadAllowOverwrite :: (MonadIO m, IsDownload o) => o -> Bool -> m ()

Set the value of the “allow-overwrite” property. When overloading is enabled, this is equivalent to

set download [ #allowOverwrite := value ]

destination

The local URI to where the download will be saved.

getDownloadDestination :: (MonadIO m, IsDownload o) => o -> m (Maybe Text)

Get the value of the “destination” property. When overloading is enabled, this is equivalent to

get download #destination

estimatedProgress

An estimate of the percent completion for the download operation. This value will range from 0.0 to 1.0. The value is an estimate based on the total number of bytes expected to be received for a download. If you need a more accurate progress information you can connect to Download::received-data signal to track the progress.

getDownloadEstimatedProgress :: (MonadIO m, IsDownload o) => o -> m Double

Get the value of the “estimated-progress” property. When overloading is enabled, this is equivalent to

get download #estimatedProgress

response

The URIResponse associated with this download.

getDownloadResponse :: (MonadIO m, IsDownload o) => o -> m (Maybe URIResponse)

Get the value of the “response” property. When overloading is enabled, this is equivalent to

get download #response

Signals

createdDestination

type C_DownloadCreatedDestinationCallback = Ptr () -> CString -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DownloadCreatedDestinationCallback

Arguments

 = Text

destination: the destination URI

-> IO ()

This signal is emitted after Download::decide-destination and before Download::received-data to notify that destination file has been created successfully at destination.

afterDownloadCreatedDestination :: (IsDownload a, MonadIO m) => a -> DownloadCreatedDestinationCallback -> m SignalHandlerId

Connect a signal handler for the “created-destination” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after download #createdDestination callback

genClosure_DownloadCreatedDestination :: MonadIO m => DownloadCreatedDestinationCallback -> m (GClosure C_DownloadCreatedDestinationCallback)

Wrap the callback into a GClosure.

mk_DownloadCreatedDestinationCallback :: C_DownloadCreatedDestinationCallback -> IO (FunPtr C_DownloadCreatedDestinationCallback)

Generate a function pointer callable from C code, from a C_DownloadCreatedDestinationCallback.

noDownloadCreatedDestinationCallback :: Maybe DownloadCreatedDestinationCallback

A convenience synonym for Nothing :: Maybe DownloadCreatedDestinationCallback.

onDownloadCreatedDestination :: (IsDownload a, MonadIO m) => a -> DownloadCreatedDestinationCallback -> m SignalHandlerId

Connect a signal handler for the “created-destination” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on download #createdDestination callback

wrap_DownloadCreatedDestinationCallback :: DownloadCreatedDestinationCallback -> C_DownloadCreatedDestinationCallback

Wrap a DownloadCreatedDestinationCallback into a C_DownloadCreatedDestinationCallback.

decideDestination

type C_DownloadDecideDestinationCallback = Ptr () -> CString -> Ptr () -> IO CInt

Type for the callback on the (unwrapped) C side.

type DownloadDecideDestinationCallback

Arguments

 = Text

suggestedFilename: the filename suggested for the download

-> IO Bool

Returns: True to stop other handlers from being invoked for the event. False to propagate the event further.

This signal is emitted after response is received to decide a destination URI for the download. If this signal is not handled the file will be downloaded to UserDirectoryDirectoryDownload directory using suggestedFilename.

afterDownloadDecideDestination :: (IsDownload a, MonadIO m) => a -> DownloadDecideDestinationCallback -> m SignalHandlerId

Connect a signal handler for the “decide-destination” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after download #decideDestination callback

genClosure_DownloadDecideDestination :: MonadIO m => DownloadDecideDestinationCallback -> m (GClosure C_DownloadDecideDestinationCallback)

Wrap the callback into a GClosure.

mk_DownloadDecideDestinationCallback :: C_DownloadDecideDestinationCallback -> IO (FunPtr C_DownloadDecideDestinationCallback)

Generate a function pointer callable from C code, from a C_DownloadDecideDestinationCallback.

noDownloadDecideDestinationCallback :: Maybe DownloadDecideDestinationCallback

A convenience synonym for Nothing :: Maybe DownloadDecideDestinationCallback.

onDownloadDecideDestination :: (IsDownload a, MonadIO m) => a -> DownloadDecideDestinationCallback -> m SignalHandlerId

Connect a signal handler for the “decide-destination” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on download #decideDestination callback

wrap_DownloadDecideDestinationCallback :: DownloadDecideDestinationCallback -> C_DownloadDecideDestinationCallback

Wrap a DownloadDecideDestinationCallback into a C_DownloadDecideDestinationCallback.

failed

type C_DownloadFailedCallback = Ptr () -> Ptr GError -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DownloadFailedCallback

Arguments

 = GError

error: the GError that was triggered

-> IO ()

This signal is emitted when an error occurs during the download operation. The given error, of the domain WEBKIT_DOWNLOAD_ERROR, contains further details of the failure. If the download is cancelled with downloadCancel, this signal is emitted with error DownloadErrorCancelledByUser. The download operation finishes after an error and Download::finished signal is emitted after this one.

afterDownloadFailed :: (IsDownload a, MonadIO m) => a -> DownloadFailedCallback -> m SignalHandlerId

Connect a signal handler for the “failed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after download #failed callback

genClosure_DownloadFailed :: MonadIO m => DownloadFailedCallback -> m (GClosure C_DownloadFailedCallback)

Wrap the callback into a GClosure.

mk_DownloadFailedCallback :: C_DownloadFailedCallback -> IO (FunPtr C_DownloadFailedCallback)

Generate a function pointer callable from C code, from a C_DownloadFailedCallback.

noDownloadFailedCallback :: Maybe DownloadFailedCallback

A convenience synonym for Nothing :: Maybe DownloadFailedCallback.

onDownloadFailed :: (IsDownload a, MonadIO m) => a -> DownloadFailedCallback -> m SignalHandlerId

Connect a signal handler for the “failed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on download #failed callback

wrap_DownloadFailedCallback :: DownloadFailedCallback -> C_DownloadFailedCallback

Wrap a DownloadFailedCallback into a C_DownloadFailedCallback.

finished

type C_DownloadFinishedCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DownloadFinishedCallback = IO ()

This signal is emitted when download finishes successfully or due to an error. In case of errors Download::failed signal is emitted before this one.

afterDownloadFinished :: (IsDownload a, MonadIO m) => a -> DownloadFinishedCallback -> m SignalHandlerId

Connect a signal handler for the “finished” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after download #finished callback

genClosure_DownloadFinished :: MonadIO m => DownloadFinishedCallback -> m (GClosure C_DownloadFinishedCallback)

Wrap the callback into a GClosure.

mk_DownloadFinishedCallback :: C_DownloadFinishedCallback -> IO (FunPtr C_DownloadFinishedCallback)

Generate a function pointer callable from C code, from a C_DownloadFinishedCallback.

noDownloadFinishedCallback :: Maybe DownloadFinishedCallback

A convenience synonym for Nothing :: Maybe DownloadFinishedCallback.

onDownloadFinished :: (IsDownload a, MonadIO m) => a -> DownloadFinishedCallback -> m SignalHandlerId

Connect a signal handler for the “finished” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on download #finished callback

wrap_DownloadFinishedCallback :: DownloadFinishedCallback -> C_DownloadFinishedCallback

Wrap a DownloadFinishedCallback into a C_DownloadFinishedCallback.

receivedData

type C_DownloadReceivedDataCallback = Ptr () -> Word64 -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type DownloadReceivedDataCallback

Arguments

 = Word64

dataLength: the length of data received in bytes

-> IO ()

This signal is emitted after response is received, every time new data has been written to the destination. It's useful to know the progress of the download operation.

afterDownloadReceivedData :: (IsDownload a, MonadIO m) => a -> DownloadReceivedDataCallback -> m SignalHandlerId

Connect a signal handler for the “received-data” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after download #receivedData callback

genClosure_DownloadReceivedData :: MonadIO m => DownloadReceivedDataCallback -> m (GClosure C_DownloadReceivedDataCallback)

Wrap the callback into a GClosure.

mk_DownloadReceivedDataCallback :: C_DownloadReceivedDataCallback -> IO (FunPtr C_DownloadReceivedDataCallback)

Generate a function pointer callable from C code, from a C_DownloadReceivedDataCallback.

noDownloadReceivedDataCallback :: Maybe DownloadReceivedDataCallback

A convenience synonym for Nothing :: Maybe DownloadReceivedDataCallback.

onDownloadReceivedData :: (IsDownload a, MonadIO m) => a -> DownloadReceivedDataCallback -> m SignalHandlerId

Connect a signal handler for the “received-data” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on download #receivedData callback

wrap_DownloadReceivedDataCallback :: DownloadReceivedDataCallback -> C_DownloadReceivedDataCallback

Wrap a DownloadReceivedDataCallback into a C_DownloadReceivedDataCallback.