GI.WebKit2.Objects.URISchemeRequest

Represents a URI scheme request.

If you register a particular URI scheme in a WebContext, using webContextRegisterUriScheme, you have to provide a URISchemeRequestCallback. After that, when a URI request is made with that particular scheme, your callback will be called. There you will be able to access properties such as the scheme, the URI and path, and the WebView that initiated the request, and also finish the request with uRISchemeRequestFinish.

Exported types

newtype URISchemeRequest

Memory-managed wrapper type.

Constructors

URISchemeRequest (ManagedPtr URISchemeRequest)

Instances

Eq URISchemeRequest

Defined in GI.WebKit2.Objects.URISchemeRequest

Methods

(==) :: URISchemeRequest -> URISchemeRequest -> Bool

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

GObject URISchemeRequest

Defined in GI.WebKit2.Objects.URISchemeRequest

ManagedPtrNewtype URISchemeRequest

Defined in GI.WebKit2.Objects.URISchemeRequest

Methods

toManagedPtr :: URISchemeRequest -> ManagedPtr URISchemeRequest

TypedObject URISchemeRequest

Defined in GI.WebKit2.Objects.URISchemeRequest

Methods

glibType :: IO GType

HasParentTypes URISchemeRequest

Defined in GI.WebKit2.Objects.URISchemeRequest

IsGValue (Maybe URISchemeRequest)

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

Defined in GI.WebKit2.Objects.URISchemeRequest

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes URISchemeRequest

Defined in GI.WebKit2.Objects.URISchemeRequest

type ParentTypes URISchemeRequest = '[Object]

class (GObject o, IsDescendantOf URISchemeRequest o) => IsURISchemeRequest o

Type class for types which can be safely cast to URISchemeRequest, for instance with toURISchemeRequest.

Instances

(GObject o, IsDescendantOf URISchemeRequest o) => IsURISchemeRequest o

Defined in GI.WebKit2.Objects.URISchemeRequest

toURISchemeRequest :: (MonadIO m, IsURISchemeRequest o) => o -> m URISchemeRequest

Cast to URISchemeRequest, 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, finish, finishError, finishWithResponse, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getHttpHeaders, getHttpMethod, getPath, getProperty, getQdata, getScheme, getUri, getWebView.

Setters

setData, setDataFull, setProperty.

finish

uRISchemeRequestFinish

Arguments

:: (HasCallStack, MonadIO m, IsURISchemeRequest a, IsInputStream b)

=> a

request: a URISchemeRequest

-> b

stream: a InputStream to read the contents of the request

-> Int64

streamLength: the length of the stream or -1 if not known

-> Maybe Text

contentType: the content type of the stream or Nothing if not known

-> m ()

Finish a URISchemeRequest by setting the contents of the request and its mime type.

finishError

uRISchemeRequestFinishError

Arguments

:: (HasCallStack, MonadIO m, IsURISchemeRequest a)

=> a

request: a URISchemeRequest

-> GError

error: a GError that will be passed to the WebView

-> m ()

Finish a URISchemeRequest with a GError.

Since: 2.2

finishWithResponse

uRISchemeRequestFinishWithResponse

Arguments

:: (HasCallStack, MonadIO m, IsURISchemeRequest a, IsURISchemeResponse b)

=> a

request: a URISchemeRequest

-> b

response: a URISchemeResponse

-> m ()

Finish a URISchemeRequest by returning a URISchemeResponse

Since: 2.36

getHttpHeaders

uRISchemeRequestGetHttpHeaders

Arguments

:: (HasCallStack, MonadIO m, IsURISchemeRequest a)

=> a

request: a URISchemeRequest

-> m MessageHeaders

Returns: the MessageHeaders of the request.

Get the MessageHeaders of the request.

Since: 2.36

getHttpMethod

uRISchemeRequestGetHttpMethod

Arguments

:: (HasCallStack, MonadIO m, IsURISchemeRequest a)

=> a

request: a URISchemeRequest

-> m Text

Returns: the HTTP method of the request

Get the HTTP method of the request.

Since: 2.36

getPath

uRISchemeRequestGetPath

Arguments

:: (HasCallStack, MonadIO m, IsURISchemeRequest a)

=> a

request: a URISchemeRequest

-> m Text

Returns: the URI path of request

Get the URI path of request.

getScheme

uRISchemeRequestGetScheme

Arguments

:: (HasCallStack, MonadIO m, IsURISchemeRequest a)

=> a

request: a URISchemeRequest

-> m Text

Returns: the URI scheme of request

Get the URI scheme of request.

getUri

uRISchemeRequestGetUri

Arguments

:: (HasCallStack, MonadIO m, IsURISchemeRequest a)

=> a

request: a URISchemeRequest

-> m Text

Returns: the full URI of request

Get the URI of request.

getWebView

uRISchemeRequestGetWebView

Arguments

:: (HasCallStack, MonadIO m, IsURISchemeRequest a)

=> a

request: a URISchemeRequest

-> m WebView

Returns: the WebView that initiated request.

Get the WebView that initiated the request.