GI.WebKit2.Structs.WebsiteData

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 websiteDataGetName. 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. WebsiteDataTypes is an enum containing all the possible data types; use websiteDataGetTypes to get the bitmask of data types. It's also possible to know the size of the data stored for some of the WebsiteDataTypes by using websiteDataGetSize.

A list of WebKitWebsiteData can be retrieved with websiteDataManagerFetch. See WebsiteDataManager for more information.

Since: 2.16

Exported types

newtype WebsiteData

Memory-managed wrapper type.

Constructors

WebsiteData (ManagedPtr WebsiteData)

Instances

Eq WebsiteData

Defined in GI.WebKit2.Structs.WebsiteData

Methods

(==) :: WebsiteData -> WebsiteData -> Bool

(/=) :: WebsiteData -> WebsiteData -> Bool

GBoxed WebsiteData

Defined in GI.WebKit2.Structs.WebsiteData

ManagedPtrNewtype WebsiteData

Defined in GI.WebKit2.Structs.WebsiteData

Methods

toManagedPtr :: WebsiteData -> ManagedPtr WebsiteData

TypedObject WebsiteData

Defined in GI.WebKit2.Structs.WebsiteData

Methods

glibType :: IO GType

HasParentTypes WebsiteData

Defined in GI.WebKit2.Structs.WebsiteData

IsGValue (Maybe WebsiteData)

Convert WebsiteData to and from GValue. See toGValue and fromGValue.

Defined in GI.WebKit2.Structs.WebsiteData

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe WebsiteData -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe WebsiteData)

type ParentTypes WebsiteData

Defined in GI.WebKit2.Structs.WebsiteData

type ParentTypes WebsiteData = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Methods

ref, unref.

Getters

getName, getSize, getTypes.

Setters

None.

getName

websiteDataGetName

Arguments

:: (HasCallStack, MonadIO m)

=> WebsiteData

websiteData: a WebsiteData

-> m Text

Returns: the website name of websiteData.

Gets the name of WebsiteData.

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

Since: 2.16

getSize

websiteDataGetSize

Arguments

:: (HasCallStack, MonadIO m)

=> WebsiteData

websiteData: a WebsiteData

-> [WebsiteDataTypes]

types: a bitmask of WebsiteDataTypes

-> m Word64

Returns: the size of websiteData for the given types.

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

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

Since: 2.16

getTypes

websiteDataGetTypes

Arguments

:: (HasCallStack, MonadIO m)

=> WebsiteData

websiteData: a WebsiteData

-> m [WebsiteDataTypes]

Returns: a bitmask of WebsiteDataTypes in websiteData

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

These are the types actually present, not the types queried with websiteDataManagerFetch.

Since: 2.16

ref

websiteDataRef

Arguments

:: (HasCallStack, MonadIO m)

=> WebsiteData

websiteData: a WebsiteData

-> m WebsiteData

Returns: The passed WebsiteData

Atomically increments the reference count of websiteData by one.

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

Since: 2.16

unref

websiteDataUnref

Arguments

:: (HasCallStack, MonadIO m)

=> WebsiteData

websiteData: A WebsiteData

-> m ()

Atomically decrements the reference count of websiteData by one.

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

Since: 2.16