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 AuthManager = AuthManager (ManagedPtr AuthManager)
- class (GObject o, IsDescendantOf AuthManager o) => IsAuthManager o
- toAuthManager :: (MonadIO m, IsAuthManager o) => o -> m AuthManager
- authManagerClearCachedCredentials :: (HasCallStack, MonadIO m, IsAuthManager a) => a -> m ()
- authManagerUseAuth :: (HasCallStack, MonadIO m, IsAuthManager a, IsAuth b) => a -> URI -> b -> m ()
- type AuthManagerAuthenticateCallback = Message -> Auth -> Bool -> IO ()
- afterAuthManagerAuthenticate :: (IsAuthManager a, MonadIO m) => a -> ((?self :: a) => AuthManagerAuthenticateCallback) -> m SignalHandlerId
- onAuthManagerAuthenticate :: (IsAuthManager a, MonadIO m) => a -> ((?self :: a) => AuthManagerAuthenticateCallback) -> m SignalHandlerId
Exported types
newtype AuthManager Source #
Memory-managed wrapper type.
Instances
Eq AuthManager Source # | |
Defined in GI.Soup.Objects.AuthManager (==) :: AuthManager -> AuthManager -> Bool # (/=) :: AuthManager -> AuthManager -> Bool # | |
GObject AuthManager Source # | |
Defined in GI.Soup.Objects.AuthManager | |
ManagedPtrNewtype AuthManager Source # | |
Defined in GI.Soup.Objects.AuthManager | |
TypedObject AuthManager Source # | |
Defined in GI.Soup.Objects.AuthManager | |
HasParentTypes AuthManager Source # | |
Defined in GI.Soup.Objects.AuthManager | |
IsGValue (Maybe AuthManager) Source # | Convert |
Defined in GI.Soup.Objects.AuthManager gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe AuthManager -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe AuthManager) # | |
type ParentTypes AuthManager Source # | |
Defined in GI.Soup.Objects.AuthManager |
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
(GObject o, IsDescendantOf AuthManager o) => IsAuthManager o Source # | |
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
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
clearCachedCredentials
authManagerClearCachedCredentials Source #
:: (HasCallStack, MonadIO m, IsAuthManager a) | |
=> a |
|
-> m () |
Clear all credentials cached by manager
Since: 2.58
useAuth
:: (HasCallStack, MonadIO m, IsAuthManager a, IsAuth b) | |
=> a |
|
-> URI |
|
-> b |
|
-> 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 #
= Message |
|
-> Auth |
|
-> Bool |
|
-> 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