GI.WebKit2.Objects.CookieManager

Defines how to handle cookies in a WebContext.

The WebKitCookieManager defines how to set up and handle cookies. You can get it from a WebsiteDataManager with websiteDataManagerGetCookieManager, and use it to set where to store cookies with cookieManagerSetPersistentStorage, or to set the acceptance policy, with cookieManagerGetAcceptPolicy.

Exported types

newtype CookieManager

Memory-managed wrapper type.

Constructors

CookieManager (ManagedPtr CookieManager)

Instances

Eq CookieManager

Defined in GI.WebKit2.Objects.CookieManager

Methods

(==) :: CookieManager -> CookieManager -> Bool

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

GObject CookieManager

Defined in GI.WebKit2.Objects.CookieManager

ManagedPtrNewtype CookieManager

Defined in GI.WebKit2.Objects.CookieManager

Methods

toManagedPtr :: CookieManager -> ManagedPtr CookieManager

TypedObject CookieManager

Defined in GI.WebKit2.Objects.CookieManager

Methods

glibType :: IO GType

HasParentTypes CookieManager

Defined in GI.WebKit2.Objects.CookieManager

IsGValue (Maybe CookieManager)

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

Defined in GI.WebKit2.Objects.CookieManager

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes CookieManager

Defined in GI.WebKit2.Objects.CookieManager

type ParentTypes CookieManager = '[Object]

class (GObject o, IsDescendantOf CookieManager o) => IsCookieManager o

Type class for types which can be safely cast to CookieManager, for instance with toCookieManager.

Instances

(GObject o, IsDescendantOf CookieManager o) => IsCookieManager o

Defined in GI.WebKit2.Objects.CookieManager

toCookieManager :: (MonadIO m, IsCookieManager o) => o -> m CookieManager

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

addCookie, addCookieFinish, bindProperty, bindPropertyFull, deleteAllCookies, deleteCookie, deleteCookieFinish, deleteCookiesForDomain, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getAcceptPolicy, getAcceptPolicyFinish, getCookies, getCookiesFinish, getData, getDomainsWithCookies, getDomainsWithCookiesFinish, getProperty, getQdata.

Setters

setAcceptPolicy, setData, setDataFull, setPersistentStorage, setProperty.

addCookie

cookieManagerAddCookie

Arguments

:: (HasCallStack, MonadIO m, IsCookieManager a, IsCancellable b)

=> a

cookieManager: a CookieManager

-> Cookie

cookie: the Cookie to be added

-> Maybe b

cancellable: a Cancellable or Nothing to ignore

-> Maybe AsyncReadyCallback

callback: a AsyncReadyCallback to call when the request is satisfied

-> m ()

Asynchronously add a Cookie to the underlying storage.

When the operation is finished, callback will be called. You can then call cookieManagerAddCookieFinish to get the result of the operation.

Since: 2.20

addCookieFinish

cookieManagerAddCookieFinish

Arguments

:: (HasCallStack, MonadIO m, IsCookieManager a, IsAsyncResult b)

=> a

cookieManager: a CookieManager

-> b

result: a AsyncResult

-> m ()

(Can throw GError)

Finish an asynchronous operation started with cookieManagerAddCookie.

Since: 2.20

deleteAllCookies

cookieManagerDeleteAllCookies

Arguments

:: (HasCallStack, MonadIO m, IsCookieManager a)

=> a

cookieManager: a CookieManager

-> m ()

Deprecated: (Since version 2.16)Use websiteDataManagerClear instead.

Delete all cookies of cookieManager.

deleteCookie

cookieManagerDeleteCookie

Arguments

:: (HasCallStack, MonadIO m, IsCookieManager a, IsCancellable b)

=> a

cookieManager: a CookieManager

-> Cookie

cookie: the Cookie to be deleted

-> Maybe b

cancellable: a Cancellable or Nothing to ignore

-> Maybe AsyncReadyCallback

callback: a AsyncReadyCallback to call when the request is satisfied

-> m ()

Asynchronously delete a Cookie from the current session.

When the operation is finished, callback will be called. You can then call cookieManagerDeleteCookieFinish to get the result of the operation.

Since: 2.20

deleteCookieFinish

cookieManagerDeleteCookieFinish

Arguments

:: (HasCallStack, MonadIO m, IsCookieManager a, IsAsyncResult b)

=> a

cookieManager: a CookieManager

-> b

result: a AsyncResult

-> m ()

(Can throw GError)

Finish an asynchronous operation started with cookieManagerDeleteCookie.

Since: 2.20

deleteCookiesForDomain

cookieManagerDeleteCookiesForDomain

Arguments

:: (HasCallStack, MonadIO m, IsCookieManager a)

=> a

cookieManager: a CookieManager

-> Text

domain: a domain name

-> m ()

Deprecated: (Since version 2.16)Use websiteDataManagerRemove instead.

Remove all cookies of cookieManager for the given domain.

getAcceptPolicy

cookieManagerGetAcceptPolicy

Arguments

:: (HasCallStack, MonadIO m, IsCookieManager a, IsCancellable b)

=> a

cookieManager: a CookieManager

-> Maybe b

cancellable: a Cancellable or Nothing to ignore

-> Maybe AsyncReadyCallback

callback: a AsyncReadyCallback to call when the request is satisfied

-> m ()

Asynchronously get the cookie acceptance policy of cookieManager.

