Class

WebKit2WebsiteDataManager

Description [src] 

class WebKit2.WebsiteDataManager : GObject.Object {
  parent: GObject
}

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. WebKitWebsiteDataManager:base-data-directory and WebKitWebsiteDataManager:base-cache-directory 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 WebKitWebContext, you can use webkit_web_context_new_with_website_data_manager() to create a new WebKitWebContext with a WebKitWebsiteDataManager. In case you don’t want to set any specific configuration, you don’t need to create a WebKitWebsiteDataManager, the WebKitWebContext will create a WebKitWebsiteDataManager with the default configuration. To get the WebKitWebsiteDataManager of a WebKitWebContext you can use webkit_web_context_get_website_data_manager().

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 webkit_website_data_manager_new_ephemeral(). Then you can pass an ephemeral WebKitWebsiteDataManager to a WebKitWebContext to make it ephemeral or use webkit_web_context_new_ephemeral() and the WebKitWebsiteDataManager will be automatically created by the WebKitWebContext.

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.

Available since:2.10

Hierarchy

hierarchy this WebKitWebsiteDataManager ancestor_0 GObject ancestor_0--this

Ancestors

Constructors

webkit_website_data_manager_new

Creates a new WebKitWebsiteDataManager with the given options. It must be passed as construction parameter of a WebKitWebContext.

Available since: 2.10

webkit_website_data_manager_new_ephemeral

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

Available since: 2.16

Functions

webkit_website_data_manager_set_memory_pressure_settings

Sets settings as the WebKitMemoryPressureSettings to be used by all the network processes created by any instance of WebKitWebsiteDataManager after this function is called.

Available since: 2.34

Instance methods

webkit_website_data_manager_clear

Asynchronously clear the website data of the given types modified in the past timespan. If timespan is 0, all website data will be removed.

Available since: 2.16

webkit_website_data_manager_clear_finish

Finish an asynchronous operation started with webkit_website_data_manager_clear()

Available since: 2.16

webkit_website_data_manager_fetch

Asynchronously get the list of WebKitWebsiteData for the given types.

Available since: 2.16

webkit_website_data_manager_fetch_finish

Finish an asynchronous operation started with webkit_website_data_manager_fetch().

Available since: 2.16

webkit_website_data_manager_get_base_cache_directory

Get the WebKitWebsiteDataManager:base-cache-directory property.

Available since: 2.10

webkit_website_data_manager_get_base_data_directory

Get the WebKitWebsiteDataManager:base-data-directory property.

Available since: 2.10

webkit_website_data_manager_get_cookie_manager

Get the WebKitCookieManager of manager.

Available since: 2.16

webkit_website_data_manager_get_disk_cache_directory

Get the WebKitWebsiteDataManager:disk-cache-directory property.

Available since: 2.10

webkit_website_data_manager_get_dom_cache_directory

Get the WebKitWebsiteDataManager:dom-cache-directory property.

Available since: 2.30

webkit_website_data_manager_get_hsts_cache_directory

Get the WebKitWebsiteDataManager:hsts-cache-directory property.

Available since: 2.26

webkit_website_data_manager_get_indexeddb_directory

Get the WebKitWebsiteDataManager:indexeddb-directory property.

Available since: 2.10

webkit_website_data_manager_get_itp_directory

Get the WebKitWebsiteDataManager:itp-directory property.

Available since: 2.30

webkit_website_data_manager_get_itp_enabled

Get whether Intelligent Tracking Prevention (ITP) is enabled or not.

Available since: 2.30

webkit_website_data_manager_get_itp_summary

Asynchronously get the list of WebKitITPThirdParty seen for manager. Every WebKitITPThirdParty contains the list of WebKitITPFirstParty under which it has been seen.

Available since: 2.30

webkit_website_data_manager_get_itp_summary_finish

Finish an asynchronous operation started with webkit_website_data_manager_get_itp_summary().

Available since: 2.30

webkit_website_data_manager_get_local_storage_directory

Get the WebKitWebsiteDataManager:local-storage-directory property.

Available since: 2.10

webkit_website_data_manager_get_offline_application_cache_directory

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

Available since: 2.10

webkit_website_data_manager_get_persistent_credential_storage_enabled

Get whether persistent credential storage is enabled or not. See also webkit_website_data_manager_set_persistent_credential_storage_enabled().

Available since: 2.30

webkit_website_data_manager_get_service_worker_registrations_directory

Get the WebKitWebsiteDataManager:service-worker-registrations-directory property.

Available since: 2.30

webkit_website_data_manager_get_tls_errors_policy

