GI.WebKit2.Objects.Download

Exported types

newtype Download

Constructors

Download (ManagedPtr Download)

Instances

GObject Download

Methods

gobjectType :: Download -> IO GType

IsObject Download

IsDownload Download

class GObject o => IsDownload o

Instances

(GObject a, UnknownAncestorError Constraint Download a) => IsDownload a

IsDownload Download

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

noDownload :: 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 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 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 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 tranfer starts, the file will be saved with the filename suggested by the server in UserDirectoryDirectoryDownload directory.

Properties

allowOverwrite

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

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

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

destination

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

estimatedProgress

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

response

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

Signals

createdDestination

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

type DownloadCreatedDestinationCallback = Text -> IO ()

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

genClosure_DownloadCreatedDestination :: DownloadCreatedDestinationCallback -> IO Closure

mk_DownloadCreatedDestinationCallback :: C_DownloadCreatedDestinationCallback -> IO (FunPtr C_DownloadCreatedDestinationCallback)

noDownloadCreatedDestinationCallback :: Maybe DownloadCreatedDestinationCallback

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

wrap_DownloadCreatedDestinationCallback :: DownloadCreatedDestinationCallback -> Ptr () -> CString -> Ptr () -> IO ()

decideDestination

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

type DownloadDecideDestinationCallback = Text -> IO Bool

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

genClosure_DownloadDecideDestination :: DownloadDecideDestinationCallback -> IO Closure

mk_DownloadDecideDestinationCallback :: C_DownloadDecideDestinationCallback -> IO (FunPtr C_DownloadDecideDestinationCallback)

noDownloadDecideDestinationCallback :: Maybe DownloadDecideDestinationCallback

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

wrap_DownloadDecideDestinationCallback :: DownloadDecideDestinationCallback -> Ptr () -> CString -> Ptr () -> IO CInt

failed

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

type DownloadFailedCallback = GError -> IO ()

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

genClosure_DownloadFailed :: DownloadFailedCallback -> IO Closure

mk_DownloadFailedCallback :: C_DownloadFailedCallback -> IO (FunPtr C_DownloadFailedCallback)

noDownloadFailedCallback :: Maybe DownloadFailedCallback

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

wrap_DownloadFailedCallback :: DownloadFailedCallback -> Ptr () -> Ptr GError -> Ptr () -> IO ()

finished

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

type DownloadFinishedCallback = IO ()

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

genClosure_DownloadFinished :: DownloadFinishedCallback -> IO Closure

mk_DownloadFinishedCallback :: C_DownloadFinishedCallback -> IO (FunPtr C_DownloadFinishedCallback)

noDownloadFinishedCallback :: Maybe DownloadFinishedCallback

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

wrap_DownloadFinishedCallback :: DownloadFinishedCallback -> Ptr () -> Ptr () -> IO ()

receivedData

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

type DownloadReceivedDataCallback = Word64 -> IO ()

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

genClosure_DownloadReceivedData :: DownloadReceivedDataCallback -> IO Closure

mk_DownloadReceivedDataCallback :: C_DownloadReceivedDataCallback -> IO (FunPtr C_DownloadReceivedDataCallback)

noDownloadReceivedDataCallback :: Maybe DownloadReceivedDataCallback

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

wrap_DownloadReceivedDataCallback :: DownloadReceivedDataCallback -> Ptr () -> Word64 -> Ptr () -> IO ()