GI.Soup.Objects.AuthDomainBasic

No description available in the introspection data.

Exported types

newtype AuthDomainBasic

Memory-managed wrapper type.

Constructors

AuthDomainBasic (ManagedPtr AuthDomainBasic)

Instances

GObject AuthDomainBasic

Defined in GI.Soup.Objects.AuthDomainBasic

Methods

gobjectType :: IO GType

HasParentTypes AuthDomainBasic

Defined in GI.Soup.Objects.AuthDomainBasic

type ParentTypes AuthDomainBasic

Defined in GI.Soup.Objects.AuthDomainBasic

type ParentTypes AuthDomainBasic = AuthDomain ': (Object ': ([] :: [Type]))

class (GObject o, IsDescendantOf AuthDomainBasic o) => IsAuthDomainBasic o

Type class for types which can be safely cast to AuthDomainBasic, for instance with toAuthDomainBasic.

Instances

(GObject o, IsDescendantOf AuthDomainBasic o) => IsAuthDomainBasic o

Defined in GI.Soup.Objects.AuthDomainBasic

toAuthDomainBasic :: (MonadIO m, IsAuthDomainBasic o) => o -> m AuthDomainBasic

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

noAuthDomainBasic :: Maybe AuthDomainBasic

A convenience alias for Nothing :: Maybe AuthDomainBasic.

Methods

setAuthCallback

authDomainBasicSetAuthCallback

Arguments

:: (HasCallStack, MonadIO m, IsAuthDomainBasic a)

=> a

domain: the domain

-> AuthDomainBasicAuthCallback

callback: the callback

-> m ()

Sets the callback that domain will use to authenticate incoming requests. For each request containing authorization, domain will invoke the callback, and then either accept or reject the request based on callback's return value.

You can also set the auth callback by setting the AUTH_DOMAIN_BASIC_AUTH_CALLBACK and AUTH_DOMAIN_BASIC_AUTH_DATA properties, which can also be used to set the callback at construct time.

Properties

authCallback

The AuthDomainBasicAuthCallback

clearAuthDomainBasicAuthCallback :: (MonadIO m, IsAuthDomainBasic o) => o -> m ()

Set the value of the “auth-callback” property to Nothing. When overloading is enabled, this is equivalent to

clear #authCallback

constructAuthDomainBasicAuthCallback :: IsAuthDomainBasic o => FunPtr C_AuthDomainBasicAuthCallback -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “auth-callback” property. This is rarely needed directly, but it is used by new.

getAuthDomainBasicAuthCallback :: (MonadIO m, IsAuthDomainBasic o) => o -> m (Maybe AuthDomainBasicAuthCallback_WithClosures)

Get the value of the “auth-callback” property. When overloading is enabled, this is equivalent to

get authDomainBasic #authCallback

setAuthDomainBasicAuthCallback :: (MonadIO m, IsAuthDomainBasic o) => o -> FunPtr C_AuthDomainBasicAuthCallback -> m ()

Set the value of the “auth-callback” property. When overloading is enabled, this is equivalent to

set authDomainBasic [ #authCallback := value ]

authData

The data to pass to the AuthDomainBasicAuthCallback

constructAuthDomainBasicAuthData :: IsAuthDomainBasic o => Ptr () -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “auth-data” property. This is rarely needed directly, but it is used by new.

getAuthDomainBasicAuthData :: (MonadIO m, IsAuthDomainBasic o) => o -> m (Ptr ())

Get the value of the “auth-data” property. When overloading is enabled, this is equivalent to

get authDomainBasic #authData

setAuthDomainBasicAuthData :: (MonadIO m, IsAuthDomainBasic o) => o -> Ptr () -> m ()

Set the value of the “auth-data” property. When overloading is enabled, this is equivalent to

set authDomainBasic [ #authData := value ]