Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
No description available in the introspection data.
Synopsis
- newtype AuthenticationRequest = AuthenticationRequest (ManagedPtr AuthenticationRequest)
- class (GObject o, IsDescendantOf AuthenticationRequest o) => IsAuthenticationRequest o
- toAuthenticationRequest :: (MonadIO m, IsAuthenticationRequest o) => o -> m AuthenticationRequest
- authenticationRequestAuthenticate :: (HasCallStack, MonadIO m, IsAuthenticationRequest a) => a -> Maybe Credential -> m ()
- authenticationRequestCanSaveCredentials :: (HasCallStack, MonadIO m, IsAuthenticationRequest a) => a -> m Bool
- authenticationRequestCancel :: (HasCallStack, MonadIO m, IsAuthenticationRequest a) => a -> m ()
- authenticationRequestGetCertificatePinFlags :: (HasCallStack, MonadIO m, IsAuthenticationRequest a) => a -> m [TlsPasswordFlags]
- authenticationRequestGetHost :: (HasCallStack, MonadIO m, IsAuthenticationRequest a) => a -> m Text
- authenticationRequestGetPort :: (HasCallStack, MonadIO m, IsAuthenticationRequest a) => a -> m Word32
- authenticationRequestGetProposedCredential :: (HasCallStack, MonadIO m, IsAuthenticationRequest a) => a -> m Credential
- authenticationRequestGetRealm :: (HasCallStack, MonadIO m, IsAuthenticationRequest a) => a -> m Text
- authenticationRequestGetScheme :: (HasCallStack, MonadIO m, IsAuthenticationRequest a) => a -> m AuthenticationScheme
- authenticationRequestGetSecurityOrigin :: (HasCallStack, MonadIO m, IsAuthenticationRequest a) => a -> m SecurityOrigin
- authenticationRequestIsForProxy :: (HasCallStack, MonadIO m, IsAuthenticationRequest a) => a -> m Bool
- authenticationRequestIsRetry :: (HasCallStack, MonadIO m, IsAuthenticationRequest a) => a -> m Bool
- authenticationRequestSetCanSaveCredentials :: (HasCallStack, MonadIO m, IsAuthenticationRequest a) => a -> Bool -> m ()
- authenticationRequestSetProposedCredential :: (HasCallStack, MonadIO m, IsAuthenticationRequest a) => a -> Credential -> m ()
- type AuthenticationRequestAuthenticatedCallback = Credential -> IO ()
- afterAuthenticationRequestAuthenticated :: (IsAuthenticationRequest a, MonadIO m) => a -> ((?self :: a) => AuthenticationRequestAuthenticatedCallback) -> m SignalHandlerId
- onAuthenticationRequestAuthenticated :: (IsAuthenticationRequest a, MonadIO m) => a -> ((?self :: a) => AuthenticationRequestAuthenticatedCallback) -> m SignalHandlerId
- type AuthenticationRequestCancelledCallback = IO ()
- afterAuthenticationRequestCancelled :: (IsAuthenticationRequest a, MonadIO m) => a -> ((?self :: a) => AuthenticationRequestCancelledCallback) -> m SignalHandlerId
- onAuthenticationRequestCancelled :: (IsAuthenticationRequest a, MonadIO m) => a -> ((?self :: a) => AuthenticationRequestCancelledCallback) -> m SignalHandlerId
Exported types
newtype AuthenticationRequest Source #
Memory-managed wrapper type.
Instances
Eq AuthenticationRequest Source # | |
Defined in GI.WebKit2.Objects.AuthenticationRequest (==) :: AuthenticationRequest -> AuthenticationRequest -> Bool # (/=) :: AuthenticationRequest -> AuthenticationRequest -> Bool # | |
GObject AuthenticationRequest Source # | |
Defined in GI.WebKit2.Objects.AuthenticationRequest | |
ManagedPtrNewtype AuthenticationRequest Source # | |
TypedObject AuthenticationRequest Source # | |
Defined in GI.WebKit2.Objects.AuthenticationRequest | |
HasParentTypes AuthenticationRequest Source # | |
Defined in GI.WebKit2.Objects.AuthenticationRequest | |
IsGValue (Maybe AuthenticationRequest) Source # | Convert |
Defined in GI.WebKit2.Objects.AuthenticationRequest gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe AuthenticationRequest -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe AuthenticationRequest) # | |
type ParentTypes AuthenticationRequest Source # | |
Defined in GI.WebKit2.Objects.AuthenticationRequest |
class (GObject o, IsDescendantOf AuthenticationRequest o) => IsAuthenticationRequest o Source #
Type class for types which can be safely cast to AuthenticationRequest
, for instance with toAuthenticationRequest
.
Instances
(GObject o, IsDescendantOf AuthenticationRequest o) => IsAuthenticationRequest o Source # | |
Defined in GI.WebKit2.Objects.AuthenticationRequest |
toAuthenticationRequest :: (MonadIO m, IsAuthenticationRequest o) => o -> m AuthenticationRequest Source #
Cast to AuthenticationRequest
, 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
authenticate, bindProperty, bindPropertyFull, canSaveCredentials, cancel, forceFloating, freezeNotify, getv, isFloating, isForProxy, isRetry, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getCertificatePinFlags, getData, getHost, getPort, getProperty, getProposedCredential, getQdata, getRealm, getScheme, getSecurityOrigin.
Setters
setCanSaveCredentials, setData, setDataFull, setProperty, setProposedCredential.
authenticate
authenticationRequestAuthenticate Source #
:: (HasCallStack, MonadIO m, IsAuthenticationRequest a) | |
=> a |
|
-> Maybe Credential |
|
-> m () |
Authenticate the AuthenticationRequest
using the Credential
supplied. To continue without credentials, pass Nothing
as credential
.
Since: 2.2
canSaveCredentials
authenticationRequestCanSaveCredentials Source #
:: (HasCallStack, MonadIO m, IsAuthenticationRequest a) | |
=> a |
|
-> m Bool | Returns: |
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,
if private browsing is enabled, or if persistent credential storage has been
disabled in WebsiteDataManager
, unless credentials saving has been
explicitly enabled with authenticationRequestSetCanSaveCredentials
.
Since: 2.2
cancel
authenticationRequestCancel Source #
:: (HasCallStack, MonadIO m, IsAuthenticationRequest a) | |
=> a |
|
-> m () |
Cancel the authentication challenge. This will also cancel the page loading and result in a
loadFailed signal with a NetworkError
of type NetworkErrorCancelled
being emitted.
Since: 2.2
getCertificatePinFlags
authenticationRequestGetCertificatePinFlags Source #
:: (HasCallStack, MonadIO m, IsAuthenticationRequest a) | |
=> a |
|
-> m [TlsPasswordFlags] | Returns: a |
Get the TlsPasswordFlags
of the AuthenticationSchemeClientCertificatePinRequested
authentication challenge.
Since: 2.34
getHost
authenticationRequestGetHost Source #
:: (HasCallStack, MonadIO m, IsAuthenticationRequest a) | |
=> a |
|
-> m Text | Returns: The host of |
Get the host that this authentication challenge is applicable to.
Since: 2.2
getPort
authenticationRequestGetPort Source #
:: (HasCallStack, MonadIO m, IsAuthenticationRequest a) | |
=> a |
|
-> m Word32 | Returns: The port of |
Get the port that this authentication challenge is applicable to.
Since: 2.2
getProposedCredential
authenticationRequestGetProposedCredential Source #
:: (HasCallStack, MonadIO m, IsAuthenticationRequest a) | |
=> a |
|
-> m Credential | Returns: A |
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 #
:: (HasCallStack, MonadIO m, IsAuthenticationRequest a) | |
=> a |
|
-> m Text | Returns: The realm of |
Get the realm that this authentication challenge is applicable to.
Since: 2.2
getScheme
authenticationRequestGetScheme Source #
:: (HasCallStack, MonadIO m, IsAuthenticationRequest a) | |
=> a |
|
-> m AuthenticationScheme | Returns: The |
Get the authentication scheme of the authentication challenge.
Since: 2.2
getSecurityOrigin
authenticationRequestGetSecurityOrigin Source #
:: (HasCallStack, MonadIO m, IsAuthenticationRequest a) | |
=> a |
|
-> m SecurityOrigin | Returns: a newly created |
Get the SecurityOrigin
that this authentication challenge is applicable to.
Since: 2.30
isForProxy
authenticationRequestIsForProxy Source #
:: (HasCallStack, MonadIO m, IsAuthenticationRequest a) | |
=> a |
|
-> m Bool | Returns: |
Determine whether the authentication challenge is associated with a proxy server rather than an "origin" server.
Since: 2.2
isRetry
authenticationRequestIsRetry Source #
:: (HasCallStack, MonadIO m, IsAuthenticationRequest a) | |
=> a |
|
-> m Bool | Returns: |
Determine whether this this is a first attempt or a retry for this authentication challenge.
Since: 2.2
setCanSaveCredentials
authenticationRequestSetCanSaveCredentials Source #
:: (HasCallStack, MonadIO m, IsAuthenticationRequest a) | |
=> a |
|
-> Bool |
|
-> m () |
Set whether the authentication method associated with request
should allow the storage of credentials.
This should be used by applications handling their own credentials
storage to indicate that it should be supported even when internal
credential storage is disabled or unsupported.
Note that storing of credentials will not be allowed on ephemeral
sessions in any case.
Since: 2.30
setProposedCredential
authenticationRequestSetProposedCredential Source #
:: (HasCallStack, MonadIO m, IsAuthenticationRequest a) | |
=> a |
|
-> Credential |
|
-> m () |
Set the Credential
of the proposed authentication challenge that was
stored from a previous session. This should only be used by applications handling
their own credential storage. (When using the default WebKit credential storage,
authenticationRequestGetProposedCredential
already contains previously-stored
credentials.)
Passing a Nothing
credential
will clear the proposed credential.
Since: 2.30
Signals
authenticated
type AuthenticationRequestAuthenticatedCallback Source #
= Credential |
|
-> IO () |
This signal is emitted when the user authentication request succeeded. Applications handling their own credential storage should connect to this signal to save the credentials.
Since: 2.30
afterAuthenticationRequestAuthenticated :: (IsAuthenticationRequest a, MonadIO m) => a -> ((?self :: a) => AuthenticationRequestAuthenticatedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the authenticated signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
authenticationRequest #authenticated 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.
onAuthenticationRequestAuthenticated :: (IsAuthenticationRequest a, MonadIO m) => a -> ((?self :: a) => AuthenticationRequestAuthenticatedCallback) -> m SignalHandlerId Source #
Connect a signal handler for the authenticated signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
authenticationRequest #authenticated callback
cancelled
type AuthenticationRequestCancelledCallback = IO () Source #
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
afterAuthenticationRequestCancelled :: (IsAuthenticationRequest a, MonadIO m) => a -> ((?self :: a) => AuthenticationRequestCancelledCallback) -> m SignalHandlerId Source #
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
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.
onAuthenticationRequestCancelled :: (IsAuthenticationRequest a, MonadIO m) => a -> ((?self :: a) => AuthenticationRequestCancelledCallback) -> m SignalHandlerId Source #
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