Table of Contents

Class SharedStorageAccessParams

Namespace
OpenQA.Selenium.DevTools.V148.Storage
Assembly
Selenium.WebDriver.dll

Bundles the parameters for shared storage access events whose presence/absence can vary according to SharedStorageAccessType.

public sealed class SharedStorageAccessParams
Inheritance
SharedStorageAccessParams
Inherited Members

Properties

BatchSize

Number of modifier methods sent in batch. Present only for SharedStorageAccessMethod: batchUpdate.

[JsonPropertyName("batchSize")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public long? BatchSize { get; set; }

Property Value

long?

BatchUpdateId

If the method has been called as part of a batchUpdate, then this number identifies the batch to which it belongs. Optionally present only for SharedStorageAccessMethods: batchUpdate (required), set, append, delete, and clear.

[JsonPropertyName("batchUpdateId")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? BatchUpdateId { get; set; }

Property Value

string

DataOrigin

String denoting "context-origin", "script-origin", or a custom origin to be used as the worklet's data origin. Present only for SharedStorageAccessMethod: createWorklet.

[JsonPropertyName("dataOrigin")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? DataOrigin { get; set; }

Property Value

string

IgnoreIfPresent

Whether or not to set an entry for a key if that key is already present. Present only for SharedStorageAccessMethod: set.

[JsonPropertyName("ignoreIfPresent")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public bool? IgnoreIfPresent { get; set; }

Property Value

bool?

KeepAlive

Whether or not to keep the worket alive for future run or selectURL calls. Present only for SharedStorageAccessMethods: run and selectURL.

[JsonPropertyName("keepAlive")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public bool? KeepAlive { get; set; }

Property Value

bool?

Key

Key for a specific entry in an origin's shared storage. Present only for SharedStorageAccessMethods: set, append, delete, and get.

[JsonPropertyName("key")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Key { get; set; }

Property Value

string

OperationId

ID of the operation call. Present only for SharedStorageAccessMethods: run and selectURL.

[JsonPropertyName("operationId")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? OperationId { get; set; }

Property Value

string

OperationName

Name of the registered operation to be run. Present only for SharedStorageAccessMethods: run and selectURL.

[JsonPropertyName("operationName")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? OperationName { get; set; }

Property Value

string

PrivateAggregationConfig

Configures the private aggregation options. Present only for SharedStorageAccessMethods: run and selectURL.

[JsonPropertyName("privateAggregationConfig")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public SharedStoragePrivateAggregationConfig? PrivateAggregationConfig { get; set; }

Property Value

SharedStoragePrivateAggregationConfig

ScriptSourceUrl

Spec of the module script URL. Present only for SharedStorageAccessMethods: addModule and createWorklet.

[JsonPropertyName("scriptSourceUrl")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? ScriptSourceUrl { get; set; }

Property Value

string

SerializedData

The operation's serialized data in bytes (converted to a string). Present only for SharedStorageAccessMethods: run and selectURL. TODO(crbug.com/401011862): Consider updating this parameter to binary.

[JsonPropertyName("serializedData")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? SerializedData { get; set; }

Property Value

string

UrlsWithMetadata

Array of candidate URLs' specs, along with any associated metadata. Present only for SharedStorageAccessMethod: selectURL.

[JsonPropertyName("urlsWithMetadata")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public SharedStorageUrlWithMetadata[]? UrlsWithMetadata { get; set; }

Property Value

SharedStorageUrlWithMetadata[]

UrnUuid

Spec of the URN:UUID generated for a selectURL call. Present only for SharedStorageAccessMethod: selectURL.

[JsonPropertyName("urnUuid")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? UrnUuid { get; set; }

Property Value

string

Value

Value for a specific entry in an origin's shared storage. Present only for SharedStorageAccessMethods: set and append.

[JsonPropertyName("value")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? Value { get; set; }

Property Value

string

WithLock

Name of the lock to be acquired, if present. Optionally present only for SharedStorageAccessMethods: batchUpdate, set, append, delete, and clear.

[JsonPropertyName("withLock")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? WithLock { get; set; }

Property Value

string

WorkletOrdinal

A number denoting the (0-based) order of the worklet's creation relative to all other shared storage worklets created by documents using the current storage partition. Present only for SharedStorageAccessMethods: addModule, createWorklet.

[JsonPropertyName("workletOrdinal")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public long? WorkletOrdinal { get; set; }

Property Value

long?

WorkletTargetId

Hex representation of the DevTools token used as the TargetID for the associated shared storage worklet. Present only for SharedStorageAccessMethods: addModule, createWorklet, run, selectURL, and any other SharedStorageAccessMethod when the SharedStorageAccessScope is sharedStorageWorklet.

[JsonPropertyName("workletTargetId")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string? WorkletTargetId { get; set; }

Property Value

string
Edit this page