gi-webkit2-4.0.11: WebKit2 bindings

CopyrightWill Thompson, Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.WebKit2.Objects.AuthenticationRequest

Contents

Description

 

Synopsis

Exported types

Methods

authenticate

authenticationRequestAuthenticate Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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