SharedStorageAccessParams

@Serializable
data class SharedStorageAccessParams(val scriptSourceUrl: String? = null, val operationName: String? = null, val serializedData: String? = null, val urlsWithMetadata: List<SharedStorageUrlWithMetadata>? = null, val key: String? = null, val value: String? = null, val ignoreIfPresent: Boolean? = null)(source)

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

Official doc

Constructors

Link copied to clipboard
constructor(scriptSourceUrl: String? = null, operationName: String? = null, serializedData: String? = null, urlsWithMetadata: List<SharedStorageUrlWithMetadata>? = null, key: String? = null, value: String? = null, ignoreIfPresent: Boolean? = null)

Properties

Link copied to clipboard

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

Link copied to clipboard
val key: String? = null

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, and SharedStorageAccessType.workletGet.

Link copied to clipboard
val operationName: String? = null

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

Link copied to clipboard
val scriptSourceUrl: String? = null

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

Link copied to clipboard
val serializedData: String? = null

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

Link copied to clipboard

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

Link copied to clipboard
val value: String? = null

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