Package org.gnome.webkit

Class WebsiteDataManager

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.webkit.WebsiteDataManager

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public final class WebsiteDataManager
extends GObject

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebsiteDataManager.Builder<B extends WebsiteDataManager.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	WebsiteDataManager.WebsiteDataManagerClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
WebsiteDataManager(MemorySegment address)	Create a WebsiteDataManager proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected WebsiteDataManager	asParent()	Returns this instance as if it were its parent type.
static WebsiteDataManager.Builder<? extends WebsiteDataManager.Builder>	builder()	A WebsiteDataManager.Builder object constructs a WebsiteDataManager with the specified properties.
void	clear(Set<WebsiteDataTypes> types, TimeSpan timespan, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously clear the website data of the given types modified in the past timespan.
void	clear(WebsiteDataTypes types, TimeSpan timespan, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously clear the website data of the given types modified in the past timespan.
boolean	clearFinish(AsyncResult result)	Finish an asynchronous operation started with webkit_website_data_manager_clear()
void	fetch(Set<WebsiteDataTypes> types, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously get the list of WebKitWebsiteData for the given types.
void	fetch(WebsiteDataTypes types, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously get the list of WebKitWebsiteData for the given types.
List<WebsiteData>	fetchFinish(AsyncResult result)	Finish an asynchronous operation started with webkit_website_data_manager_fetch().
String	getBaseCacheDirectory()	Get the WebKitWebsiteDataManager:base-cache-directory property.
String	getBaseDataDirectory()	Get the WebKitWebsiteDataManager:base-data-directory property.
FaviconDatabase	getFaviconDatabase()	Get the WebKitFaviconDatabase of this WebsiteDataManager.
boolean	getFaviconsEnabled()	Get whether website icons are enabled.
void	getItpSummary(@Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously get the list of WebKitITPThirdParty seen for this WebsiteDataManager.
List<ITPThirdParty>	getItpSummaryFinish(AsyncResult result)	Finish an asynchronous operation started with webkit_website_data_manager_get_itp_summary().
static Type	getType()	Get the GType of the WebsiteDataManager class
boolean	isEphemeral()	Get whether a WebKitWebsiteDataManager is ephemeral.
void	remove(Set<WebsiteDataTypes> types, List<WebsiteData> websiteData, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously removes the website data in the given websiteData list.
void	remove(WebsiteDataTypes types, List<WebsiteData> websiteData, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously removes the website data in the given websiteData list.
boolean	removeFinish(AsyncResult result)	Finish an asynchronous operation started with webkit_website_data_manager_remove().
void	setFaviconsEnabled(boolean enabled)	Set whether website icons are enabled.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newInstance, newInstance, newv, notify_, notify_, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WebsiteDataManager

public WebsiteDataManager(MemorySegment address)

Create a WebsiteDataManager proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the WebsiteDataManager class

Returns:

the GType

asParent

protected WebsiteDataManager asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

clear

public void clear(Set<WebsiteDataTypes> types,
 TimeSpan timespan,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

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 webkit_website_data_manager_clear_finish() 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.

Parameters:

types - WebKitWebsiteDataTypes

timespan - a GTimeSpan

cancellable - a GCancellable or null to ignore

callback - a GAsyncReadyCallback to call when the request is satisfied

clear

public void clear(WebsiteDataTypes types,
 TimeSpan timespan,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

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 webkit_website_data_manager_clear_finish() 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.

Parameters:

types - WebKitWebsiteDataTypes

timespan - a GTimeSpan

cancellable - a GCancellable or null to ignore

callback - a GAsyncReadyCallback to call when the request is satisfied

clearFinish

public boolean clearFinish(AsyncResult result)
                    throws GErrorException

Finish an asynchronous operation started with webkit_website_data_manager_clear()

Parameters:

result - a GAsyncResult

Returns:

true if website data was successfully cleared, or false otherwise.

Throws:

GErrorException - see GError

fetch

public void fetch(Set<WebsiteDataTypes> types,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously get the list of WebKitWebsiteData for the given types.

When the operation is finished, callback will be called. You can then call webkit_website_data_manager_fetch_finish() to get the result of the operation.

Parameters:

types - WebKitWebsiteDataTypes

cancellable - a GCancellable or null to ignore

callback - a GAsyncReadyCallback to call when the request is satisfied

fetch

public void fetch(WebsiteDataTypes types,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously get the list of WebKitWebsiteData for the given types.

When the operation is finished, callback will be called. You can then call webkit_website_data_manager_fetch_finish() to get the result of the operation.

Parameters:

types - WebKitWebsiteDataTypes

cancellable - a GCancellable or null to ignore

callback - a GAsyncReadyCallback to call when the request is satisfied

fetchFinish

public List<WebsiteData> fetchFinish(AsyncResult result)
                              throws GErrorException

Finish an asynchronous operation started with webkit_website_data_manager_fetch().

Parameters:

result - a GAsyncResult

Returns:

a GList of WebKitWebsiteData. You must free the GList with g_list_free() and unref the WebKitWebsiteData<!-- -->s with webkit_website_data_unref() when you're done with them.

Throws:

GErrorException - see GError

getBaseCacheDirectory

public String getBaseCacheDirectory()

Get the WebKitWebsiteDataManager:base-cache-directory property.

Returns:

the base directory for caches, or null if WebKitWebsiteDataManager:base-cache-directory was not provided or this WebsiteDataManager is ephemeral.

getBaseDataDirectory

public String getBaseDataDirectory()

Get the WebKitWebsiteDataManager:base-data-directory property.

Returns:

the base directory for website data, or null if WebKitWebsiteDataManager:base-data-directory was not provided or this WebsiteDataManager is ephemeral.

getFaviconDatabase

public FaviconDatabase getFaviconDatabase()

Get the WebKitFaviconDatabase of this WebsiteDataManager.

Returns:

a WebKitFaviconDatabase, or null if website icons are disabled

getFaviconsEnabled

public boolean getFaviconsEnabled()

Get whether website icons are enabled.

Returns:

true if website icons are enabled, or false otherwise.

getItpSummary

public void getItpSummary(@Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

Asynchronously get the list of WebKitITPThirdParty seen for this WebsiteDataManager.

Every WebKitITPThirdParty contains the list of WebKitITPFirstParty under which it has been seen.

When the operation is finished, callback will be called. You can then call webkit_website_data_manager_get_itp_summary_finish() to get the result of the operation.

Parameters:

cancellable - a GCancellable or null to ignore

callback - a GAsyncReadyCallback to call when the request is satisfied

getItpSummaryFinish

public List<ITPThirdParty> getItpSummaryFinish(AsyncResult result)
                                        throws GErrorException

Finish an asynchronous operation started with webkit_website_data_manager_get_itp_summary().

Parameters:

result - a GAsyncResult

Returns:

a GList of WebKitITPThirdParty. You must free the GList with g_list_free() and unref the WebKitITPThirdParty<!-- -->s with webkit_itp_third_party_unref() when you're done with them.

Throws:

GErrorException - see GError

isEphemeral

public boolean isEphemeral()

Get whether a WebKitWebsiteDataManager is ephemeral.

See WebKitWebsiteDataManager:is-ephemeral for more details.

Returns:

true if this WebsiteDataManager is ephemeral or false otherwise.

remove

public void remove(Set<WebsiteDataTypes> types,
 List<WebsiteData> websiteData,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

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 webkit_website_data_manager_clear() if you want to remove the website data for all sites.

When the operation is finished, callback will be called. You can then call webkit_website_data_manager_remove_finish() to get the result of the operation.

Parameters:

types - WebKitWebsiteDataTypes

websiteData - a GList of WebKitWebsiteData

cancellable - a GCancellable or null to ignore

callback - a GAsyncReadyCallback to call when the request is satisfied

remove

public void remove(WebsiteDataTypes types,
 List<WebsiteData> websiteData,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

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 webkit_website_data_manager_clear() if you want to remove the website data for all sites.

When the operation is finished, callback will be called. You can then call webkit_website_data_manager_remove_finish() to get the result of the operation.

Parameters:

types - WebKitWebsiteDataTypes

websiteData - a GList of WebKitWebsiteData

cancellable - a GCancellable or null to ignore

callback - a GAsyncReadyCallback to call when the request is satisfied

removeFinish

public boolean removeFinish(AsyncResult result)
                     throws GErrorException

Finish an asynchronous operation started with webkit_website_data_manager_remove().

Parameters:

result - a GAsyncResult

Returns:

true if website data resources were successfully removed, or false otherwise.

Throws:

GErrorException - see GError

setFaviconsEnabled

public void setFaviconsEnabled(boolean enabled)

Set whether website icons are enabled. Website icons are disabled by default. When website icons are disabled, the WebKitFaviconDatabase of this WebsiteDataManager 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.

Parameters:

enabled - value to set

builder

public static WebsiteDataManager.Builder<? extends WebsiteDataManager.Builder> builder()

A WebsiteDataManager.Builder object constructs a WebsiteDataManager with the specified properties. Use the various set...() methods to set properties, and finish construction with WebsiteDataManager.Builder.build().