Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (inaki@blueleaf.cc)
Safe Haskell	None
Language	Haskell2010

GI.WebKit2.Structs.WebsiteData

Contents

Exported types
Methods

Description

No description available in the introspection data.

Synopsis

newtype WebsiteData = WebsiteData (ManagedPtr WebsiteData)
noWebsiteData :: Maybe WebsiteData
websiteDataGetName :: (HasCallStack, MonadIO m) => WebsiteData -> m Text
websiteDataGetSize :: (HasCallStack, MonadIO m) => WebsiteData -> [WebsiteDataTypes] -> m Word64
websiteDataGetTypes :: (HasCallStack, MonadIO m) => WebsiteData -> m [WebsiteDataTypes]
websiteDataRef :: (HasCallStack, MonadIO m) => WebsiteData -> m WebsiteData
websiteDataUnref :: (HasCallStack, MonadIO m) => WebsiteData -> m ()

Exported types

newtype WebsiteData Source #

Memory-managed wrapper type.

Constructors

WebsiteData (ManagedPtr WebsiteData)

Instances

BoxedObject WebsiteData Source #
Instance details Defined in GI.WebKit2.Structs.WebsiteData Methods boxedType :: WebsiteData -> IO GType #

noWebsiteData :: Maybe WebsiteData Source #

A convenience alias for Nothing :: Maybe WebsiteData.

Methods

getName

websiteDataGetName Source #

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 Source #

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 Source #

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 Source #

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 Source #

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