SharedStorageAccessParams class

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

Constructors

SharedStorageAccessParams.new({String? scriptSourceUrl, String? dataOrigin, String? operationName, String? operationId, bool? keepAlive, SharedStoragePrivateAggregationConfig? privateAggregationConfig, String? serializedData, List<SharedStorageUrlWithMetadata>? urlsWithMetadata, String? urnUuid, String? key, String? value, bool? ignoreIfPresent, int? workletOrdinal, TargetID? workletTargetId, String? withLock, String? batchUpdateId, int? batchSize})
SharedStorageAccessParams.fromJson(Map<String, dynamic> json)
factory

Properties

batchSize int?
Number of modifier methods sent in batch. Present only for SharedStorageAccessMethod: batchUpdate.
final
batchUpdateId String?
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.
final
dataOrigin String?
String denoting "context-origin", "script-origin", or a custom origin to be used as the worklet's data origin. Present only for SharedStorageAccessMethod: createWorklet.
final
hashCode int
The hash code for this object.
no setterinherited
ignoreIfPresent bool?
Whether or not to set an entry for a key if that key is already present. Present only for SharedStorageAccessMethod: set.
final
keepAlive bool?
Whether or not to keep the worket alive for future run or selectURL calls. Present only for SharedStorageAccessMethods: run and selectURL.
final
key String?
Key for a specific entry in an origin's shared storage. Present only for SharedStorageAccessMethods: set, append, delete, and get.
final
operationId String?
ID of the operation call. Present only for SharedStorageAccessMethods: run and selectURL.
final
operationName String?
Name of the registered operation to be run. Present only for SharedStorageAccessMethods: run and selectURL.
final
privateAggregationConfig SharedStoragePrivateAggregationConfig?
Configures the private aggregation options. Present only for SharedStorageAccessMethods: run and selectURL.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scriptSourceUrl String?
Spec of the module script URL. Present only for SharedStorageAccessMethods: addModule and createWorklet.
final
serializedData String?
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.
final
urlsWithMetadata List<SharedStorageUrlWithMetadata>?
Array of candidate URLs' specs, along with any associated metadata. Present only for SharedStorageAccessMethod: selectURL.
final
urnUuid String?
Spec of the URN:UUID generated for a selectURL call. Present only for SharedStorageAccessMethod: selectURL.
final
value String?
Value for a specific entry in an origin's shared storage. Present only for SharedStorageAccessMethods: set and append.
final
withLock String?
Name of the lock to be acquired, if present. Optionally present only for SharedStorageAccessMethods: batchUpdate, set, append, delete, and clear.
final
workletOrdinal int?
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.
final
workletTargetId TargetID?
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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited