cdp/dev.kdriver.cdp.domain/IndexedDB

IndexedDB

Constructors

constructor(cdp: CDP)

Types

@Serializable

data class ClearObjectStoreParameter(val securityOrigin: String? = null, val storageKey: String? = null, val storageBucket: Storage.StorageBucket? = null, val databaseName: String, val objectStoreName: String)

DatabaseWithObjectStores

@Serializable

data class DatabaseWithObjectStores(val name: String, val version: Double, val objectStores: List<IndexedDB.ObjectStore>)

Database with an array of object stores.

DataEntry

@Serializable

data class DataEntry(val key: Runtime.RemoteObject, val primaryKey: Runtime.RemoteObject, val value: Runtime.RemoteObject)

Data entry.

DeleteDatabaseParameter

@Serializable

data class DeleteDatabaseParameter(val securityOrigin: String? = null, val storageKey: String? = null, val storageBucket: Storage.StorageBucket? = null, val databaseName: String)

DeleteObjectStoreEntriesParameter

@Serializable

data class DeleteObjectStoreEntriesParameter(val securityOrigin: String? = null, val storageKey: String? = null, val storageBucket: Storage.StorageBucket? = null, val databaseName: String, val objectStoreName: String, val keyRange: IndexedDB.KeyRange)

GetMetadataParameter

@Serializable

data class GetMetadataParameter(val securityOrigin: String? = null, val storageKey: String? = null, val storageBucket: Storage.StorageBucket? = null, val databaseName: String, val objectStoreName: String)

GetMetadataReturn

@Serializable

data class GetMetadataReturn(val entriesCount: Double, val keyGeneratorValue: Double)

Key

@Serializable

data class Key(val type: String, val number: Double? = null, val string: String? = null, val date: Double? = null, val array: List<IndexedDB.Key>? = null)

Key.

KeyPath

@Serializable

data class KeyPath(val type: String, val string: String? = null, val array: List<String>? = null)

Key path.

KeyRange

@Serializable

data class KeyRange(val lower: IndexedDB.Key? = null, val upper: IndexedDB.Key? = null, val lowerOpen: Boolean, val upperOpen: Boolean)

Key range.

ObjectStore

@Serializable

data class ObjectStore(val name: String, val keyPath: IndexedDB.KeyPath, val autoIncrement: Boolean, val indexes: List<IndexedDB.ObjectStoreIndex>)

Object store.

ObjectStoreIndex

@Serializable

data class ObjectStoreIndex(val name: String, val keyPath: IndexedDB.KeyPath, val unique: Boolean, val multiEntry: Boolean)

Object store index.

RequestDatabaseNamesParameter

@Serializable

data class RequestDatabaseNamesParameter(val securityOrigin: String? = null, val storageKey: String? = null, val storageBucket: Storage.StorageBucket? = null)

RequestDatabaseNamesReturn

@Serializable

data class RequestDatabaseNamesReturn(val databaseNames: List<String>)

RequestDatabaseParameter

@Serializable

data class RequestDatabaseParameter(val securityOrigin: String? = null, val storageKey: String? = null, val storageBucket: Storage.StorageBucket? = null, val databaseName: String)

RequestDatabaseReturn

@Serializable

data class RequestDatabaseReturn(val databaseWithObjectStores: IndexedDB.DatabaseWithObjectStores)

RequestDataParameter

@Serializable

data class RequestDataParameter(val securityOrigin: String? = null, val storageKey: String? = null, val storageBucket: Storage.StorageBucket? = null, val databaseName: String, val objectStoreName: String, val indexName: String, val skipCount: Int, val pageSize: Int, val keyRange: IndexedDB.KeyRange? = null)

RequestDataReturn

@Serializable

data class RequestDataReturn(val objectStoreDataEntries: List<IndexedDB.DataEntry>, val hasMore: Boolean)

Functions

clearObjectStore

suspend fun clearObjectStore(args: IndexedDB.ClearObjectStoreParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun clearObjectStore(securityOrigin: String? = null, storageKey: String? = null, storageBucket: Storage.StorageBucket? = null, databaseName: String, objectStoreName: String)

Clears all entries from an object store.

deleteDatabase

suspend fun deleteDatabase(args: IndexedDB.DeleteDatabaseParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun deleteDatabase(securityOrigin: String? = null, storageKey: String? = null, storageBucket: Storage.StorageBucket? = null, databaseName: String)

Deletes a database.

deleteObjectStoreEntries

suspend fun deleteObjectStoreEntries(args: IndexedDB.DeleteObjectStoreEntriesParameter, mode: CommandMode = CommandMode.DEFAULT)

suspend fun deleteObjectStoreEntries(securityOrigin: String? = null, storageKey: String? = null, storageBucket: Storage.StorageBucket? = null, databaseName: String, objectStoreName: String, keyRange: IndexedDB.KeyRange)

Delete a range of entries from an object store

disable

suspend fun disable(mode: CommandMode = CommandMode.DEFAULT)

Disables events from backend.

enable

suspend fun enable(mode: CommandMode = CommandMode.DEFAULT)

Enables events from backend.

getMetadata

suspend fun getMetadata(args: IndexedDB.GetMetadataParameter, mode: CommandMode = CommandMode.DEFAULT): IndexedDB.GetMetadataReturn

suspend fun getMetadata(securityOrigin: String? = null, storageKey: String? = null, storageBucket: Storage.StorageBucket? = null, databaseName: String, objectStoreName: String): IndexedDB.GetMetadataReturn

Gets metadata of an object store.

requestData

suspend fun requestData(args: IndexedDB.RequestDataParameter, mode: CommandMode = CommandMode.DEFAULT): IndexedDB.RequestDataReturn

suspend fun requestData(securityOrigin: String? = null, storageKey: String? = null, storageBucket: Storage.StorageBucket? = null, databaseName: String, objectStoreName: String, indexName: String, skipCount: Int, pageSize: Int, keyRange: IndexedDB.KeyRange? = null): IndexedDB.RequestDataReturn

Requests data from object store or index.

requestDatabase

suspend fun requestDatabase(args: IndexedDB.RequestDatabaseParameter, mode: CommandMode = CommandMode.DEFAULT): IndexedDB.RequestDatabaseReturn

suspend fun requestDatabase(securityOrigin: String? = null, storageKey: String? = null, storageBucket: Storage.StorageBucket? = null, databaseName: String): IndexedDB.RequestDatabaseReturn

Requests database with given name in given frame.

requestDatabaseNames

suspend fun requestDatabaseNames(args: IndexedDB.RequestDatabaseNamesParameter, mode: CommandMode = CommandMode.DEFAULT): IndexedDB.RequestDatabaseNamesReturn

suspend fun requestDatabaseNames(securityOrigin: String? = null, storageKey: String? = null, storageBucket: Storage.StorageBucket? = null): IndexedDB.RequestDatabaseNamesReturn

Requests database names for given security origin.