Package io.webfolder.cdp.command

Interface IndexedDBAsync

public interface IndexedDBAsync

  • Method Details

    • clearObjectStore

      CompletableFuture<Void> clearObjectStore(String databaseName, String objectStoreName)
      Clears all entries from an object store.
      Parameters:
      databaseName - Database name.
      objectStoreName - Object store name.

    • clearObjectStore

      CompletableFuture<Void> clearObjectStore(String securityOrigin, String storageKey, String databaseName, String objectStoreName)
      Clears all entries from an object store.
      Parameters:
      securityOrigin - At least and at most one of securityOrigin, storageKey must be specified. Security origin.
      storageKey - Storage key.
      databaseName - Database name.
      objectStoreName - Object store name.

    • deleteDatabase

      CompletableFuture<Void> deleteDatabase(String databaseName)
      Deletes a database.
      Parameters:
      databaseName - Database name.

    • deleteDatabase

      CompletableFuture<Void> deleteDatabase(String securityOrigin, String storageKey, String databaseName)
      Deletes a database.
      Parameters:
      securityOrigin - At least and at most one of securityOrigin, storageKey must be specified. Security origin.
      storageKey - Storage key.
      databaseName - Database name.

    • deleteObjectStoreEntries

      CompletableFuture<Void> deleteObjectStoreEntries(String databaseName, String objectStoreName, KeyRange keyRange)
      Delete a range of entries from an object store
      Parameters:
      keyRange - Range of entry keys to delete

    • deleteObjectStoreEntries

      CompletableFuture<Void> deleteObjectStoreEntries(String securityOrigin, String storageKey, String databaseName, String objectStoreName, KeyRange keyRange)
      Delete a range of entries from an object store
      Parameters:
      securityOrigin - At least and at most one of securityOrigin, storageKey must be specified. Security origin.
      storageKey - Storage key.
      keyRange - Range of entry keys to delete

    • disable

      CompletableFuture<Void> disable()
      Disables events from backend.

    • enable

      CompletableFuture<Void> enable()
      Enables events from backend.

    • getMetadata

      CompletableFuture<GetMetadataResult> getMetadata(String databaseName, String objectStoreName)
      Gets metadata of an object store
      Parameters:
      databaseName - Database name.
      objectStoreName - Object store name.
      Returns:
      GetMetadataResult

    • getMetadata

      CompletableFuture<GetMetadataResult> getMetadata(String securityOrigin, String storageKey, String databaseName, String objectStoreName)
      Gets metadata of an object store
      Parameters:
      securityOrigin - At least and at most one of securityOrigin, storageKey must be specified. Security origin.
      storageKey - Storage key.
      databaseName - Database name.
      objectStoreName - Object store name.
      Returns:
      GetMetadataResult

    • requestData

      CompletableFuture<RequestDataResult> requestData(String databaseName, String objectStoreName, String indexName, Integer skipCount, Integer pageSize)
      Requests data from object store or index.
      Parameters:
      databaseName - Database name.
      objectStoreName - Object store name.
      indexName - Index name, empty string for object store data requests.
      skipCount - Number of records to skip.
      pageSize - Number of records to fetch.
      Returns:
      RequestDataResult

    • requestData

      CompletableFuture<RequestDataResult> requestData(String securityOrigin, String storageKey, String databaseName, String objectStoreName, String indexName, Integer skipCount, Integer pageSize, KeyRange keyRange)
      Requests data from object store or index.
      Parameters:
      securityOrigin - At least and at most one of securityOrigin, storageKey must be specified. Security origin.
      storageKey - Storage key.
      databaseName - Database name.
      objectStoreName - Object store name.
      indexName - Index name, empty string for object store data requests.
      skipCount - Number of records to skip.
      pageSize - Number of records to fetch.
      keyRange - Key range.
      Returns:
      RequestDataResult

    • requestDatabase

      CompletableFuture<DatabaseWithObjectStores> requestDatabase(String databaseName)
      Requests database with given name in given frame.
      Parameters:
      databaseName - Database name.
      Returns:
      Database with an array of object stores.

    • requestDatabase

      CompletableFuture<DatabaseWithObjectStores> requestDatabase(String securityOrigin, String storageKey, String databaseName)
      Requests database with given name in given frame.
      Parameters:
      securityOrigin - At least and at most one of securityOrigin, storageKey must be specified. Security origin.
      storageKey - Storage key.
      databaseName - Database name.
      Returns:
      Database with an array of object stores.

    • requestDatabaseNames

      CompletableFuture<List<String>> requestDatabaseNames()
      Requests database names for given security origin.
      Returns:
      Database names for origin.

    • requestDatabaseNames

      CompletableFuture<List<String>> requestDatabaseNames(String securityOrigin, String storageKey)
      Requests database names for given security origin.
      Parameters:
      securityOrigin - At least and at most one of securityOrigin, storageKey must be specified. Security origin.
      storageKey - Storage key.
      Returns:
      Database names for origin.