| Copyright | Will Thompson, Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria (garetxe@gmail.com) |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.WebKit2.Objects.WebResource
Contents
Description
- newtype WebResource = WebResource (ManagedPtr WebResource)
- class GObject o => IsWebResource o
- toWebResource :: IsWebResource o => o -> IO WebResource
- noWebResource :: Maybe WebResource
- data WebResourceGetDataMethodInfo
- webResourceGetData :: (HasCallStack, MonadIO m, IsWebResource a, IsCancellable b) => a -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- data WebResourceGetDataFinishMethodInfo
- webResourceGetDataFinish :: (HasCallStack, MonadIO m, IsWebResource a, IsAsyncResult b) => a -> b -> m ByteString
- data WebResourceGetResponseMethodInfo
- webResourceGetResponse :: (HasCallStack, MonadIO m, IsWebResource a) => a -> m URIResponse
- data WebResourceGetUriMethodInfo
- webResourceGetUri :: (HasCallStack, MonadIO m, IsWebResource a) => a -> m Text
- data WebResourceResponsePropertyInfo
- getWebResourceResponse :: (MonadIO m, IsWebResource o) => o -> m URIResponse
- webResourceResponse :: AttrLabelProxy "response"
- data WebResourceUriPropertyInfo
- getWebResourceUri :: (MonadIO m, IsWebResource o) => o -> m Text
- webResourceUri :: AttrLabelProxy "uri"
- type C_WebResourceFailedCallback = Ptr () -> Ptr GError -> Ptr () -> IO ()
- type WebResourceFailedCallback = GError -> IO ()
- data WebResourceFailedSignalInfo
- 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 ()
- type C_WebResourceFailedWithTlsErrorsCallback = Ptr () -> Ptr TlsCertificate -> CUInt -> Ptr () -> IO ()
- type WebResourceFailedWithTlsErrorsCallback = TlsCertificate -> [TlsCertificateFlags] -> IO ()
- data WebResourceFailedWithTlsErrorsSignalInfo
- 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 ()
- type C_WebResourceFinishedCallback = Ptr () -> Ptr () -> IO ()
- type WebResourceFinishedCallback = IO ()
- data WebResourceFinishedSignalInfo
- 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 ()
- type C_WebResourceReceivedDataCallback = Ptr () -> Word64 -> Ptr () -> IO ()
- type WebResourceReceivedDataCallback = Word64 -> IO ()
- data WebResourceReceivedDataSignalInfo
- 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 ()
- type C_WebResourceSentRequestCallback = Ptr () -> Ptr URIRequest -> Ptr URIResponse -> Ptr () -> IO ()
- type WebResourceSentRequestCallback = URIRequest -> URIResponse -> IO ()
- data WebResourceSentRequestSignalInfo
- 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 ()
Exported types
newtype WebResource Source #
Constructors
| WebResource (ManagedPtr WebResource) |
Instances
| GObject WebResource Source # | |
| IsObject WebResource Source # | |
| IsWebResource WebResource Source # | |
| ((~) * info (ResolveWebResourceMethod t WebResource), MethodInfo * info WebResource p) => IsLabel t (WebResource -> p) Source # | |
| ((~) * info (ResolveWebResourceMethod t WebResource), MethodInfo * info WebResource p) => IsLabelProxy t (WebResource -> p) Source # | |
| HasAttributeList * WebResource Source # | |
| type AttributeList WebResource Source # | |
| type SignalList WebResource Source # | |
class GObject o => IsWebResource o Source #
Instances
toWebResource :: IsWebResource o => o -> IO WebResource Source #
Methods
getData
data WebResourceGetDataMethodInfo Source #
Instances
| ((~) * signature (Maybe b -> Maybe AsyncReadyCallback -> m ()), MonadIO m, IsWebResource a, IsCancellable b) => MethodInfo * WebResourceGetDataMethodInfo a signature Source # | |
Arguments
| :: (HasCallStack, MonadIO m, IsWebResource a, IsCancellable b) | |
| => a |
|
| -> Maybe b |
|
| -> Maybe AsyncReadyCallback |
|
| -> 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
data WebResourceGetDataFinishMethodInfo Source #
Instances
| ((~) * signature (b -> m ByteString), MonadIO m, IsWebResource a, IsAsyncResult b) => MethodInfo * WebResourceGetDataFinishMethodInfo a signature Source # | |
webResourceGetDataFinish Source #
Arguments
| :: (HasCallStack, MonadIO m, IsWebResource a, IsAsyncResult b) | |
| => a |
|
| -> b |
|
| -> m ByteString | Returns: a
string with the data of |
Finish an asynchronous operation started with webResourceGetData.
getResponse
data WebResourceGetResponseMethodInfo Source #
Instances
| ((~) * signature (m URIResponse), MonadIO m, IsWebResource a) => MethodInfo * WebResourceGetResponseMethodInfo a signature Source # | |
webResourceGetResponse Source #
Arguments
| :: (HasCallStack, MonadIO m, IsWebResource a) | |
| => a |
|
| -> m URIResponse | Returns: the |
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
data WebResourceGetUriMethodInfo Source #
Instances
| ((~) * signature (m Text), MonadIO m, IsWebResource a) => MethodInfo * WebResourceGetUriMethodInfo a signature Source # | |
Arguments
| :: (HasCallStack, MonadIO m, IsWebResource a) | |
| => a |
|
| -> m Text | Returns: the current active URI of |
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
data WebResourceResponsePropertyInfo Source #
Instances
getWebResourceResponse :: (MonadIO m, IsWebResource o) => o -> m URIResponse Source #
webResourceResponse :: AttrLabelProxy "response" Source #
uri
data WebResourceUriPropertyInfo Source #
Instances
getWebResourceUri :: (MonadIO m, IsWebResource o) => o -> m Text Source #
webResourceUri :: AttrLabelProxy "uri" Source #
Signals
failed
type WebResourceFailedCallback = GError -> IO () Source #
afterWebResourceFailed :: (IsWebResource a, MonadIO m) => a -> WebResourceFailedCallback -> m SignalHandlerId Source #
mk_WebResourceFailedCallback :: C_WebResourceFailedCallback -> IO (FunPtr C_WebResourceFailedCallback) Source #
onWebResourceFailed :: (IsWebResource a, MonadIO m) => a -> WebResourceFailedCallback -> m SignalHandlerId Source #
wrap_WebResourceFailedCallback :: WebResourceFailedCallback -> Ptr () -> Ptr GError -> Ptr () -> IO () Source #
failedWithTlsErrors
type C_WebResourceFailedWithTlsErrorsCallback = Ptr () -> Ptr TlsCertificate -> CUInt -> Ptr () -> IO () Source #
type WebResourceFailedWithTlsErrorsCallback = TlsCertificate -> [TlsCertificateFlags] -> IO () Source #
afterWebResourceFailedWithTlsErrors :: (IsWebResource a, MonadIO m) => a -> WebResourceFailedWithTlsErrorsCallback -> m SignalHandlerId Source #
genClosure_WebResourceFailedWithTlsErrors :: WebResourceFailedWithTlsErrorsCallback -> IO Closure Source #
mk_WebResourceFailedWithTlsErrorsCallback :: C_WebResourceFailedWithTlsErrorsCallback -> IO (FunPtr C_WebResourceFailedWithTlsErrorsCallback) Source #
onWebResourceFailedWithTlsErrors :: (IsWebResource a, MonadIO m) => a -> WebResourceFailedWithTlsErrorsCallback -> m SignalHandlerId Source #
wrap_WebResourceFailedWithTlsErrorsCallback :: WebResourceFailedWithTlsErrorsCallback -> Ptr () -> Ptr TlsCertificate -> CUInt -> Ptr () -> IO () Source #
finished
type WebResourceFinishedCallback = IO () Source #
afterWebResourceFinished :: (IsWebResource a, MonadIO m) => a -> WebResourceFinishedCallback -> m SignalHandlerId Source #
mk_WebResourceFinishedCallback :: C_WebResourceFinishedCallback -> IO (FunPtr C_WebResourceFinishedCallback) Source #
onWebResourceFinished :: (IsWebResource a, MonadIO m) => a -> WebResourceFinishedCallback -> m SignalHandlerId Source #
wrap_WebResourceFinishedCallback :: WebResourceFinishedCallback -> Ptr () -> Ptr () -> IO () Source #
receivedData
type WebResourceReceivedDataCallback = Word64 -> IO () Source #
afterWebResourceReceivedData :: (IsWebResource a, MonadIO m) => a -> WebResourceReceivedDataCallback -> m SignalHandlerId Source #
mk_WebResourceReceivedDataCallback :: C_WebResourceReceivedDataCallback -> IO (FunPtr C_WebResourceReceivedDataCallback) Source #
onWebResourceReceivedData :: (IsWebResource a, MonadIO m) => a -> WebResourceReceivedDataCallback -> m SignalHandlerId Source #
wrap_WebResourceReceivedDataCallback :: WebResourceReceivedDataCallback -> Ptr () -> Word64 -> Ptr () -> IO () Source #
sentRequest
type C_WebResourceSentRequestCallback = Ptr () -> Ptr URIRequest -> Ptr URIResponse -> Ptr () -> IO () Source #
type WebResourceSentRequestCallback = URIRequest -> URIResponse -> IO () Source #
afterWebResourceSentRequest :: (IsWebResource a, MonadIO m) => a -> WebResourceSentRequestCallback -> m SignalHandlerId Source #
mk_WebResourceSentRequestCallback :: C_WebResourceSentRequestCallback -> IO (FunPtr C_WebResourceSentRequestCallback) Source #
onWebResourceSentRequest :: (IsWebResource a, MonadIO m) => a -> WebResourceSentRequestCallback -> m SignalHandlerId Source #
wrap_WebResourceSentRequestCallback :: WebResourceSentRequestCallback -> Ptr () -> Ptr URIRequest -> Ptr URIResponse -> Ptr () -> IO () Source #