Get the TLS errors policy of manager.

Available since: 2.32

webkit_website_data_manager_get_websql_directory

Get the WebKitWebsiteDataManager:websql-directory property.

Available since: 2.10

Deprecated since: 2.24.

webkit_website_data_manager_is_ephemeral

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

Available since: 2.16

webkit_website_data_manager_remove

Asynchronously removes the website data of the for the given types for websites in the given website_data list. Use webkit_website_data_manager_clear() if you want to remove the website data for all sites.

Available since: 2.16

webkit_website_data_manager_remove_finish

Finish an asynchronous operation started with webkit_website_data_manager_remove().

Available since: 2.16

webkit_website_data_manager_set_itp_enabled

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 WEBKIT_COOKIE_POLICY_ACCEPT_NO_THIRD_PARTY is ignored and WEBKIT_COOKIE_POLICY_ACCEPT_ALWAYS is used instead. See also webkit_cookie_manager_set_accept_policy().

Available since: 2.30

webkit_website_data_manager_set_network_proxy_settings

Set the network proxy settings to be used by connections started in manager session. By default WEBKIT_NETWORK_PROXY_MODE_DEFAULT is used, which means that the system settings will be used (g_proxy_resolver_get_default()). If you want to override the system default settings, you can either use WEBKIT_NETWORK_PROXY_MODE_NO_PROXY to make sure no proxies are used at all, or WEBKIT_NETWORK_PROXY_MODE_CUSTOM to provide your own proxy settings. When proxy_mode is WEBKIT_NETWORK_PROXY_MODE_CUSTOM proxy_settings must be a valid WebKitNetworkProxySettings; otherwise, proxy_settings must be NULL.

Available since: 2.32

webkit_website_data_manager_set_persistent_credential_storage_enabled

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.

Available since: 2.30

webkit_website_data_manager_set_tls_errors_policy

Set the TLS errors policy of manager as policy.

Available since: 2.32

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Properties

WebKit2.WebsiteDataManager:base-cache-directory

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.

Available since: 2.10

WebKit2.WebsiteDataManager:base-data-directory

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.

Available since: 2.10

WebKit2.WebsiteDataManager:disk-cache-directory

The directory where HTTP disk cache will be stored.

Available since: 2.10

WebKit2.WebsiteDataManager:dom-cache-directory

The directory where DOM cache will be stored.

Available since: 2.30

WebKit2.WebsiteDataManager:hsts-cache-directory

The directory where the HTTP Strict-Transport-Security (HSTS) cache will be stored.

Available since: 2.26

WebKit2.WebsiteDataManager:indexeddb-directory

The directory where IndexedDB databases will be stored.

Available since: 2.10

WebKit2.WebsiteDataManager:is-ephemeral

Whether the WebKitWebsiteDataManager is ephemeral. An ephemeral WebKitWebsiteDataManager handles all websites data as non-persistent, and nothing will be written to the client storage. Note that if you create an ephemeral WebKitWebsiteDataManager all other construction parameters to configure data directories will be ignored.

Available since: 2.16

WebKit2.WebsiteDataManager:itp-directory

The directory where Intelligent Tracking Prevention (ITP) data will be stored.

Available since: 2.30

WebKit2.WebsiteDataManager:local-storage-directory

The directory where local storage data will be stored.

Available since: 2.10

WebKit2.WebsiteDataManager:offline-application-cache-directory

The directory where offline web application cache will be stored.

Available since: 2.10

WebKit2.WebsiteDataManager:service-worker-registrations-directory

The directory where service workers registrations will be stored.

Available since: 2.30

WebKit2.WebsiteDataManager:websql-directory

The directory where WebSQL databases will be stored.

Available since: 2.10

Deprecated since: 2.24.

Signals

Signals inherited from GObject (1)
GObject.Object::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure 

struct WebKit2WebsiteDataManagerClass {
  GObjectClass parent_class;
  void (* _webkit_reserved0) (
void
  );
  void (* _webkit_reserved1) (
void
  );
  void (* _webkit_reserved2) (
void
  );
  void (* _webkit_reserved3) (
void
  );
  
}
No description available.
Class members
parent_class 
GObjectClass
  No description available.
_webkit_reserved0 
void (* _webkit_reserved0) (
void
  )
  No description available.
_webkit_reserved1 
void (* _webkit_reserved1) (
void
  )
  No description available.
_webkit_reserved2 
void (* _webkit_reserved2) (
void
  )
  No description available.
_webkit_reserved3 
void (* _webkit_reserved3) (
void
  )
  No description available.