Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (inaki@blueleaf.cc)
Safe Haskell	None
Language	Haskell2010

GI.Soup.Interfaces.SessionFeature

Contents

Exported types
Methods

Description

An object that implement some sort of optional feature for Session.

Since: 2.24

Synopsis

newtype SessionFeature = SessionFeature (ManagedPtr SessionFeature)
noSessionFeature :: Maybe SessionFeature
class (GObject o, IsDescendantOf SessionFeature o) => IsSessionFeature o
toSessionFeature :: (MonadIO m, IsSessionFeature o) => o -> m SessionFeature
sessionFeatureAddFeature :: (HasCallStack, MonadIO m, IsSessionFeature a) => a -> GType -> m Bool
sessionFeatureAttach :: (HasCallStack, MonadIO m, IsSessionFeature a, IsSession b) => a -> b -> m ()
sessionFeatureDetach :: (HasCallStack, MonadIO m, IsSessionFeature a, IsSession b) => a -> b -> m ()
sessionFeatureHasFeature :: (HasCallStack, MonadIO m, IsSessionFeature a) => a -> GType -> m Bool
sessionFeatureRemoveFeature :: (HasCallStack, MonadIO m, IsSessionFeature a) => a -> GType -> m Bool

Exported types

newtype SessionFeature Source #

Memory-managed wrapper type.

Constructors

SessionFeature (ManagedPtr SessionFeature)

Instances

GObject SessionFeature Source #
Instance details Defined in GI.Soup.Interfaces.SessionFeature Methods gobjectType :: IO GType #
HasParentTypes SessionFeature Source #
Instance details Defined in GI.Soup.Interfaces.SessionFeature
type ParentTypes SessionFeature Source #
Instance details Defined in GI.Soup.Interfaces.SessionFeature type ParentTypes SessionFeature = Object ': ([] :: [Type])

noSessionFeature :: Maybe SessionFeature Source #

A convenience alias for Nothing :: Maybe SessionFeature.

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

(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