GI.Soup.Objects.AuthManager

AuthManager is the SessionFeature that handles HTTP authentication for a Session.

A AuthManager is added to the session by default, and normally you don't need to worry about it at all. However, if you want to disable HTTP authentication, you can remove the feature from the session with sessionRemoveFeatureByType, or disable it on individual requests with messageDisableFeature.

Since: 2.42

Exported types

newtype AuthManager

Memory-managed wrapper type.

Constructors

AuthManager (ManagedPtr AuthManager)

Instances

Eq AuthManager

Defined in GI.Soup.Objects.AuthManager

Methods

(==) :: AuthManager -> AuthManager -> Bool

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

GObject AuthManager

Defined in GI.Soup.Objects.AuthManager

ManagedPtrNewtype AuthManager

Defined in GI.Soup.Objects.AuthManager

Methods

toManagedPtr :: AuthManager -> ManagedPtr AuthManager

TypedObject AuthManager

Defined in GI.Soup.Objects.AuthManager

Methods

glibType :: IO GType

HasParentTypes AuthManager

Defined in GI.Soup.Objects.AuthManager

IsGValue (Maybe AuthManager)

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

Defined in GI.Soup.Objects.AuthManager

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes AuthManager

Defined in GI.Soup.Objects.AuthManager

type ParentTypes AuthManager = '[Object, SessionFeature]

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

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

Instances

(GObject o, IsDescendantOf AuthManager o) => IsAuthManager o

Defined in GI.Soup.Objects.AuthManager

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

Cast to AuthManager, 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

addFeature, attach, bindProperty, bindPropertyFull, clearCachedCredentials, detach, forceFloating, freezeNotify, getv, hasFeature, isFloating, notify, notifyByPspec, ref, refSink, removeFeature, runDispose, stealData, stealQdata, thawNotify, unref, useAuth, watchClosure.

Getters

getData, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

clearCachedCredentials

authManagerClearCachedCredentials

Arguments

:: (HasCallStack, MonadIO m, IsAuthManager a)

=> a

manager: a AuthManager

-> m ()

Clear all credentials cached by manager

Since: 2.58

useAuth

authManagerUseAuth

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

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.

type C_AuthManagerAuthenticateCallback = Ptr () -> Ptr Message -> Ptr Auth -> CInt -> Ptr () -> IO ()

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

afterAuthManagerAuthenticate :: (IsAuthManager a, MonadIO m) => a -> AuthManagerAuthenticateCallback -> m SignalHandlerId

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

genClosure_AuthManagerAuthenticate :: MonadIO m => AuthManagerAuthenticateCallback -> m (GClosure C_AuthManagerAuthenticateCallback)

Wrap the callback into a GClosure.

mk_AuthManagerAuthenticateCallback :: C_AuthManagerAuthenticateCallback -> IO (FunPtr C_AuthManagerAuthenticateCallback)

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

noAuthManagerAuthenticateCallback :: Maybe AuthManagerAuthenticateCallback

A convenience synonym for Nothing :: Maybe AuthManagerAuthenticateCallback.

onAuthManagerAuthenticate :: (IsAuthManager a, MonadIO m) => a -> AuthManagerAuthenticateCallback -> m SignalHandlerId

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

wrap_AuthManagerAuthenticateCallback :: AuthManagerAuthenticateCallback -> C_AuthManagerAuthenticateCallback

Wrap a AuthManagerAuthenticateCallback into a C_AuthManagerAuthenticateCallback.