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 |
- Exported types
- Methods
- clear
- clearFinish
- fetch
- fetchFinish
- getBaseCacheDirectory
- getBaseDataDirectory
- getCookieManager
- getDiskCacheDirectory
- getDomCacheDirectory
- getHstsCacheDirectory
- getIndexeddbDirectory
- getItpDirectory
- getItpEnabled
- getItpSummary
- getItpSummaryFinish
- getLocalStorageDirectory
- getOfflineApplicationCacheDirectory
- getPersistentCredentialStorageEnabled
- getServiceWorkerRegistrationsDirectory
- getTlsErrorsPolicy
- getWebsqlDirectory
- isEphemeral
- newEphemeral
- remove
- removeFinish
- setItpEnabled
- setMemoryPressureSettings
- setNetworkProxySettings
- setPersistentCredentialStorageEnabled
- setTlsErrorsPolicy
- Properties
Manages data stored locally by web sites.
WebKitWebsiteDataManager allows you to manage the data that websites
can store in the client file system like databases or caches.
You can use WebKitWebsiteDataManager to configure the local directories
where the Website data will be stored, by creating a new manager with
webkit_website_data_manager_new()
passing the values you want to set.
You can set all the possible configuration values or only some of them,
a default value will be used automatically for the configuration options
not provided. WebsiteDataManager:baseDataDirectory and
WebsiteDataManager:baseCacheDirectory are two special properties
that can be used to set a common base directory for all Website data and
caches. It's possible to provide both, a base directory and a specific value,
but in that case, the specific value takes precedence over the base directory.
The newly created WebKitWebsiteDataManager must be passed as a construct property
to a WebContext
, you can use webContextNewWithWebsiteDataManager
to create a new WebContext
with a WebKitWebsiteDataManager.
In case you don't want to set any specific configuration, you don't need to create
a WebKitWebsiteDataManager, the WebContext
will create a WebKitWebsiteDataManager
with the default configuration. To get the WebKitWebsiteDataManager of a WebContext
you can use webContextGetWebsiteDataManager
.
A WebKitWebsiteDataManager can also be ephemeral and then all the directories configuration
is not needed because website data will never persist. You can create an ephemeral WebKitWebsiteDataManager
with websiteDataManagerNewEphemeral
. Then you can pass an ephemeral WebKitWebsiteDataManager to
a WebContext
to make it ephemeral or use webContextNewEphemeral
and the WebKitWebsiteDataManager
will be automatically created by the WebContext
.
WebKitWebsiteDataManager can also be used to fetch websites data, remove data stored by particular websites, or clear data for all websites modified since a given period of time.
Since: 2.10
Synopsis
- newtype WebsiteDataManager = WebsiteDataManager (ManagedPtr WebsiteDataManager)
- class (GObject o, IsDescendantOf WebsiteDataManager o) => IsWebsiteDataManager o
- toWebsiteDataManager :: (MonadIO m, IsWebsiteDataManager o) => o -> m WebsiteDataManager
- websiteDataManagerClear :: (HasCallStack, MonadIO m, IsWebsiteDataManager a, IsCancellable b) => a -> [WebsiteDataTypes] -> Int64 -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- websiteDataManagerClearFinish :: (HasCallStack, MonadIO m, IsWebsiteDataManager a, IsAsyncResult b) => a -> b -> m ()
- websiteDataManagerFetch :: (HasCallStack, MonadIO m, IsWebsiteDataManager a, IsCancellable b) => a -> [WebsiteDataTypes] -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- websiteDataManagerFetchFinish :: (HasCallStack, MonadIO m, IsWebsiteDataManager a, IsAsyncResult b) => a -> b -> m [WebsiteData]
- websiteDataManagerGetBaseCacheDirectory :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> m (Maybe Text)
- websiteDataManagerGetBaseDataDirectory :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> m (Maybe Text)
- websiteDataManagerGetCookieManager :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> m CookieManager
- websiteDataManagerGetDiskCacheDirectory :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> m (Maybe Text)
- websiteDataManagerGetDomCacheDirectory :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> m (Maybe Text)
- websiteDataManagerGetHstsCacheDirectory :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> m (Maybe Text)
- websiteDataManagerGetIndexeddbDirectory :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> m (Maybe Text)
- websiteDataManagerGetItpDirectory :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> m (Maybe Text)
- websiteDataManagerGetItpEnabled :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> m Bool
- websiteDataManagerGetItpSummary :: (HasCallStack, MonadIO m, IsWebsiteDataManager a, IsCancellable b) => a -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- websiteDataManagerGetItpSummaryFinish :: (HasCallStack, MonadIO m, IsWebsiteDataManager a, IsAsyncResult b) => a -> b -> m [ITPThirdParty]
- websiteDataManagerGetLocalStorageDirectory :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> m (Maybe Text)
- websiteDataManagerGetOfflineApplicationCacheDirectory :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> m (Maybe Text)
- websiteDataManagerGetPersistentCredentialStorageEnabled :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> m Bool
- websiteDataManagerGetServiceWorkerRegistrationsDirectory :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> m (Maybe Text)
- websiteDataManagerGetTlsErrorsPolicy :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> m TLSErrorsPolicy
- websiteDataManagerGetWebsqlDirectory :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> m (Maybe Text)
- websiteDataManagerIsEphemeral :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> m Bool
- websiteDataManagerNewEphemeral :: (HasCallStack, MonadIO m) => m WebsiteDataManager
- websiteDataManagerRemove :: (HasCallStack, MonadIO m, IsWebsiteDataManager a, IsCancellable b) => a -> [WebsiteDataTypes] -> [WebsiteData] -> Maybe b -> Maybe AsyncReadyCallback -> m ()
- websiteDataManagerRemoveFinish :: (HasCallStack, MonadIO m, IsWebsiteDataManager a, IsAsyncResult b) => a -> b -> m ()
- websiteDataManagerSetItpEnabled :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> Bool -> m ()
- websiteDataManagerSetMemoryPressureSettings :: (HasCallStack, MonadIO m) => MemoryPressureSettings -> m ()
- websiteDataManagerSetNetworkProxySettings :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> NetworkProxyMode -> Maybe NetworkProxySettings -> m ()
- websiteDataManagerSetPersistentCredentialStorageEnabled :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> Bool -> m ()
- websiteDataManagerSetTlsErrorsPolicy :: (HasCallStack, MonadIO m, IsWebsiteDataManager a) => a -> TLSErrorsPolicy -> m ()
- constructWebsiteDataManagerBaseCacheDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o)
- getWebsiteDataManagerBaseCacheDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text)
- constructWebsiteDataManagerBaseDataDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o)
- getWebsiteDataManagerBaseDataDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text)
- constructWebsiteDataManagerDiskCacheDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o)
- getWebsiteDataManagerDiskCacheDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text)
- constructWebsiteDataManagerDomCacheDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o)
- getWebsiteDataManagerDomCacheDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text)
- constructWebsiteDataManagerHstsCacheDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o)
- getWebsiteDataManagerHstsCacheDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text)
- constructWebsiteDataManagerIndexeddbDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o)
- getWebsiteDataManagerIndexeddbDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text)
- constructWebsiteDataManagerIsEphemeral :: (IsWebsiteDataManager o, MonadIO m) => Bool -> m (GValueConstruct o)
- getWebsiteDataManagerIsEphemeral :: (MonadIO m, IsWebsiteDataManager o) => o -> m Bool
- constructWebsiteDataManagerItpDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o)
- getWebsiteDataManagerItpDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text)
- constructWebsiteDataManagerLocalStorageDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o)
- getWebsiteDataManagerLocalStorageDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text)
- constructWebsiteDataManagerOfflineApplicationCacheDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o)
- getWebsiteDataManagerOfflineApplicationCacheDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text)
- constructWebsiteDataManagerServiceWorkerRegistrationsDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o)
- getWebsiteDataManagerServiceWorkerRegistrationsDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text)
- constructWebsiteDataManagerWebsqlDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o)
- getWebsiteDataManagerWebsqlDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text)
Exported types
newtype WebsiteDataManager Source #
Memory-managed wrapper type.
WebsiteDataManager (ManagedPtr WebsiteDataManager) |
Instances
class (GObject o, IsDescendantOf WebsiteDataManager o) => IsWebsiteDataManager o Source #
Type class for types which can be safely cast to WebsiteDataManager
, for instance with toWebsiteDataManager
.
Instances
(GObject o, IsDescendantOf WebsiteDataManager o) => IsWebsiteDataManager o Source # | |
Defined in GI.WebKit2.Objects.WebsiteDataManager |
toWebsiteDataManager :: (MonadIO m, IsWebsiteDataManager o) => o -> m WebsiteDataManager Source #
Cast to WebsiteDataManager
, 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
bindProperty, bindPropertyFull, clear, clearFinish, fetch, fetchFinish, forceFloating, freezeNotify, getv, isEphemeral, isFloating, notify, notifyByPspec, ref, refSink, remove, removeFinish, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getBaseCacheDirectory, getBaseDataDirectory, getCookieManager, getData, getDiskCacheDirectory, getDomCacheDirectory, getHstsCacheDirectory, getIndexeddbDirectory, getItpDirectory, getItpEnabled, getItpSummary, getItpSummaryFinish, getLocalStorageDirectory, getOfflineApplicationCacheDirectory, getPersistentCredentialStorageEnabled, getProperty, getQdata, getServiceWorkerRegistrationsDirectory, getTlsErrorsPolicy, getWebsqlDirectory.
Setters
setData, setDataFull, setItpEnabled, setNetworkProxySettings, setPersistentCredentialStorageEnabled, setProperty, setTlsErrorsPolicy.
clear
websiteDataManagerClear Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a, IsCancellable b) | |
=> a |
|
-> [WebsiteDataTypes] |
|
-> Int64 |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Asynchronously clear the website data of the given types
modified in the past timespan
.
If timespan
is 0, all website data will be removed.
When the operation is finished, callback
will be called. You can then call
websiteDataManagerClearFinish
to get the result of the operation.
Due to implementation limitations, this function does not currently delete
any stored cookies if timespan
is nonzero. This behavior may change in the
future.
Since: 2.16
clearFinish
websiteDataManagerClearFinish Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m () | (Can throw |
Finish an asynchronous operation started with websiteDataManagerClear
Since: 2.16
fetch
websiteDataManagerFetch Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a, IsCancellable b) | |
=> a |
|
-> [WebsiteDataTypes] |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Asynchronously get the list of WebsiteData
for the given types
.
When the operation is finished, callback
will be called. You can then call
websiteDataManagerFetchFinish
to get the result of the operation.
Since: 2.16
fetchFinish
websiteDataManagerFetchFinish Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m [WebsiteData] | Returns: a |
Finish an asynchronous operation started with websiteDataManagerFetch
.
Since: 2.16
getBaseCacheDirectory
websiteDataManagerGetBaseCacheDirectory Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> m (Maybe Text) | Returns: the base directory for Website cache, or |
Get the WebsiteDataManager:baseCacheDirectory property.
Since: 2.10
getBaseDataDirectory
websiteDataManagerGetBaseDataDirectory Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> m (Maybe Text) | Returns: the base directory for Website data, or |
Get the WebsiteDataManager:baseDataDirectory property.
Since: 2.10
getCookieManager
websiteDataManagerGetCookieManager Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> m CookieManager | Returns: a |
Get the CookieManager
of manager
.
Since: 2.16
getDiskCacheDirectory
websiteDataManagerGetDiskCacheDirectory Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> m (Maybe Text) | Returns: the directory where HTTP disk cache is stored or |
Get the WebsiteDataManager:diskCacheDirectory property.
Since: 2.10
getDomCacheDirectory
websiteDataManagerGetDomCacheDirectory Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> m (Maybe Text) | Returns: the directory where DOM cache is stored or |
Get the WebsiteDataManager:domCacheDirectory property.
Since: 2.30
getHstsCacheDirectory
websiteDataManagerGetHstsCacheDirectory Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> m (Maybe Text) | Returns: the directory where the HSTS cache is stored or |
Get the WebsiteDataManager:hstsCacheDirectory property.
Since: 2.26
getIndexeddbDirectory
websiteDataManagerGetIndexeddbDirectory Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> m (Maybe Text) | Returns: the directory where IndexedDB databases are stored or |
Get the WebsiteDataManager:indexeddbDirectory property.
Since: 2.10
getItpDirectory
websiteDataManagerGetItpDirectory Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> m (Maybe Text) | Returns: the directory where Intelligent Tracking Prevention data is stored or |
Get the WebsiteDataManager:itpDirectory property.
Since: 2.30
getItpEnabled
websiteDataManagerGetItpEnabled Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> m Bool |
Get whether Intelligent Tracking Prevention (ITP) is enabled or not.
Since: 2.30
getItpSummary
websiteDataManagerGetItpSummary Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a, IsCancellable b) | |
=> a |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Asynchronously get the list of ITPThirdParty
seen for manager
.
Every ITPThirdParty
contains the list of ITPFirstParty
under which it has been seen.
When the operation is finished, callback
will be called. You can then call
websiteDataManagerGetItpSummaryFinish
to get the result of the operation.
Since: 2.30
getItpSummaryFinish
websiteDataManagerGetItpSummaryFinish Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m [ITPThirdParty] | Returns: a |
Finish an asynchronous operation started with websiteDataManagerGetItpSummary
.
Since: 2.30
getLocalStorageDirectory
websiteDataManagerGetLocalStorageDirectory Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> m (Maybe Text) | Returns: the directory where local storage data is stored or |
Get the WebsiteDataManager:localStorageDirectory property.
Since: 2.10
getOfflineApplicationCacheDirectory
websiteDataManagerGetOfflineApplicationCacheDirectory Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> m (Maybe Text) | Returns: the directory where offline web application cache is stored or |
Get the WebsiteDataManager:offlineApplicationCacheDirectory property.
Since: 2.10
getPersistentCredentialStorageEnabled
websiteDataManagerGetPersistentCredentialStorageEnabled Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> m Bool | Returns: |
Get whether persistent credential storage is enabled or not.
See also websiteDataManagerSetPersistentCredentialStorageEnabled
.
Since: 2.30
getServiceWorkerRegistrationsDirectory
websiteDataManagerGetServiceWorkerRegistrationsDirectory Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> m (Maybe Text) | Returns: the directory where service worker registrations are stored or |
Get the WebsiteDataManager:serviceWorkerRegistrationsDirectory property.
Since: 2.30
getTlsErrorsPolicy
websiteDataManagerGetTlsErrorsPolicy Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> m TLSErrorsPolicy | Returns: a |
Get the TLS errors policy of manager
.
Since: 2.32
getWebsqlDirectory
websiteDataManagerGetWebsqlDirectory Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> m (Maybe Text) | Returns: the directory where WebSQL databases are stored or |
Deprecated: (Since version 2.24.)WebSQL is no longer supported. Use IndexedDB instead.
Get the WebsiteDataManager:websqlDirectory property.
Since: 2.10
isEphemeral
websiteDataManagerIsEphemeral Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> m Bool |
Get whether a WebsiteDataManager
is ephemeral.
See WebsiteDataManager:isEphemeral for more details.
Since: 2.16
newEphemeral
websiteDataManagerNewEphemeral Source #
:: (HasCallStack, MonadIO m) | |
=> m WebsiteDataManager | Returns: a new ephemeral |
Creates an ephemeral WebsiteDataManager
.
See WebsiteDataManager:isEphemeral for more details.
Since: 2.16
remove
websiteDataManagerRemove Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a, IsCancellable b) | |
=> a |
|
-> [WebsiteDataTypes] |
|
-> [WebsiteData] |
|
-> Maybe b |
|
-> Maybe AsyncReadyCallback |
|
-> m () |
Asynchronously removes the website data in the given websiteData
list.
Asynchronously removes the website data of the given types
for websites in the given websiteData
list.
Use websiteDataManagerClear
if you want to remove the website data for all sites.
When the operation is finished, callback
will be called. You can then call
websiteDataManagerRemoveFinish
to get the result of the operation.
Since: 2.16
removeFinish
websiteDataManagerRemoveFinish Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a, IsAsyncResult b) | |
=> a |
|
-> b |
|
-> m () | (Can throw |
Finish an asynchronous operation started with websiteDataManagerRemove
.
Since: 2.16
setItpEnabled
websiteDataManagerSetItpEnabled Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> Bool |
|
-> m () |
Enable or disable Intelligent Tracking Prevention (ITP).
When ITP is enabled resource load statistics
are collected and used to decide whether to allow or block third-party cookies and prevent user tracking.
Note that while ITP is enabled the accept policy CookieAcceptPolicyNoThirdParty
is ignored and
CookieAcceptPolicyAlways
is used instead. See also cookieManagerSetAcceptPolicy
.
Since: 2.30
setMemoryPressureSettings
websiteDataManagerSetMemoryPressureSettings Source #
:: (HasCallStack, MonadIO m) | |
=> MemoryPressureSettings |
|
-> m () |
Sets settings
as the MemoryPressureSettings
.
Sets settings
as the MemoryPressureSettings
to be used by all the network
processes created by any instance of WebsiteDataManager
after this function
is called.
Be sure to call this function before creating any WebsiteDataManager
, as network
processes of existing instances are not guaranteed to receive the passed settings.
The periodic check for used memory is disabled by default on network processes. This will
be enabled only if custom settings have been set using this function. After that, in order
to remove the custom settings and disable the periodic check, this function must be called
passing Nothing
as the value of settings
.
Since: 2.34
setNetworkProxySettings
websiteDataManagerSetNetworkProxySettings Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> NetworkProxyMode |
|
-> Maybe NetworkProxySettings |
|
-> m () |
Set the network proxy settings to be used by connections started in manager
session.
By default NetworkProxyModeDefault
is used, which means that the
system settings will be used (proxyResolverGetDefault
).
If you want to override the system default settings, you can either use
NetworkProxyModeNoProxy
to make sure no proxies are used at all,
or NetworkProxyModeCustom
to provide your own proxy settings.
When proxyMode
is NetworkProxyModeCustom
proxySettings
must be
a valid NetworkProxySettings
; otherwise, proxySettings
must be Nothing
.
Since: 2.32
setPersistentCredentialStorageEnabled
websiteDataManagerSetPersistentCredentialStorageEnabled Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> Bool |
|
-> m () |
Enable or disable persistent credential storage.
When enabled, which is the default for non-ephemeral sessions, the network process will try to read and write HTTP authentiacation credentials from persistent storage.
Since: 2.30
setTlsErrorsPolicy
websiteDataManagerSetTlsErrorsPolicy Source #
:: (HasCallStack, MonadIO m, IsWebsiteDataManager a) | |
=> a |
|
-> TLSErrorsPolicy |
|
-> m () |
Set the TLS errors policy of manager
as policy
.
Since: 2.32
Properties
baseCacheDirectory
The base directory for Website cache. This is used as a base directory for any Website cache when no specific cache directory has been provided.
Since: 2.10
constructWebsiteDataManagerBaseCacheDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “base-cache-directory
” property. This is rarely needed directly, but it is used by new
.
getWebsiteDataManagerBaseCacheDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text) Source #
Get the value of the “base-cache-directory
” property.
When overloading is enabled, this is equivalent to
get
websiteDataManager #baseCacheDirectory
baseDataDirectory
The base directory for Website data. This is used as a base directory for any Website data when no specific data directory has been provided.
Since: 2.10
constructWebsiteDataManagerBaseDataDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “base-data-directory
” property. This is rarely needed directly, but it is used by new
.
getWebsiteDataManagerBaseDataDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text) Source #
Get the value of the “base-data-directory
” property.
When overloading is enabled, this is equivalent to
get
websiteDataManager #baseDataDirectory
diskCacheDirectory
The directory where HTTP disk cache will be stored.
Since: 2.10
constructWebsiteDataManagerDiskCacheDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “disk-cache-directory
” property. This is rarely needed directly, but it is used by new
.
getWebsiteDataManagerDiskCacheDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text) Source #
Get the value of the “disk-cache-directory
” property.
When overloading is enabled, this is equivalent to
get
websiteDataManager #diskCacheDirectory
domCacheDirectory
The directory where DOM cache will be stored.
Since: 2.30
constructWebsiteDataManagerDomCacheDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “dom-cache-directory
” property. This is rarely needed directly, but it is used by new
.
getWebsiteDataManagerDomCacheDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text) Source #
Get the value of the “dom-cache-directory
” property.
When overloading is enabled, this is equivalent to
get
websiteDataManager #domCacheDirectory
hstsCacheDirectory
The directory where the HTTP Strict-Transport-Security (HSTS) cache will be stored.
Since: 2.26
constructWebsiteDataManagerHstsCacheDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “hsts-cache-directory
” property. This is rarely needed directly, but it is used by new
.
getWebsiteDataManagerHstsCacheDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text) Source #
Get the value of the “hsts-cache-directory
” property.
When overloading is enabled, this is equivalent to
get
websiteDataManager #hstsCacheDirectory
indexeddbDirectory
The directory where IndexedDB databases will be stored.
Since: 2.10
constructWebsiteDataManagerIndexeddbDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “indexeddb-directory
” property. This is rarely needed directly, but it is used by new
.
getWebsiteDataManagerIndexeddbDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text) Source #
Get the value of the “indexeddb-directory
” property.
When overloading is enabled, this is equivalent to
get
websiteDataManager #indexeddbDirectory
isEphemeral
Whether the WebsiteDataManager
is ephemeral. An ephemeral WebsiteDataManager
handles all websites data as non-persistent, and nothing will be written to the client
storage. Note that if you create an ephemeral WebsiteDataManager
all other construction
parameters to configure data directories will be ignored.
Since: 2.16
constructWebsiteDataManagerIsEphemeral :: (IsWebsiteDataManager o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “is-ephemeral
” property. This is rarely needed directly, but it is used by new
.
getWebsiteDataManagerIsEphemeral :: (MonadIO m, IsWebsiteDataManager o) => o -> m Bool Source #
Get the value of the “is-ephemeral
” property.
When overloading is enabled, this is equivalent to
get
websiteDataManager #isEphemeral
itpDirectory
The directory where Intelligent Tracking Prevention (ITP) data will be stored.
Since: 2.30
constructWebsiteDataManagerItpDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “itp-directory
” property. This is rarely needed directly, but it is used by new
.
getWebsiteDataManagerItpDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text) Source #
Get the value of the “itp-directory
” property.
When overloading is enabled, this is equivalent to
get
websiteDataManager #itpDirectory
localStorageDirectory
The directory where local storage data will be stored.
Since: 2.10
constructWebsiteDataManagerLocalStorageDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “local-storage-directory
” property. This is rarely needed directly, but it is used by new
.
getWebsiteDataManagerLocalStorageDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text) Source #
Get the value of the “local-storage-directory
” property.
When overloading is enabled, this is equivalent to
get
websiteDataManager #localStorageDirectory
offlineApplicationCacheDirectory
The directory where offline web application cache will be stored.
Since: 2.10
constructWebsiteDataManagerOfflineApplicationCacheDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “offline-application-cache-directory
” property. This is rarely needed directly, but it is used by new
.
getWebsiteDataManagerOfflineApplicationCacheDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text) Source #
Get the value of the “offline-application-cache-directory
” property.
When overloading is enabled, this is equivalent to
get
websiteDataManager #offlineApplicationCacheDirectory
serviceWorkerRegistrationsDirectory
The directory where service workers registrations will be stored.
Since: 2.30
constructWebsiteDataManagerServiceWorkerRegistrationsDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “service-worker-registrations-directory
” property. This is rarely needed directly, but it is used by new
.
getWebsiteDataManagerServiceWorkerRegistrationsDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text) Source #
Get the value of the “service-worker-registrations-directory
” property.
When overloading is enabled, this is equivalent to
get
websiteDataManager #serviceWorkerRegistrationsDirectory
websqlDirectory
The directory where WebSQL databases will be stored.
Since: 2.10
constructWebsiteDataManagerWebsqlDirectory :: (IsWebsiteDataManager o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “websql-directory
” property. This is rarely needed directly, but it is used by new
.
getWebsiteDataManagerWebsqlDirectory :: (MonadIO m, IsWebsiteDataManager o) => o -> m (Maybe Text) Source #
Get the value of the “websql-directory
” property.
When overloading is enabled, this is equivalent to
get
websiteDataManager #websqlDirectory