GI.WebKit.Objects.WebDatabase

WebDatabase is a representation of a Web Database database. The proposed Web Database standard introduces support for SQL databases that web sites can create and access on a local computer through JavaScript.

To get access to all databases defined by a security origin, use webkit_security_origin_get_databases. Each database has a canonical name, as well as a user-friendly display name.

WebKit uses SQLite to create and access the local SQL databases. The location of a WebDatabase can be accessed wth webkit_web_database_get_filename. You can configure the location of all databases with webkit_set_database_directory_path.

For each database the web site can define an estimated size which can be accessed with webkit_web_database_get_expected_size. The current size of the database in bytes is returned by webkit_web_database_get_size.

For more information refer to the Web Database specification proposal at http://dev.w3.org/html5/webdatabase

Exported types

newtype WebDatabase

Constructors

WebDatabase (ManagedPtr WebDatabase)

Instances

GObject WebDatabase

Methods

gobjectType :: WebDatabase -> IO GType

IsObject WebDatabase

IsWebDatabase WebDatabase

class GObject o => IsWebDatabase o

Instances

(GObject a, UnknownAncestorError Constraint WebDatabase a) => IsWebDatabase a

IsWebDatabase WebDatabase

toWebDatabase :: (MonadIO m, IsWebDatabase o) => o -> m WebDatabase

noWebDatabase :: Maybe WebDatabase

Methods

getDisplayName

webDatabaseGetDisplayName

Arguments

:: (HasCallStack, MonadIO m, IsWebDatabase a)

=> a

webDatabase: a WebDatabase

-> m Text

Returns: the name of the database as seen by the user.

Returns the name of the WebDatabase as seen by the user.

Since: 1.1.14

getExpectedSize

webDatabaseGetExpectedSize

Arguments

:: (HasCallStack, MonadIO m, IsWebDatabase a)

=> a

webDatabase: a WebDatabase

-> m Word64

Returns: the expected size of the database in bytes

Returns the expected size of the WebDatabase in bytes as defined by the web author. The Web Database standard allows web authors to specify an expected size of the database to optimize the user experience.

Since: 1.1.14

getFilename

webDatabaseGetFilename

Arguments

:: (HasCallStack, MonadIO m, IsWebDatabase a)

=> a

webDatabase: a WebDatabase

-> m Text

Returns: the absolute filename of the database

Returns the absolute filename to the WebDatabase file on disk.

Since: 1.1.14

getName

webDatabaseGetName

Arguments

:: (HasCallStack, MonadIO m, IsWebDatabase a)

=> a

webDatabase: a WebDatabase

-> m Text

Returns: the name of the database

Returns the canonical name of the WebDatabase.

Since: 1.1.14

getSecurityOrigin

webDatabaseGetSecurityOrigin

Arguments

:: (HasCallStack, MonadIO m, IsWebDatabase a)

=> a

webDatabase: a WebDatabase

-> m SecurityOrigin

Returns: the security origin of the database

Returns the security origin of the WebDatabase.

Since: 1.1.14

getSize

webDatabaseGetSize

Arguments

:: (HasCallStack, MonadIO m, IsWebDatabase a)

=> a

webDatabase: a WebDatabase

-> m Word64

Returns: the actual size of the database in bytes

Returns the actual size of the WebDatabase space on disk in bytes.

Since: 1.1.14

remove

webDatabaseRemove

Arguments

:: (HasCallStack, MonadIO m, IsWebDatabase a)

=> a

webDatabase: a WebDatabase

-> m ()

Removes the WebDatabase from its security origin and destroys all data stored in the database.

Since: 1.1.14

Properties

displayName

getWebDatabaseDisplayName :: (MonadIO m, IsWebDatabase o) => o -> m Text

expectedSize

getWebDatabaseExpectedSize :: (MonadIO m, IsWebDatabase o) => o -> m Word64

filename

getWebDatabaseFilename :: (MonadIO m, IsWebDatabase o) => o -> m Text

name

constructWebDatabaseName :: IsWebDatabase o => Text -> IO (GValueConstruct o)

getWebDatabaseName :: (MonadIO m, IsWebDatabase o) => o -> m Text

securityOrigin

constructWebDatabaseSecurityOrigin :: (IsWebDatabase o, IsSecurityOrigin a) => a -> IO (GValueConstruct o)

getWebDatabaseSecurityOrigin :: (MonadIO m, IsWebDatabase o) => o -> m SecurityOrigin

size

getWebDatabaseSize :: (MonadIO m, IsWebDatabase o) => o -> m Word64