Package org.openqa.selenium.devtools.v126.storage.model

Class SharedStorageAccessParams

java.lang.Object

org.openqa.selenium.devtools.v126.storage.model.SharedStorageAccessParams

public class SharedStorageAccessParams
extends Object

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

Constructor Summary

Constructors

Constructor	Description
SharedStorageAccessParams(Optional<String> scriptSourceUrl, Optional<String> operationName, Optional<String> serializedData, Optional<List<SharedStorageUrlWithMetadata>> urlsWithMetadata, Optional<String> key, Optional<String> value, Optional<Boolean> ignoreIfPresent)

Method Summary

Modifier and Type	Method	Description
Optional<Boolean>	getIgnoreIfPresent()	Whether or not to set an entry for a key if that key is already present.
Optional<String>	getKey()	Key for a specific entry in an origin's shared storage.
Optional<String>	getOperationName()	Name of the registered operation to be run.
Optional<String>	getScriptSourceUrl()	Spec of the module script URL.
Optional<String>	getSerializedData()	The operation's serialized data in bytes (converted to a string).
Optional<List<SharedStorageUrlWithMetadata>>	getUrlsWithMetadata()	Array of candidate URLs' specs, along with any associated metadata.
Optional<String>	getValue()	Value for a specific entry in an origin's shared storage.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SharedStorageAccessParams

public SharedStorageAccessParams(Optional<String> scriptSourceUrl,
 Optional<String> operationName,
 Optional<String> serializedData,
 Optional<List<SharedStorageUrlWithMetadata>> urlsWithMetadata,
 Optional<String> key,
 Optional<String> value,
 Optional<Boolean> ignoreIfPresent)

Method Details

getScriptSourceUrl

public Optional<String> getScriptSourceUrl()

Spec of the module script URL. Present only for SharedStorageAccessType.documentAddModule.

getOperationName

public Optional<String> getOperationName()

Name of the registered operation to be run. Present only for SharedStorageAccessType.documentRun and SharedStorageAccessType.documentSelectURL.

getSerializedData

public Optional<String> getSerializedData()

The operation's serialized data in bytes (converted to a string). Present only for SharedStorageAccessType.documentRun and SharedStorageAccessType.documentSelectURL.

getUrlsWithMetadata

public Optional<List<SharedStorageUrlWithMetadata>> getUrlsWithMetadata()

Array of candidate URLs' specs, along with any associated metadata. Present only for SharedStorageAccessType.documentSelectURL.

getKey

public Optional<String> getKey()

Key for a specific entry in an origin's shared storage. Present only for SharedStorageAccessType.documentSet, SharedStorageAccessType.documentAppend, SharedStorageAccessType.documentDelete, SharedStorageAccessType.workletSet, SharedStorageAccessType.workletAppend, SharedStorageAccessType.workletDelete, SharedStorageAccessType.workletGet, SharedStorageAccessType.headerSet, SharedStorageAccessType.headerAppend, and SharedStorageAccessType.headerDelete.

getValue

public Optional<String> getValue()

Value for a specific entry in an origin's shared storage. Present only for SharedStorageAccessType.documentSet, SharedStorageAccessType.documentAppend, SharedStorageAccessType.workletSet, SharedStorageAccessType.workletAppend, SharedStorageAccessType.headerSet, and SharedStorageAccessType.headerAppend.

getIgnoreIfPresent

public Optional<Boolean> getIgnoreIfPresent()

Whether or not to set an entry for a key if that key is already present. Present only for SharedStorageAccessType.documentSet, SharedStorageAccessType.workletSet, and SharedStorageAccessType.headerSet.