GI.WebKit.Objects.Download

Download carries information about a download request, including a NetworkRequest 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.

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: the Download

-> m ()

Cancels the download. Calling this will not free the Download object, so you still need to call objectUnref 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

getCurrentSize

downloadGetCurrentSize

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: the Download

-> m Word64

Returns: the already downloaded size

Current already downloaded size.

Since: 1.1.2

getDestinationUri

downloadGetDestinationUri

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: the Download

-> m Text

Returns: the destination URI or Nothing

Obtains the URI to which the downloaded file will be written. This must have been set by the application before calling downloadStart, and may be Nothing.

Since: 1.1.2

getElapsedTime

downloadGetElapsedTime

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: a Download

-> m Double

Returns: seconds since the download was started, as a gdouble

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

getNetworkRequest

downloadGetNetworkRequest

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: the Download

-> m NetworkRequest

Returns: the NetworkRequest instance

Retrieves the NetworkRequest object that backs the download process.

Since: 1.1.2

getNetworkResponse

downloadGetNetworkResponse

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: the Download

-> m NetworkResponse

Returns: the NetworkResponse instance

Retrieves the NetworkResponse object that backs the download process.

Since: 1.1.16

getProgress

downloadGetProgress

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: a Download

-> m Double

Returns: a gdouble ranging from 0.0 to 1.0.

Determines the current progress of the download.

Since: 1.1.2

getStatus

downloadGetStatus

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: the Download

-> m DownloadStatus

Returns: the current DownloadStatus

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

Since: 1.1.2

getSuggestedFilename

downloadGetSuggestedFilename

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: the Download

-> m Text

Returns: the suggested filename

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

Since: 1.1.2

getTotalSize

downloadGetTotalSize

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: the Download

-> m Word64

Returns: the expected total size of the downloaded file

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

getUri

downloadGetUri

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: the Download

-> m Text

Returns: the URI

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

Since: 1.1.2

new

downloadNew

Arguments

:: (HasCallStack, MonadIO m, IsNetworkRequest a)

=> a

request: a NetworkRequest

-> m Download

Returns: the new Download

Creates a new Download object for the given NetworkRequest object.

Since: 1.1.2

setDestinationUri

downloadSetDestinationUri

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: the Download

-> Text

destinationUri: the destination URI

-> m ()

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

Since: 1.1.2

start

downloadStart

Arguments

:: (HasCallStack, MonadIO m, IsDownload a)

=> a

download: the Download

-> m ()

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

Since: 1.1.2

Properties

currentSize

getDownloadCurrentSize :: (MonadIO m, IsDownload o) => o -> m Word64

destinationUri

constructDownloadDestinationUri :: IsDownload o => Text -> IO (GValueConstruct o)

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

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

networkRequest

constructDownloadNetworkRequest :: (IsDownload o, IsNetworkRequest a) => a -> IO (GValueConstruct o)

getDownloadNetworkRequest :: (MonadIO m, IsDownload o) => o -> m NetworkRequest

networkResponse

constructDownloadNetworkResponse :: (IsDownload o, IsNetworkResponse a) => a -> IO (GValueConstruct o)

getDownloadNetworkResponse :: (MonadIO m, IsDownload o) => o -> m NetworkResponse

progress

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

status

getDownloadStatus :: (MonadIO m, IsDownload o) => o -> m DownloadStatus

suggestedFilename

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

totalSize

getDownloadTotalSize :: (MonadIO m, IsDownload o) => o -> m Word64

Signals

error

type C_DownloadErrorCallback = Ptr () -> Int32 -> Int32 -> CString -> Ptr () -> IO CInt

type DownloadErrorCallback = Int32 -> Int32 -> Text -> IO Bool

afterDownloadError :: (IsDownload a, MonadIO m) => a -> DownloadErrorCallback -> m SignalHandlerId

genClosure_DownloadError :: DownloadErrorCallback -> IO Closure

mk_DownloadErrorCallback :: C_DownloadErrorCallback -> IO (FunPtr C_DownloadErrorCallback)

noDownloadErrorCallback :: Maybe DownloadErrorCallback

onDownloadError :: (IsDownload a, MonadIO m) => a -> DownloadErrorCallback -> m SignalHandlerId

wrap_DownloadErrorCallback :: DownloadErrorCallback -> Ptr () -> Int32 -> Int32 -> CString -> Ptr () -> IO CInt