Interface IExtensions

Namespace

Selenium.WebDriver.BiDi.Cdp.Extensions

Assembly

Selenium.WebDriver.BiDi.Cdp.dll

Defines commands and events for browser extensions.

[Experimental("BIDICDP001")]
public interface IExtensions

Methods

ClearStorageItemsAsync(string, StorageArea, string?, CancellationToken)

Clears extension storage in the given storageArea.

Task<ClearStorageItemsResult> ClearStorageItemsAsync(string id, StorageArea storageArea, string? session = null, CancellationToken cancellationToken = default)

Parameters

id string

ID of extension.

storageArea StorageArea

StorageArea to remove data from.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<ClearStorageItemsResult>

A task representing the asynchronous operation, containing a ClearStorageItemsResult.

GetExtensionsAsync(string?, CancellationToken)

Gets a list of all unpacked extensions.

Task<GetExtensionsResult> GetExtensionsAsync(string? session = null, CancellationToken cancellationToken = default)

Parameters

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<GetExtensionsResult>

A task representing the asynchronous operation, containing a GetExtensionsResult.

GetStorageItemsAsync(string, StorageArea, ImmutableArray<string>?, string?, CancellationToken)

Gets data from extension storage in the given storageArea. If keys is specified, these are used to filter the result.

Task<GetStorageItemsResult> GetStorageItemsAsync(string id, StorageArea storageArea, ImmutableArray<string>? keys = null, string? session = null, CancellationToken cancellationToken = default)

Parameters

id string

ID of extension.

storageArea StorageArea

StorageArea to retrieve data from.

keys ImmutableArray<string>?

Keys to retrieve.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<GetStorageItemsResult>

A task representing the asynchronous operation, containing a GetStorageItemsResult.

LoadUnpackedAsync(string, bool?, string?, CancellationToken)

Installs an unpacked extension from the filesystem similar to --load-extension CLI flags. Returns extension ID once the extension has been installed.

Task<LoadUnpackedResult> LoadUnpackedAsync(string path, bool? enableInIncognito = null, string? session = null, CancellationToken cancellationToken = default)

Parameters

path string

Absolute file path.

enableInIncognito bool?

Enable the extension in incognito

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<LoadUnpackedResult>

A task representing the asynchronous operation, containing a LoadUnpackedResult.

RemoveStorageItemsAsync(string, StorageArea, ImmutableArray<string>, string?, CancellationToken)

Removes keys from extension storage in the given storageArea.

Task<RemoveStorageItemsResult> RemoveStorageItemsAsync(string id, StorageArea storageArea, ImmutableArray<string> keys, string? session = null, CancellationToken cancellationToken = default)

Parameters

id string

ID of extension.

storageArea StorageArea

StorageArea to remove data from.

keys ImmutableArray<string>

Keys to remove.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<RemoveStorageItemsResult>

A task representing the asynchronous operation, containing a RemoveStorageItemsResult.

SetStorageItemsAsync(string, StorageArea, JsonElement, string?, CancellationToken)

Sets values in extension storage in the given storageArea. The provided values will be merged with existing values in the storage area.

Task<SetStorageItemsResult> SetStorageItemsAsync(string id, StorageArea storageArea, JsonElement values, string? session = null, CancellationToken cancellationToken = default)

Parameters

id string

ID of extension.

storageArea StorageArea

StorageArea to set data in.

values JsonElement

Values to set.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<SetStorageItemsResult>

A task representing the asynchronous operation, containing a SetStorageItemsResult.

TriggerActionAsync(string, string, string?, CancellationToken)

Runs an extension default action.

Task<TriggerActionResult> TriggerActionAsync(string id, string targetId, string? session = null, CancellationToken cancellationToken = default)

Parameters

id string

Extension id.

targetId string

A tab target ID to trigger the default extension action on.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<TriggerActionResult>

A task representing the asynchronous operation, containing a TriggerActionResult.

UninstallAsync(string, string?, CancellationToken)

Uninstalls an unpacked extension (others not supported) from the profile.

Task<UninstallResult> UninstallAsync(string id, string? session = null, CancellationToken cancellationToken = default)

Parameters

id string

Extension id.

session string

Optional CDP session override.

cancellationToken CancellationToken

A token to cancel the asynchronous operation.

Returns

Task<UninstallResult>

A task representing the asynchronous operation, containing a UninstallResult.