GI.WebKit2.Objects.WebResource

Exported types

newtype WebResource

Constructors

WebResource (ManagedPtr WebResource)

Instances

GObject WebResource

Methods

gobjectType :: WebResource -> IO GType

IsObject WebResource

IsWebResource WebResource

class GObject o => IsWebResource o

Instances

(GObject a, UnknownAncestorError Constraint WebResource a) => IsWebResource a

IsWebResource WebResource

toWebResource :: (MonadIO m, IsWebResource o) => o -> m WebResource

noWebResource :: Maybe WebResource

Methods

getData

webResourceGetData

Arguments

:: (HasCallStack, MonadIO m, IsWebResource a, IsCancellable b)

=> a

resource: a WebResource

-> Maybe b

cancellable: a Cancellable or Nothing to ignore

-> Maybe AsyncReadyCallback

callback: a AsyncReadyCallback to call when the request is satisfied

-> m ()

Asynchronously get the raw data for resource.

When the operation is finished, callback will be called. You can then call webResourceGetDataFinish to get the result of the operation.

getDataFinish

webResourceGetDataFinish

Arguments

:: (HasCallStack, MonadIO m, IsWebResource a, IsAsyncResult b)

=> a

resource: a WebResource

-> b

result: a AsyncResult

-> m ByteString

Returns: a string with the data of resource, or Nothing in case of error. if length is not Nothing, the size of the data will be assigned to it. (Can throw GError)

Finish an asynchronous operation started with webResourceGetData.

getResponse

webResourceGetResponse

Arguments

:: (HasCallStack, MonadIO m, IsWebResource a)

=> a

resource: a WebResource

-> m URIResponse

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

Retrieves the URIResponse of the resource load operation. 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.

getUri

webResourceGetUri

Arguments

:: (HasCallStack, MonadIO m, IsWebResource a)

=> a

resource: a WebResource

-> m Text

Returns: the current active URI of resource

Returns the current active URI of resource. The active URI might change during a load operation:

<orderedlist> <listitem><para> When the resource load starts, the active URI is the requested URI </para></listitem> <listitem><para> When the initial request is sent to the server, WebResource::sent-request signal is emitted without a redirected response, the active URI is the URI of the request sent to the server. </para></listitem> <listitem><para> In case of a server redirection, WebResource::sent-request signal is emitted again with a redirected response, the active URI is the URI the request was redirected to. </para></listitem> <listitem><para> When the response is received from the server, the active URI is the final one and it will not change again. </para></listitem> </orderedlist>

You can monitor the active URI by connecting to the notify::uri signal of resource.

Properties

response

getWebResourceResponse :: (MonadIO m, IsWebResource o) => o -> m URIResponse

uri

getWebResourceUri :: (MonadIO m, IsWebResource o) => o -> m Text

Signals

failed

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

type WebResourceFailedCallback = GError -> IO ()

afterWebResourceFailed :: (IsWebResource a, MonadIO m) => a -> WebResourceFailedCallback -> m SignalHandlerId

genClosure_WebResourceFailed :: WebResourceFailedCallback -> IO Closure

mk_WebResourceFailedCallback :: C_WebResourceFailedCallback -> IO (FunPtr C_WebResourceFailedCallback)

noWebResourceFailedCallback :: Maybe WebResourceFailedCallback

onWebResourceFailed :: (IsWebResource a, MonadIO m) => a -> WebResourceFailedCallback -> m SignalHandlerId

wrap_WebResourceFailedCallback :: WebResourceFailedCallback -> Ptr () -> Ptr GError -> Ptr () -> IO ()

failedWithTlsErrors

type C_WebResourceFailedWithTlsErrorsCallback = Ptr () -> Ptr TlsCertificate -> CUInt -> Ptr () -> IO ()

type WebResourceFailedWithTlsErrorsCallback = TlsCertificate -> [TlsCertificateFlags] -> IO ()

afterWebResourceFailedWithTlsErrors :: (IsWebResource a, MonadIO m) => a -> WebResourceFailedWithTlsErrorsCallback -> m SignalHandlerId

genClosure_WebResourceFailedWithTlsErrors :: WebResourceFailedWithTlsErrorsCallback -> IO Closure

mk_WebResourceFailedWithTlsErrorsCallback :: C_WebResourceFailedWithTlsErrorsCallback -> IO (FunPtr C_WebResourceFailedWithTlsErrorsCallback)

noWebResourceFailedWithTlsErrorsCallback :: Maybe WebResourceFailedWithTlsErrorsCallback

onWebResourceFailedWithTlsErrors :: (IsWebResource a, MonadIO m) => a -> WebResourceFailedWithTlsErrorsCallback -> m SignalHandlerId

wrap_WebResourceFailedWithTlsErrorsCallback :: WebResourceFailedWithTlsErrorsCallback -> Ptr () -> Ptr TlsCertificate -> CUInt -> Ptr () -> IO ()

finished

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

type WebResourceFinishedCallback = IO ()

afterWebResourceFinished :: (IsWebResource a, MonadIO m) => a -> WebResourceFinishedCallback -> m SignalHandlerId

genClosure_WebResourceFinished :: WebResourceFinishedCallback -> IO Closure

mk_WebResourceFinishedCallback :: C_WebResourceFinishedCallback -> IO (FunPtr C_WebResourceFinishedCallback)

noWebResourceFinishedCallback :: Maybe WebResourceFinishedCallback

onWebResourceFinished :: (IsWebResource a, MonadIO m) => a -> WebResourceFinishedCallback -> m SignalHandlerId

wrap_WebResourceFinishedCallback :: WebResourceFinishedCallback -> Ptr () -> Ptr () -> IO ()

receivedData

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

type WebResourceReceivedDataCallback = Word64 -> IO ()

afterWebResourceReceivedData :: (IsWebResource a, MonadIO m) => a -> WebResourceReceivedDataCallback -> m SignalHandlerId

genClosure_WebResourceReceivedData :: WebResourceReceivedDataCallback -> IO Closure

mk_WebResourceReceivedDataCallback :: C_WebResourceReceivedDataCallback -> IO (FunPtr C_WebResourceReceivedDataCallback)

noWebResourceReceivedDataCallback :: Maybe WebResourceReceivedDataCallback

onWebResourceReceivedData :: (IsWebResource a, MonadIO m) => a -> WebResourceReceivedDataCallback -> m SignalHandlerId

wrap_WebResourceReceivedDataCallback :: WebResourceReceivedDataCallback -> Ptr () -> Word64 -> Ptr () -> IO ()

sentRequest

type C_WebResourceSentRequestCallback = Ptr () -> Ptr URIRequest -> Ptr URIResponse -> Ptr () -> IO ()

type WebResourceSentRequestCallback = URIRequest -> URIResponse -> IO ()

afterWebResourceSentRequest :: (IsWebResource a, MonadIO m) => a -> WebResourceSentRequestCallback -> m SignalHandlerId

genClosure_WebResourceSentRequest :: WebResourceSentRequestCallback -> IO Closure

mk_WebResourceSentRequestCallback :: C_WebResourceSentRequestCallback -> IO (FunPtr C_WebResourceSentRequestCallback)

noWebResourceSentRequestCallback :: Maybe WebResourceSentRequestCallback

onWebResourceSentRequest :: (IsWebResource a, MonadIO m) => a -> WebResourceSentRequestCallback -> m SignalHandlerId

wrap_WebResourceSentRequestCallback :: WebResourceSentRequestCallback -> Ptr () -> Ptr URIRequest -> Ptr URIResponse -> Ptr () -> IO ()