Interface IIndexedDB

Namespace

Selenium.WebDriver.BiDi.Cdp.IndexedDB

Assembly

Selenium.WebDriver.BiDi.Cdp.dll

[Experimental("BIDICDP001")]
public interface IIndexedDB

Methods

ClearObjectStoreAsync(string, string, string?, string?, StorageBucket?, string?, CancellationToken)

Clears all entries from an object store.

Task<ClearObjectStoreResult> ClearObjectStoreAsync(string databaseName, string objectStoreName, string? securityOrigin = null, string? storageKey = null, StorageBucket? storageBucket = null, string? session = null, CancellationToken cancellationToken = default)

Parameters

databaseName string

Database name.

objectStoreName string

Object store name.

securityOrigin string

At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.

storageKey string

Storage key.

storageBucket StorageBucket

Storage bucket. If not specified, it uses the default bucket.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<ClearObjectStoreResult>

A task representing the asynchronous operation, containing a ClearObjectStoreResult.

DeleteDatabaseAsync(string, string?, string?, StorageBucket?, string?, CancellationToken)

Deletes a database.

Task<DeleteDatabaseResult> DeleteDatabaseAsync(string databaseName, string? securityOrigin = null, string? storageKey = null, StorageBucket? storageBucket = null, string? session = null, CancellationToken cancellationToken = default)

Parameters

databaseName string

Database name.

securityOrigin string

At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.

storageKey string

Storage key.

storageBucket StorageBucket

Storage bucket. If not specified, it uses the default bucket.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<DeleteDatabaseResult>

A task representing the asynchronous operation, containing a DeleteDatabaseResult.

DeleteObjectStoreEntriesAsync(string, string, KeyRange, string?, string?, StorageBucket?, string?, CancellationToken)

Delete a range of entries from an object store

Task<DeleteObjectStoreEntriesResult> DeleteObjectStoreEntriesAsync(string databaseName, string objectStoreName, KeyRange keyRange, string? securityOrigin = null, string? storageKey = null, StorageBucket? storageBucket = null, string? session = null, CancellationToken cancellationToken = default)

Parameters

databaseName string

objectStoreName string

keyRange KeyRange

Range of entry keys to delete

securityOrigin string

At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.

storageKey string

Storage key.

storageBucket StorageBucket

Storage bucket. If not specified, it uses the default bucket.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<DeleteObjectStoreEntriesResult>

A task representing the asynchronous operation, containing a DeleteObjectStoreEntriesResult.

DisableAsync(string?, CancellationToken)

Disables events from backend.

Task<DisableResult> DisableAsync(string? session = null, CancellationToken cancellationToken = default)

Parameters

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<DisableResult>

A task representing the asynchronous operation, containing a DisableResult.

EnableAsync(string?, CancellationToken)

Enables events from backend.

Task<EnableResult> EnableAsync(string? session = null, CancellationToken cancellationToken = default)

Parameters

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<EnableResult>

A task representing the asynchronous operation, containing a EnableResult.

GetMetadataAsync(string, string, string?, string?, StorageBucket?, string?, CancellationToken)

Gets metadata of an object store.

Task<GetMetadataResult> GetMetadataAsync(string databaseName, string objectStoreName, string? securityOrigin = null, string? storageKey = null, StorageBucket? storageBucket = null, string? session = null, CancellationToken cancellationToken = default)

Parameters

databaseName string

Database name.

objectStoreName string

Object store name.

securityOrigin string

At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.

storageKey string

Storage key.

storageBucket StorageBucket

Storage bucket. If not specified, it uses the default bucket.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<GetMetadataResult>

A task representing the asynchronous operation, containing a GetMetadataResult.

RequestDataAsync(string, string, long, long, string?, string?, StorageBucket?, string?, KeyRange?, string?, CancellationToken)

Requests data from object store or index.

Task<RequestDataResult> RequestDataAsync(string databaseName, string objectStoreName, long skipCount, long pageSize, string? securityOrigin = null, string? storageKey = null, StorageBucket? storageBucket = null, string? indexName = null, KeyRange? keyRange = null, string? session = null, CancellationToken cancellationToken = default)

Parameters

databaseName string

Database name.

objectStoreName string

Object store name.

skipCount long

Number of records to skip.

pageSize long

Number of records to fetch.

securityOrigin string

At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.

storageKey string

Storage key.

storageBucket StorageBucket

Storage bucket. If not specified, it uses the default bucket.

indexName string

Index name. If not specified, it performs an object store data request.

keyRange KeyRange

Key range.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<RequestDataResult>

A task representing the asynchronous operation, containing a RequestDataResult.

RequestDatabaseAsync(string, string?, string?, StorageBucket?, string?, CancellationToken)

Requests database with given name in given frame.

Task<RequestDatabaseResult> RequestDatabaseAsync(string databaseName, string? securityOrigin = null, string? storageKey = null, StorageBucket? storageBucket = null, string? session = null, CancellationToken cancellationToken = default)

Parameters

databaseName string

Database name.

securityOrigin string

At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.

storageKey string

Storage key.

storageBucket StorageBucket

Storage bucket. If not specified, it uses the default bucket.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<RequestDatabaseResult>

A task representing the asynchronous operation, containing a RequestDatabaseResult.

RequestDatabaseNamesAsync(string?, string?, StorageBucket?, string?, CancellationToken)

Requests database names for given security origin.

Task<RequestDatabaseNamesResult> RequestDatabaseNamesAsync(string? securityOrigin = null, string? storageKey = null, StorageBucket? storageBucket = null, string? session = null, CancellationToken cancellationToken = default)

Parameters

securityOrigin string

At least and at most one of securityOrigin, storageKey, or storageBucket must be specified. Security origin.

storageKey string

Storage key.

storageBucket StorageBucket

Storage bucket. If not specified, it uses the default bucket.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<RequestDatabaseNamesResult>

A task representing the asynchronous operation, containing a RequestDatabaseNamesResult.