GI.WebKit2.Objects.WebResource

Represents a resource at the end of a URI.

A WebResource encapsulates content for each resource at the end of a particular URI. For example, one WebResource will be created for each separate image and stylesheet when a page is loaded.

You can access the response and the URI for a given WebResource, using webResourceGetUri and webResourceGetResponse, as well as the raw data, using webResourceGetData.

Exported types

newtype WebResource

Memory-managed wrapper type.

Constructors

WebResource (ManagedPtr WebResource)

Instances

Eq WebResource

Defined in GI.WebKit2.Objects.WebResource

Methods

(==) :: WebResource -> WebResource -> Bool

(/=) :: WebResource -> WebResource -> Bool

GObject WebResource

Defined in GI.WebKit2.Objects.WebResource

ManagedPtrNewtype WebResource

Defined in GI.WebKit2.Objects.WebResource

Methods

toManagedPtr :: WebResource -> ManagedPtr WebResource

TypedObject WebResource

Defined in GI.WebKit2.Objects.WebResource

Methods

glibType :: IO GType

HasParentTypes WebResource

Defined in GI.WebKit2.Objects.WebResource

IsGValue (Maybe WebResource)

Convert WebResource to and from GValue. See toGValue and fromGValue.

Defined in GI.WebKit2.Objects.WebResource

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe WebResource -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe WebResource)

type ParentTypes WebResource

Defined in GI.WebKit2.Objects.WebResource

type ParentTypes WebResource = '[Object]

class (GObject o, IsDescendantOf WebResource o) => IsWebResource o

Type class for types which can be safely cast to WebResource, for instance with toWebResource.

Instances

(GObject o, IsDescendantOf WebResource o) => IsWebResource o

Defined in GI.WebKit2.Objects.WebResource

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

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

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getDataFinish, getProperty, getQdata, getResponse, getUri.

Setters

setData, setDataFull, setProperty.

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 (Maybe 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 notifyresponse 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::sentRequest 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::sentRequest 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 notifyuri signal of resource.

Properties

response

The URIResponse associated with this resource.

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

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

get webResource #response

uri

The current active URI of the WebResource. See webResourceGetUri for more details.

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

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

get webResource #uri

Signals

failed

type WebResourceFailedCallback

Arguments

 = GError

error: the GError that was triggered

-> IO ()

This signal is emitted when an error occurs during the resource load operation.

afterWebResourceFailed :: (IsWebResource a, MonadIO m) => a -> ((?self :: a) => WebResourceFailedCallback) -> 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 webResource #failed callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWebResourceFailed :: (IsWebResource a, MonadIO m) => a -> ((?self :: a) => WebResourceFailedCallback) -> 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 webResource #failed callback

failedWithTlsErrors

type WebResourceFailedWithTlsErrorsCallback

Arguments

 = TlsCertificate

certificate: a TlsCertificate

-> [TlsCertificateFlags]

errors: a TlsCertificateFlags with the verification status of certificate

-> IO ()

This signal is emitted when a TLS error occurs during the resource load operation.

Since: 2.8

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

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

after webResource #failedWithTlsErrors callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

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

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

on webResource #failedWithTlsErrors callback

finished

type WebResourceFinishedCallback = IO ()

This signal is emitted when the resource load finishes successfully or due to an error. In case of errors WebResource::failed signal is emitted before this one.

afterWebResourceFinished :: (IsWebResource a, MonadIO m) => a -> ((?self :: a) => WebResourceFinishedCallback) -> 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 webResource #finished callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWebResourceFinished :: (IsWebResource a, MonadIO m) => a -> ((?self :: a) => WebResourceFinishedCallback) -> 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 webResource #finished callback

receivedData

type WebResourceReceivedDataCallback

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 received. It's useful to know the progress of the resource load operation.

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

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

after webResource #receivedData callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

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

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

on webResource #receivedData callback

sentRequest

type WebResourceSentRequestCallback

Arguments

 = URIRequest

request: a URIRequest

-> URIResponse

redirectedResponse: a URIResponse, or Nothing

-> IO ()

This signal is emitted when request has been sent to the server. In case of a server redirection this signal is emitted again with the request argument containing the new request sent to the server due to the redirection and the redirectedResponse parameter containing the response received by the server for the initial request.

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

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

after webResource #sentRequest callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

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

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

on webResource #sentRequest callback