gi-soup-2.4.25: Libsoup bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.Soup.Objects.AuthManager

Description

No description available in the introspection data.

Synopsis

Exported types

class (GObject o, IsDescendantOf AuthManager o) => IsAuthManager o Source #

Type class for types which can be safely cast to AuthManager, for instance with toAuthManager.

Instances

Instances details
(GObject o, IsDescendantOf AuthManager o) => IsAuthManager o Source # 
Instance details

Defined in GI.Soup.Objects.AuthManager

toAuthManager :: (MonadIO m, IsAuthManager o) => o -> m AuthManager Source #

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

Methods

clearCachedCredentials

authManagerClearCachedCredentials Source #

Arguments

:: (HasCallStack, MonadIO m, IsAuthManager a) 
=> a

manager: a AuthManager

-> m () 

Clear all credentials cached by manager

Since: 2.58

useAuth

authManagerUseAuth Source #

Arguments

:: (HasCallStack, MonadIO m, IsAuthManager a, IsAuth b) 
=> a

manager: a AuthManager

-> URI

uri: the URI under which auth is to be used

-> b

auth: the Auth to use

-> m () 

Records that auth is to be used under uri, as though a WWW-Authenticate header had been received at that URI. This can be used to "preload" manager's auth cache, to avoid an extra HTTP round trip in the case where you know ahead of time that a 401 response will be returned.

This is only useful for authentication types where the initial Authorization header does not depend on any additional information from the server. (Eg, Basic or NTLM, but not Digest.)

Since: 2.42

Signals

authenticate

type AuthManagerAuthenticateCallback Source #

Arguments

 = Message

msg: the Message being sent

-> Auth

auth: the Auth to authenticate

-> Bool

retrying: True if this is the second (or later) attempt

-> IO () 

Emitted when the manager requires the application to provide authentication credentials.

Session connects to this signal and emits its own authenticate signal when it is emitted, so you shouldn't need to use this signal directly.

afterAuthManagerAuthenticate :: (IsAuthManager a, MonadIO m) => a -> ((?self :: a) => AuthManagerAuthenticateCallback) -> m SignalHandlerId Source #

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

after authManager #authenticate 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.

onAuthManagerAuthenticate :: (IsAuthManager a, MonadIO m) => a -> ((?self :: a) => AuthManagerAuthenticateCallback) -> m SignalHandlerId Source #

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

on authManager #authenticate callback