WebKitWebsiteDataManager

WebKitWebsiteDataManager — Website data manager

Functions

WebKitWebsiteDataManager * webkit_website_data_manager_new ()
WebKitWebsiteDataManager * webkit_website_data_manager_new_ephemeral ()
gboolean webkit_website_data_manager_is_ephemeral ()
const gchar * webkit_website_data_manager_get_base_data_directory ()
const gchar * webkit_website_data_manager_get_base_cache_directory ()
const gchar * webkit_website_data_manager_get_local_storage_directory ()
const gchar * webkit_website_data_manager_get_disk_cache_directory ()
const gchar * webkit_website_data_manager_get_offline_application_cache_directory ()
const gchar * webkit_website_data_manager_get_indexeddb_directory ()
const gchar * webkit_website_data_manager_get_websql_directory ()
const gchar * webkit_website_data_manager_get_hsts_cache_directory ()
const gchar * webkit_website_data_manager_get_itp_directory ()
const gchar * webkit_website_data_manager_get_service_worker_registrations_directory ()
const gchar * webkit_website_data_manager_get_dom_cache_directory ()
WebKitCookieManager * webkit_website_data_manager_get_cookie_manager ()
void webkit_website_data_manager_set_itp_enabled ()
gboolean webkit_website_data_manager_get_itp_enabled ()
void webkit_website_data_manager_set_persistent_credential_storage_enabled ()
gboolean webkit_website_data_manager_get_persistent_credential_storage_enabled ()
void webkit_website_data_manager_set_tls_errors_policy ()
WebKitTLSErrorsPolicy webkit_website_data_manager_get_tls_errors_policy ()
void webkit_website_data_manager_set_network_proxy_settings ()
void webkit_website_data_manager_fetch ()
GList * webkit_website_data_manager_fetch_finish ()
void webkit_website_data_manager_remove ()
gboolean webkit_website_data_manager_remove_finish ()
void webkit_website_data_manager_clear ()
gboolean webkit_website_data_manager_clear_finish ()
void webkit_website_data_manager_set_memory_pressure_settings ()
WebKitITPFirstParty * webkit_itp_first_party_ref ()
void webkit_itp_first_party_unref ()
const char * webkit_itp_first_party_get_domain ()
gboolean webkit_itp_first_party_get_website_data_access_allowed ()
GDateTime * webkit_itp_first_party_get_last_update_time ()
WebKitITPThirdParty * webkit_itp_third_party_ref ()
void webkit_itp_third_party_unref ()
const char * webkit_itp_third_party_get_domain ()
GList * webkit_itp_third_party_get_first_parties ()
void webkit_website_data_manager_get_itp_summary ()
GList * webkit_website_data_manager_get_itp_summary_finish ()

Properties

gchar * base-cache-directory Read / Write / Construct Only
gchar * base-data-directory Read / Write / Construct Only
gchar * disk-cache-directory Read / Write / Construct Only
gchar * dom-cache-directory Read / Write / Construct Only
gchar * hsts-cache-directory Read / Write / Construct Only
gchar * indexeddb-directory Read / Write / Construct Only
gboolean is-ephemeral Read / Write / Construct Only
gchar * itp-directory Read / Write / Construct Only
gchar * local-storage-directory Read / Write / Construct Only
gchar * offline-application-cache-directory Read / Write / Construct Only
gchar * service-worker-registrations-directory Read / Write / Construct Only
gchar * websql-directory Read / Write / Construct Only

Types and Values

Object Hierarchy

    GBoxed
    ├── WebKitITPFirstParty
    ╰── WebKitITPThirdParty
    GObject
    ╰── WebKitWebsiteDataManager

Description

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. “base-data-directory” and “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.

Functions

webkit_website_data_manager_new ()

WebKitWebsiteDataManager *
webkit_website_data_manager_new (const gchar *first_option_name,
                                 ...);

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

Parameters

first_option_name

name of the first option to set

 

...

value of first option, followed by more options, NULL-terminated

 

Returns

the newly created WebKitWebsiteDataManager.

[transfer full]

Since: 2.10


webkit_website_data_manager_new_ephemeral ()

WebKitWebsiteDataManager *
webkit_website_data_manager_new_ephemeral
                               (void);

Creates an ephemeral WebKitWebsiteDataManager. See “is-ephemeral” for more details.

Returns

a new ephemeral WebKitWebsiteDataManager.

[transfer full]

Since: 2.16


webkit_website_data_manager_is_ephemeral ()

gboolean
webkit_website_data_manager_is_ephemeral
                               (WebKitWebsiteDataManager *manager);

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

Parameters

Returns

TRUE if manager is ephemeral or FALSE otherwise.

Since: 2.16


webkit_website_data_manager_get_base_data_directory ()

const gchar *
webkit_website_data_manager_get_base_data_directory
                               (WebKitWebsiteDataManager *manager);

Get the “base-data-directory” property.

Parameters

Returns

the base directory for Website data, or