cdp/dev.kdriver.cdp.domain/Storage/SharedStorageAccessParams

SharedStorageAccessParams

@Serializable

data class SharedStorageAccessParams(val scriptSourceUrl: String? = null, val dataOrigin: String? = null, val operationName: String? = null, val operationId: String? = null, val keepAlive: Boolean? = null, val privateAggregationConfig: Storage.SharedStoragePrivateAggregationConfig? = null, val serializedData: String? = null, val urlsWithMetadata: List<Storage.SharedStorageUrlWithMetadata>? = null, val urnUuid: String? = null, val key: String? = null, val value: String? = null, val ignoreIfPresent: Boolean? = null, val workletOrdinal: Int? = null, val workletTargetId: String? = null, val withLock: String? = null, val batchUpdateId: String? = null, val batchSize: Int? = null)

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

Constructors

constructor(scriptSourceUrl: String? = null, dataOrigin: String? = null, operationName: String? = null, operationId: String? = null, keepAlive: Boolean? = null, privateAggregationConfig: Storage.SharedStoragePrivateAggregationConfig? = null, serializedData: String? = null, urlsWithMetadata: List<Storage.SharedStorageUrlWithMetadata>? = null, urnUuid: String? = null, key: String? = null, value: String? = null, ignoreIfPresent: Boolean? = null, workletOrdinal: Int? = null, workletTargetId: String? = null, withLock: String? = null, batchUpdateId: String? = null, batchSize: Int? = null)

Properties

batchSize

val batchSize: Int? = null

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

batchUpdateId

val batchUpdateId: String? = null

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.

dataOrigin

val dataOrigin: String? = null

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

ignoreIfPresent

val ignoreIfPresent: Boolean? = null

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

keepAlive

val keepAlive: Boolean? = null

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

key

val key: String? = null

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

operationId

val operationId: String? = null

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

operationName

val operationName: String? = null

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

privateAggregationConfig

val privateAggregationConfig: Storage.SharedStoragePrivateAggregationConfig? = null

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

scriptSourceUrl

val scriptSourceUrl: String? = null

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

serializedData

val serializedData: String? = null

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.

urlsWithMetadata

val urlsWithMetadata: List<Storage.SharedStorageUrlWithMetadata>? = null

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

urnUuid

val urnUuid: String? = null

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

value

val value: String? = null

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

withLock

val withLock: String? = null

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

workletOrdinal

val workletOrdinal: Int? = null

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.

workletTargetId

val workletTargetId: String? = null

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.