Class WebsiteData

java.lang.Object
org.javagi.base.ProxyInstance
org.webkitgtk.WebsiteData
All Implemented Interfaces:
Proxy
@Generated("org.javagi.JavaGI") public class WebsiteData extends ProxyInstance

Data stored locally by a web site.

WebKitWebsiteData represents data stored in the client by a particular website. A website is normally a set of URLs grouped by domain name. You can get the website name, which is usually the domain, with webkit_website_data_get_name(). Documents loaded from the file system, like file:// URIs, are all grouped in the same WebKitWebsiteData with the name "Local files".

A website can store different types of data in the client side. WebKitWebsiteDataTypes is an enum containing all the possible data types; use webkit_website_data_get_types() to get the bitmask of data types. It's also possible to know the size of the data stored for some of the WebKitWebsiteDataTypes by using webkit_website_data_get_size().

A list of WebKitWebsiteData can be retrieved with webkit_website_data_manager_fetch(). See WebKitWebsiteDataManager for more information.

Since:
2.16

  • Constructor Details

    • WebsiteData

      public WebsiteData(MemorySegment address)
      Create a WebsiteData proxy instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the WebsiteData class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • getName

      public String getName()

      Gets the name of WebKitWebsiteData.

      This is the website name, normally represented by a domain or host name. All local documents are grouped in the same WebKitWebsiteData using the name "Local files".

      Returns:
      the website name of websiteData.
      Since:
      2.16

    • getSize

      public long getSize(Set<WebsiteDataTypes> types)

      Gets the size of the data of types types in a WebKitWebsiteData.

      Note that currently the data size is only known for WebsiteDataTypes.DISK_CACHE data type so for all other types 0 will be returned.

      Parameters:
      types - a bitmask of WebKitWebsiteDataTypes
      Returns:
      the size of this WebsiteData for the given types.
      Since:
      2.16

    • getSize

      public long getSize(WebsiteDataTypes... types)

      Gets the size of the data of types types in a WebKitWebsiteData.

      Note that currently the data size is only known for WebsiteDataTypes.DISK_CACHE data type so for all other types 0 will be returned.

      Parameters:
      types - a bitmask of WebKitWebsiteDataTypes
      Returns:
      the size of this WebsiteData for the given types.
      Since:
      2.16

    • getTypes

      public Set<WebsiteDataTypes> getTypes()

      Gets the types of data stored in the client for a WebKitWebsiteData.

      These are the types actually present, not the types queried with webkit_website_data_manager_fetch().

      Returns:
      a bitmask of WebKitWebsiteDataTypes in this WebsiteData
      Since:
      2.16

    • ref

      public WebsiteData ref()

      Atomically increments the reference count of this WebsiteData by one.

      This function is MT-safe and may be called from any thread.

      Returns:
      The passed WebKitWebsiteData
      Since:
      2.16

    • unref

      public void unref()

      Atomically decrements the reference count of this WebsiteData by one.

      If the reference count drops to 0, all memory allocated by WebKitWebsiteData is released. This function is MT-safe and may be called from any thread.

      Since:
      2.16