Note that when policy was set to CookieAcceptPolicyNoThirdParty and ITP is enabled, this will return CookieAcceptPolicyAlways. See also websiteDataManagerSetItpEnabled.

When the operation is finished, callback will be called. You can then call cookieManagerGetAcceptPolicyFinish to get the result of the operation.

getAcceptPolicyFinish

cookieManagerGetAcceptPolicyFinish

Arguments

:: (HasCallStack, MonadIO m, IsCookieManager a, IsAsyncResult b)

=> a

cookieManager: a CookieManager

-> b

result: a AsyncResult

-> m CookieAcceptPolicy

Returns: the cookie acceptance policy of cookieManager as a CookieAcceptPolicy. (Can throw GError)

Finish an asynchronous operation started with cookieManagerGetAcceptPolicy.

getCookies

cookieManagerGetCookies

Arguments

:: (HasCallStack, MonadIO m, IsCookieManager a, IsCancellable b)

=> a

cookieManager: a CookieManager

-> Text

uri: the URI associated to the cookies to be retrieved

-> Maybe b

cancellable: a Cancellable or Nothing to ignore

-> Maybe AsyncReadyCallback

callback: a AsyncReadyCallback to call when the request is satisfied

-> m ()

Asynchronously get a list of Cookie from cookieManager.

Asynchronously get a list of Cookie from cookieManager associated with uri, which must be either an HTTP or an HTTPS URL.

When the operation is finished, callback will be called. You can then call cookieManagerGetCookiesFinish to get the result of the operation.

Since: 2.20

getCookiesFinish

cookieManagerGetCookiesFinish

Arguments

:: (HasCallStack, MonadIO m, IsCookieManager a, IsAsyncResult b)

=> a

cookieManager: a CookieManager

-> b

result: a AsyncResult

-> m [Cookie]

Returns: A List of Cookie instances. (Can throw GError)

Finish an asynchronous operation started with cookieManagerGetCookies.

The return value is a SList of Cookie instances which should be released with g_list_free_full() and cookieFree.

Since: 2.20

getDomainsWithCookies

cookieManagerGetDomainsWithCookies

Arguments

:: (HasCallStack, MonadIO m, IsCookieManager a, IsCancellable b)

=> a

cookieManager: a CookieManager

-> Maybe b

cancellable: a Cancellable or Nothing to ignore

-> Maybe AsyncReadyCallback

callback: a AsyncReadyCallback to call when the request is satisfied

-> m ()

Deprecated: (Since version 2.16)Use websiteDataManagerFetch instead.

Asynchronously get the list of domains for which cookieManager contains cookies.

When the operation is finished, callback will be called. You can then call cookieManagerGetDomainsWithCookiesFinish to get the result of the operation.

getDomainsWithCookiesFinish

cookieManagerGetDomainsWithCookiesFinish

Arguments

:: (HasCallStack, MonadIO m, IsCookieManager a, IsAsyncResult b)

=> a

cookieManager: a CookieManager

-> b

result: a AsyncResult

-> m [Text]

Returns: A Nothing terminated array of domain names or Nothing in case of error. (Can throw GError)

Deprecated: (Since version 2.16)Use websiteDataManagerFetchFinish instead.

Finish an asynchronous operation started with cookieManagerGetDomainsWithCookies.

The return value is a Nothing terminated list of strings which should be released with strfreev.

setAcceptPolicy

cookieManagerSetAcceptPolicy

Arguments

:: (HasCallStack, MonadIO m, IsCookieManager a)

=> a

cookieManager: a CookieManager

-> CookieAcceptPolicy

policy: a CookieAcceptPolicy

-> m ()

Set the cookie acceptance policy of cookieManager as policy.

Note that ITP has its own way to handle third-party cookies, so when it's enabled, and policy is set to CookieAcceptPolicyNoThirdParty, CookieAcceptPolicyAlways will be used instead. Once disabled, the policy will be set back to CookieAcceptPolicyNoThirdParty. See also websiteDataManagerSetItpEnabled.

setPersistentStorage

cookieManagerSetPersistentStorage

Arguments

:: (HasCallStack, MonadIO m, IsCookieManager a)

=> a

cookieManager: a CookieManager

-> Text

filename: the filename to read to/write from

-> CookiePersistentStorage

storage: a CookiePersistentStorage

-> m ()

Set non-session cookies.

Set the filename where non-session cookies are stored persistently using storage as the format to read/write the cookies. Cookies are initially read from filename to create an initial set of cookies. Then, non-session cookies will be written to filename when the WebKitCookieManagerchanged signal is emitted. By default, cookieManager doesn't store the cookies persistently, so you need to call this method to keep cookies saved across sessions.

This method should never be called on a CookieManager associated to an ephemeral WebsiteDataManager.

Signals

changed

type CookieManagerChangedCallback = IO ()

This signal is emitted when cookies are added, removed or modified.

afterCookieManagerChanged :: (IsCookieManager a, MonadIO m) => a -> ((?self :: a) => CookieManagerChangedCallback) -> m SignalHandlerId

Connect a signal handler for the changed signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after cookieManager #changed 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.

onCookieManagerChanged :: (IsCookieManager a, MonadIO m) => a -> ((?self :: a) => CookieManagerChangedCallback) -> m SignalHandlerId

Connect a signal handler for the changed signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on cookieManager #changed callback