webkit/org.gtkkn.bindings.webkit/WebsiteDataManager

WebsiteDataManager

class WebsiteDataManager(pointer: <Error class: unknown class><<Error class: unknown class>>)

Manages data stored locally by web sites.

You can use WebKitWebsiteDataManager to configure the local directories where website data will be stored. Use #WebKitWebsiteDataManager:base-data-directory and #WebKitWebsiteDataManager:base-cache-directory set a common base directory for all website data and caches.

A WebKitWebsiteDataManager can be ephemeral, in which case all the directory configuration is not needed because website data will never persist. You can create an ephemeral WebKitWebsiteDataManager with webkit_website_data_manager_new_ephemeral().

WebKitWebsiteDataManager can also be used to fetch website data, remove data stored by particular websites, or clear data for all websites modified since a given period of time.

Skipped during bindings generation

method is-ephemeral: Property has no getter nor setter
method origin-storage-ratio: Property has no getter nor setter
method total-storage-ratio: Property has no getter nor setter

Since

2.10

Constructors

WebsiteDataManager

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

baseCacheDirectory

val baseCacheDirectory: String?

The base directory for caches. If null, a default location will be used.

baseDataDirectory

val baseDataDirectory: String?

The base directory for website data. If null, a default location will be used.

webkitWebsiteDataManagerPointer

val webkitWebsiteDataManagerPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

clear

fun clear(types: WebsiteDataTypes, timespan: <Error class: unknown class>, cancellable: <Error class: unknown class>? = null, callback: <Error class: unknown class>?)

Asynchronously clear the website data of the given @types modified in the past @timespan.

clearFinish

fun clearFinish(result: <Error class: unknown class>): <Error class: unknown class><Boolean>

Finish an asynchronous operation started with webkit_website_data_manager_clear()

fetch

fun fetch(types: WebsiteDataTypes, cancellable: <Error class: unknown class>? = null, callback: <Error class: unknown class>?)

Asynchronously get the list of #WebKitWebsiteData for the given @types.

fetchFinish

fun fetchFinish(result: <Error class: unknown class>): <Error class: unknown class><<Error class: unknown class>>

Finish an asynchronous operation started with webkit_website_data_manager_fetch().

getFaviconDatabase

fun getFaviconDatabase(): FaviconDatabase?

Get the #WebKitFaviconDatabase of @manager.

getFaviconsEnabled

fun getFaviconsEnabled(): Boolean

Get whether website icons are enabled.

getItpSummary

fun getItpSummary(cancellable: <Error class: unknown class>? = null, callback: <Error class: unknown class>?)

Asynchronously get the list of #WebKitITPThirdParty seen for @manager.

getItpSummaryFinish

fun getItpSummaryFinish(result: <Error class: unknown class>): <Error class: unknown class><<Error class: unknown class>>

Finish an asynchronous operation started with webkit_website_data_manager_get_itp_summary().

isEphemeral

fun isEphemeral(): Boolean

Get whether a #WebKitWebsiteDataManager is ephemeral.

remove

fun remove(types: WebsiteDataTypes, websiteData: <Error class: unknown class>, cancellable: <Error class: unknown class>? = null, callback: <Error class: unknown class>?)

Asynchronously removes the website data in the given @website_data list.

removeFinish

fun removeFinish(result: <Error class: unknown class>): <Error class: unknown class><Boolean>

Finish an asynchronous operation started with webkit_website_data_manager_remove().

setFaviconsEnabled

fun setFaviconsEnabled(enabled: Boolean)

Set whether website icons are enabled. Website icons are disabled by default. When website icons are disabled, the #WebKitFaviconDatabase of @manager is closed and its reference removed, so webkit_website_data_manager_get_favicon_database() will return null. If website icons are enabled again, a new #WebKitFaviconDatabase will be created.