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

GI.Soup.Interfaces.SessionFeature

Description

SessionFeature is the interface used by classes that extend the functionality of a Session. Some features like HTTP authentication handling are implemented internally via SessionFeatures. Other features can be added to the session by the application. (Eg, Logger, CookieJar.)

See sessionAddFeature, etc, to add a feature to a session.

Since: 2.24

Synopsis

Exported types

newtype SessionFeature Source #

Memory-managed wrapper type.

Constructors

SessionFeature (ManagedPtr SessionFeature) 

Instances

Instances details
Eq SessionFeature Source # 
Instance details

Defined in GI.Soup.Interfaces.SessionFeature

GObject SessionFeature Source # 
Instance details

Defined in GI.Soup.Interfaces.SessionFeature

ManagedPtrNewtype SessionFeature Source # 
Instance details

Defined in GI.Soup.Interfaces.SessionFeature

TypedObject SessionFeature Source # 
Instance details

Defined in GI.Soup.Interfaces.SessionFeature

Methods

glibType :: IO GType

HasParentTypes SessionFeature Source # 
Instance details

Defined in GI.Soup.Interfaces.SessionFeature

IsGValue (Maybe SessionFeature) Source #

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

Instance details

Defined in GI.Soup.Interfaces.SessionFeature

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes SessionFeature Source # 
Instance details

Defined in GI.Soup.Interfaces.SessionFeature

type ParentTypes SessionFeature = '[Object]

class (GObject o, IsDescendantOf SessionFeature o) => IsSessionFeature o Source #

Type class for types which can be safely cast to SessionFeature, for instance with toSessionFeature.

Instances

Instances details
(GObject o, IsDescendantOf SessionFeature o) => IsSessionFeature o Source # 
Instance details

Defined in GI.Soup.Interfaces.SessionFeature

toSessionFeature :: (MonadIO m, IsSessionFeature o) => o -> m SessionFeature Source #

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

Methods

addFeature

sessionFeatureAddFeature Source #

Arguments

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

feature: the "base" feature

-> GType

type: the GType of a "sub-feature"

-> m Bool

Returns: True if feature accepted type as a subfeature.

Adds a "sub-feature" of type type to the base feature feature. This is used for features that can be extended with multiple different types. Eg, the authentication manager can be extended with subtypes of Auth.

Since: 2.34

attach

sessionFeatureAttach :: (HasCallStack, MonadIO m, IsSessionFeature a, IsSession b) => a -> b -> m () Source #

No description available in the introspection data.

detach

sessionFeatureDetach :: (HasCallStack, MonadIO m, IsSessionFeature a, IsSession b) => a -> b -> m () Source #

No description available in the introspection data.

hasFeature

sessionFeatureHasFeature Source #

Arguments

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

feature: the "base" feature

-> GType

type: the GType of a "sub-feature"

-> m Bool

Returns: True if feature has a subfeature of type type

Tests if feature has a "sub-feature" of type type. See sessionFeatureAddFeature.

Since: 2.34

removeFeature

sessionFeatureRemoveFeature Source #

Arguments

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

feature: the "base" feature

-> GType

type: the GType of a "sub-feature"

-> m Bool

Returns: True if type was removed from feature

Removes the "sub-feature" of type type from the base feature feature. See sessionFeatureAddFeature.

Since: 2.34