GI.WebKit2.Objects.WebsiteDataManager

No description available in the introspection data.

Exported types

newtype WebsiteDataManager

Memory-managed wrapper type.

Constructors

WebsiteDataManager (ManagedPtr WebsiteDataManager)

Instances

GObject WebsiteDataManager

Defined in GI.WebKit2.Objects.WebsiteDataManager

Methods

gobjectType :: IO GType

HasParentTypes WebsiteDataManager

Defined in GI.WebKit2.Objects.WebsiteDataManager

type ParentTypes WebsiteDataManager

Defined in GI.WebKit2.Objects.WebsiteDataManager

type ParentTypes WebsiteDataManager = Object ': ([] :: [Type])

class (GObject o, IsDescendantOf WebsiteDataManager o) => IsWebsiteDataManager o

Type class for types which can be safely cast to WebsiteDataManager, for instance with toWebsiteDataManager.

Instances

(GObject o, IsDescendantOf WebsiteDataManager o) => IsWebsiteDataManager o

Defined in GI.WebKit2.Objects.WebsiteDataManager

toWebsiteDataManager :: (MonadIO m, IsWebsiteDataManager o) => o -> m WebsiteDataManager

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

noWebsiteDataManager :: Maybe WebsiteDataManager

A convenience alias for Nothing :: Maybe WebsiteDataManager.

Methods

clear

websiteDataManagerClear

Arguments

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

=> a

manager: a WebsiteDataManager

-> [WebsiteDataTypes]

types: WebsiteDataTypes

-> Int64

timespan: a GTimeSpan

-> Maybe b

cancellable: a Cancellable or Nothing to ignore

-> Maybe AsyncReadyCallback

callback: a AsyncReadyCallback to call when the request is satisfied

-> 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

Arguments

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

=> a

manager: a WebsiteDataManager

-> b

result: a AsyncResult

-> m ()

(Can throw GError)

Finish an asynchronous operation started with websiteDataManagerClear

Since: 2.16

fetch

websiteDataManagerFetch

Arguments

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

=> a

manager: a WebsiteDataManager

-> [WebsiteDataTypes]

types: WebsiteDataTypes

-> 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 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

Arguments

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

=> a

manager: a WebsiteDataManager

-> b

result: a AsyncResult

-> m [WebsiteData]

Returns: a List of WebsiteData. You must free the List with g_list_free() and unref the WebsiteData<!-- -->s with websiteDataUnref when you're done with them. (Can throw GError)

Finish an asynchronous operation started with websiteDataManagerFetch.

Since: 2.16

getBaseCacheDirectory

websiteDataManagerGetBaseCacheDirectory

Arguments

:: (HasCallStack, MonadIO m, IsWebsiteDataManager a)

=> a

manager: a WebsiteDataManager

-> m (Maybe Text)

Returns: the base directory for Website cache, or Nothing if WebsiteDataManager:base-cache-directory was not provided or manager is ephemeral.

Get the WebsiteDataManager:base-cache-directory property.

Since: 2.10

getBaseDataDirectory

websiteDataManagerGetBaseDataDirectory

Arguments

:: (HasCallStack, MonadIO m, IsWebsiteDataManager a)

=> a

manager: a WebsiteDataManager

-> m (Maybe Text)

Returns: the base directory for Website data, or Nothing if WebsiteDataManager:base-data-directory was not provided or manager is ephemeral.

Get the WebsiteDataManager:base-data-directory property.

Since: 2.10

getCookieManager

websiteDataManagerGetCookieManager

Arguments

:: (HasCallStack, MonadIO m, IsWebsiteDataManager a)

=> a

manager: a WebsiteDataManager

-> m CookieManager

Returns: a CookieManager

Get the CookieManager of manager.

Since: 2.16

getDiskCacheDirectory

websiteDataManagerGetDiskCacheDirectory

Arguments

:: (HasCallStack, MonadIO m, IsWebsiteDataManager a)

=> a

manager: a WebsiteDataManager

-> m (Maybe Text)

Returns: the directory where HTTP disk cache is stored or Nothing if manager is ephemeral.

Get the WebsiteDataManager:disk-cache-directory property.

Since: 2.10

getIndexeddbDirectory

websiteDataManagerGetIndexeddbDirectory

Arguments

:: (HasCallStack, MonadIO m, IsWebsiteDataManager a)

