GI.WebKit2.Objects.AuthenticationRequest

No description available in the introspection data.

Exported types

newtype AuthenticationRequest

Memory-managed wrapper type.

Constructors

AuthenticationRequest (ManagedPtr AuthenticationRequest)

Instances

GObject AuthenticationRequest

Defined in GI.WebKit2.Objects.AuthenticationRequest

Methods

gobjectType :: IO GType

HasParentTypes AuthenticationRequest

Defined in GI.WebKit2.Objects.AuthenticationRequest

type ParentTypes AuthenticationRequest

Defined in GI.WebKit2.Objects.AuthenticationRequest

type ParentTypes AuthenticationRequest = Object ': ([] :: [Type])

class (GObject o, IsDescendantOf AuthenticationRequest o) => IsAuthenticationRequest o

Type class for types which can be safely cast to AuthenticationRequest, for instance with toAuthenticationRequest.

Instances

(GObject o, IsDescendantOf AuthenticationRequest o) => IsAuthenticationRequest o

Defined in GI.WebKit2.Objects.AuthenticationRequest

toAuthenticationRequest :: (MonadIO m, IsAuthenticationRequest o) => o -> m AuthenticationRequest

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

noAuthenticationRequest :: Maybe AuthenticationRequest

A convenience alias for Nothing :: Maybe AuthenticationRequest.

Methods

authenticate

authenticationRequestAuthenticate

Arguments

:: (HasCallStack, MonadIO m, IsAuthenticationRequest a)

=> a

request: a AuthenticationRequest

-> Maybe Credential

credential: A Credential, or Nothing

-> m ()

Authenticate the AuthenticationRequest using the Credential supplied. To continue without credentials, pass Nothing as credential.

Since: 2.2

canSaveCredentials

authenticationRequestCanSaveCredentials

Arguments

:: (HasCallStack, MonadIO m, IsAuthenticationRequest a)

=> a

request: a AuthenticationRequest

-> m Bool

Returns: True if WebKit can store credentials or False otherwise.

Determine whether the authentication method associated with this AuthenticationRequest should allow the storage of credentials. This will return False if WebKit doesn't support credential storing or if private browsing is enabled.

Since: 2.2

cancel

authenticationRequestCancel

Arguments

:: (HasCallStack, MonadIO m, IsAuthenticationRequest a)

=> a

request: a AuthenticationRequest

-> m ()

Cancel the authentication challenge. This will also cancel the page loading and result in a WebView::load-failed signal with a NetworkError of type NetworkErrorCancelled being emitted.

Since: 2.2

getHost

authenticationRequestGetHost

Arguments

:: (HasCallStack, MonadIO m, IsAuthenticationRequest a)

=> a

request: a AuthenticationRequest

-> m Text

Returns: The host of request.

Get the host that this authentication challenge is applicable to.

Since: 2.2

getPort

authenticationRequestGetPort

Arguments

:: (HasCallStack, MonadIO m, IsAuthenticationRequest a)

=> a

request: a AuthenticationRequest

-> m Word32

Returns: The port of request.

Get the port that this authentication challenge is applicable to.

Since: 2.2

getProposedCredential

authenticationRequestGetProposedCredential

Arguments

:: (HasCallStack, MonadIO m, IsAuthenticationRequest a)

=> a

request: a AuthenticationRequest

-> m Credential

Returns: A Credential encapsulating credential details or Nothing if there is no stored credential.

Get the Credential of the proposed authentication challenge that was stored from a previous session. The client can use this directly for authentication or construct their own Credential.

Since: 2.2

getRealm

authenticationRequestGetRealm

Arguments

:: (HasCallStack, MonadIO m, IsAuthenticationRequest a)

=> a

request: a AuthenticationRequest

-> m Text

Returns: The realm of request.

Get the realm that this authentication challenge is applicable to.

Since: 2.2

getScheme

authenticationRequestGetScheme

Arguments

:: (HasCallStack, MonadIO m, IsAuthenticationRequest a)

=> a

request: a AuthenticationRequest

-> m AuthenticationScheme

Returns: The AuthenticationScheme of request.

Get the authentication scheme of the authentication challenge.

Since: 2.2

isForProxy

authenticationRequestIsForProxy

Arguments

:: (HasCallStack, MonadIO m, IsAuthenticationRequest a)

=> a

request: a AuthenticationRequest

-> m Bool

Returns: True if authentication is for a proxy or False otherwise.

Determine whether the authentication challenge is associated with a proxy server rather than an "origin" server.

Since: 2.2

isRetry

authenticationRequestIsRetry

Arguments

:: (HasCallStack, MonadIO m, IsAuthenticationRequest a)

=> a

request: a AuthenticationRequest

-> m Bool

Returns: True if authentication attempt is a retry or False otherwise.

Determine whether this this is a first attempt or a retry for this authentication challenge.

Since: 2.2

Signals

cancelled

type AuthenticationRequestCancelledCallback = IO ()

This signal is emitted when the user authentication request is cancelled. It allows the application to dismiss its authentication dialog in case of page load failure for example.

Since: 2.2

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

Type for the callback on the (unwrapped) C side.

afterAuthenticationRequestCancelled :: (IsAuthenticationRequest a, MonadIO m) => a -> AuthenticationRequestCancelledCallback -> m SignalHandlerId

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

after authenticationRequest #cancelled callback

genClosure_AuthenticationRequestCancelled :: MonadIO m => AuthenticationRequestCancelledCallback -> m (GClosure C_AuthenticationRequestCancelledCallback)

Wrap the callback into a GClosure.

mk_AuthenticationRequestCancelledCallback :: C_AuthenticationRequestCancelledCallback -> IO (FunPtr C_AuthenticationRequestCancelledCallback)

Generate a function pointer callable from C code, from a C_AuthenticationRequestCancelledCallback.

noAuthenticationRequestCancelledCallback :: Maybe AuthenticationRequestCancelledCallback

A convenience synonym for Nothing :: Maybe AuthenticationRequestCancelledCallback.

onAuthenticationRequestCancelled :: (IsAuthenticationRequest a, MonadIO m) => a -> AuthenticationRequestCancelledCallback -> m SignalHandlerId

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

on authenticationRequest #cancelled callback

wrap_AuthenticationRequestCancelledCallback :: AuthenticationRequestCancelledCallback -> C_AuthenticationRequestCancelledCallback

Wrap a AuthenticationRequestCancelledCallback into a C_AuthenticationRequestCancelledCallback.