=> a

manager: a WebsiteDataManager

-> m (Maybe Text)

Returns: the directory where IndexedDB databases are stored or Nothing if manager is ephemeral.

Get the WebsiteDataManager:indexeddb-directory property.

Since: 2.10

getLocalStorageDirectory

websiteDataManagerGetLocalStorageDirectory

Arguments

:: (HasCallStack, MonadIO m, IsWebsiteDataManager a)

=> a

manager: a WebsiteDataManager

-> m (Maybe Text)

Returns: the directory where local storage data is stored or Nothing if manager is ephemeral.

Get the WebsiteDataManager:local-storage-directory property.

Since: 2.10

getOfflineApplicationCacheDirectory

websiteDataManagerGetOfflineApplicationCacheDirectory

Arguments

:: (HasCallStack, MonadIO m, IsWebsiteDataManager a)

=> a

manager: a WebsiteDataManager

-> m (Maybe Text)

Returns: the directory where offline web application cache is stored or Nothing if manager is ephemeral.

Get the WebsiteDataManager:offline-application-cache-directory property.

Since: 2.10

getWebsqlDirectory

websiteDataManagerGetWebsqlDirectory

Arguments

:: (HasCallStack, MonadIO m, IsWebsiteDataManager a)

=> a

manager: a WebsiteDataManager

-> m (Maybe Text)

Returns: the directory where WebSQL databases are stored or Nothing if manager is ephemeral.

Get the WebsiteDataManager:websql-directory property.

Since: 2.10

isEphemeral

websiteDataManagerIsEphemeral

Arguments

:: (HasCallStack, MonadIO m, IsWebsiteDataManager a)

=> a

manager: a WebsiteDataManager

-> m Bool

Returns: True if manager is epheral or False otherwise.

Get whether a WebsiteDataManager is ephemeral. See WebsiteDataManager:is-ephemeral for more details.

Since: 2.16

newEphemeral

websiteDataManagerNewEphemeral

Arguments

:: (HasCallStack, MonadIO m)

=> m WebsiteDataManager

Returns: a new ephemeral WebsiteDataManager.

Creates an ephemeral WebsiteDataManager. See WebsiteDataManager:is-ephemeral for more details.

Since: 2.16

remove

websiteDataManagerRemove

Arguments

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

=> a

manager: a WebsiteDataManager

-> [WebsiteDataTypes]

types: WebsiteDataTypes

-> [WebsiteData]

websiteData: a List of WebsiteData

-> Maybe b

cancellable: a Cancellable or Nothing to ignore

-> Maybe AsyncReadyCallback

callback: a AsyncReadyCallback to call when the request is satisfied

-> m ()

Asynchronously removes the website data of the for 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

Arguments

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

=> a

manager: a WebsiteDataManager

-> b

result: a AsyncResult

-> m ()

(Can throw GError)

Finish an asynchronous operation started with websiteDataManagerRemove.

Since: 2.16

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 => Text -> IO (GValueConstruct o)

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)

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 => Text -> IO (GValueConstruct o)

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)

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 => Text -> IO (GValueConstruct o)

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)

Get the value of the “disk-cache-directory” property. When overloading is enabled, this is equivalent to

get websiteDataManager #diskCacheDirectory

indexeddbDirectory

The directory where IndexedDB databases will be stored.

Since: 2.10

constructWebsiteDataManagerIndexeddbDirectory :: IsWebsiteDataManager o => Text -> IO (GValueConstruct o)

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)

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 => Bool -> IO (GValueConstruct o)

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

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

get websiteDataManager #isEphemeral

localStorageDirectory

The directory where local storage data will be stored.

Since: 2.10

constructWebsiteDataManagerLocalStorageDirectory :: IsWebsiteDataManager o => Text -> IO (GValueConstruct o)

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)

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 => Text -> IO (GValueConstruct o)

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)

Get the value of the “offline-application-cache-directory” property. When overloading is enabled, this is equivalent to

get websiteDataManager #offlineApplicationCacheDirectory

websqlDirectory

The directory where WebSQL databases will be stored.

Since: 2.10

constructWebsiteDataManagerWebsqlDirectory :: IsWebsiteDataManager o => Text -> IO (GValueConstruct o)

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)

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

get websiteDataManager #websqlDirectory