Package Torello.Browser.BrowserAPI
Class Storage.SharedStorageAccessParams
- java.lang.Object
-
- Torello.Browser.BaseType<Storage.SharedStorageAccessParams>
-
- Torello.Browser.BrowserAPI.Storage.SharedStorageAccessParams
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable<BaseType<?>>
- Enclosing class:
- Storage
public static class Storage.SharedStorageAccessParams extends BaseType<Storage.SharedStorageAccessParams> implements java.io.Serializable
This Nested Java Class is declared as a "Type", which is similar to a Java Class. The CDP API Specifications list this type among the types, events & commands located in theStoragedomain, which may be found within theBrowserAPI.
📌 All browser domain type classes will have a class name that begins with an upper case letter.Bundles the parameters for shared storage access events whose presence/absence can vary according to SharedStorageAccessType.- See Also:
- Serialized Form
Hi-Lited Source-Code:This File's Source Code:
- View Here: Torello/Browser/BrowserAPI/Storage.java
- Open New Browser-Tab: Torello/Browser/BrowserAPI/Storage.java
File Size: 8,252 Bytes Line Count: 194 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc
- View Here: Storage$$SharedStorageAccessParams$$.java
- Open New Browser-Tab: Storage$$SharedStorageAccessParams$$.java
File Size: 18,484 Bytes Line Count: 404 '\n' Characters Found
-
-
Field Summary
Serializable ID Modifier and Type Field Description protected static longserialVersionUIDType Fields / Properties (from Google & Browser Specs) Modifier and Type Field Description IntegerbatchSizeNumber of modifier methods sent in batch.StringbatchUpdateIdIf the method has been called as part of a batchUpdate, then this number identifies the batch to which it belongs.StringdataOriginString denoting "context-origin", "script-origin", or a custom origin to be used as the worklet's data origin.BooleanignoreIfPresentWhether or not to set an entry for a key if that key is already present.BooleankeepAliveWhether or not to keep the worket alive for future run or selectURL calls.StringkeyKey for a specific entry in an origin's shared storage.StringoperationIdID of the operation call.StringoperationNameName of the registered operation to be run.Storage.SharedStoragePrivateAggregationConfigprivateAggregationConfigConfigures the private aggregation options.StringscriptSourceUrlSpec of the module script URL.StringserializedDataThe operation's serialized data in bytes (converted to a string).Storage.SharedStorageUrlWithMetadata[]urlsWithMetadataArray of candidate URLs' specs, along with any associated metadata.StringurnUuidSpec of the URN:UUID generated for a selectURL call.StringvalueValue for a specific entry in an origin's shared storage.StringwithLockName of the lock to be acquired, if present.IntegerworkletOrdinalA 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.StringworkletTargetIdHex representation of the DevTools token used as the TargetID for the associated shared storage worklet.
-
Constructor Summary
Constructors Constructor Description SharedStorageAccessParams(ReadOnlyList<Boolean> isPresent, String scriptSourceUrl, String dataOrigin, String operationName, String operationId, Boolean keepAlive, Storage.SharedStoragePrivateAggregationConfig privateAggregationConfig, String serializedData, Storage.SharedStorageUrlWithMetadata[] urlsWithMetadata, String urnUuid, String key, String value, Boolean ignoreIfPresent, Integer workletOrdinal, String workletTargetId, String withLock, String batchUpdateId, Integer batchSize)Constructor.
-
Method Summary
Static Builder Convert a JsonObject to a POJO Modifier and Type Method Description static Storage.SharedStorageAccessParamsfromJSON(JsonObject jo)Creates an instance of this class from aJsonObject.Retrieve the Type-Descriptor Singleton-Instance for this Nested Class. Modifier and Type Method Description static NestedDescriptor<Storage.SharedStorageAccessParams>descriptor()Returns this class'sNestedDescriptorsingleton-instance.-
Methods inherited from class Torello.Browser.BaseType
allEnumStrROLs, compareTo, enumStrList, enumStrValidate, enumStrValidateThrow, equals, hashCode, isPresent, optionalsValidate, optionalsValidateThrow, toJSON, toString
-
-
-
-
Field Detail
-
serialVersionUID
protected static final long serialVersionUID
This fulfils the SerialVersion UID requirement for all classes that implement Java'sinterface java.io.Serializable. Using theSerializableImplementation offered by java is very easy, and can make saving program state when debugging a lot easier. It can also be used in place of more complicated systems like "hibernate" to store data as well.- See Also:
- Constant Field Values
-
scriptSourceUrl
public final java.lang.String scriptSourceUrl
Spec of the module script URL. Present only for SharedStorageAccessMethods: addModule and createWorklet.
OPTIONAL
-
dataOrigin
public final java.lang.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.
OPTIONAL
-
operationName
public final java.lang.String operationName
Name of the registered operation to be run. Present only for SharedStorageAccessMethods: run and selectURL.
OPTIONAL
-
operationId
public final java.lang.String operationId
ID of the operation call. Present only for SharedStorageAccessMethods: run and selectURL.
OPTIONAL
-
keepAlive
public final java.lang.Boolean keepAlive
Whether or not to keep the worket alive for future run or selectURL calls. Present only for SharedStorageAccessMethods: run and selectURL.
OPTIONAL
-
privateAggregationConfig
public final Storage.SharedStoragePrivateAggregationConfig privateAggregationConfig
Configures the private aggregation options. Present only for SharedStorageAccessMethods: run and selectURL.
OPTIONAL
-
serializedData
public final java.lang.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.
OPTIONAL
-
urlsWithMetadata
public final Storage.SharedStorageUrlWithMetadata[] urlsWithMetadata
Array of candidate URLs' specs, along with any associated metadata. Present only for SharedStorageAccessMethod: selectURL.
OPTIONAL
-
urnUuid
public final java.lang.String urnUuid
Spec of the URN:UUID generated for a selectURL call. Present only for SharedStorageAccessMethod: selectURL.
OPTIONAL
-
key
public final java.lang.String key
Key for a specific entry in an origin's shared storage. Present only for SharedStorageAccessMethods: set, append, delete, and get.
OPTIONAL
-
value
public final java.lang.String value
Value for a specific entry in an origin's shared storage. Present only for SharedStorageAccessMethods: set and append.
OPTIONAL
-
ignoreIfPresent
public final java.lang.Boolean ignoreIfPresent
Whether or not to set an entry for a key if that key is already present. Present only for SharedStorageAccessMethod: set.
OPTIONAL
-
workletOrdinal
public final java.lang.Integer 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.
OPTIONAL
-
workletTargetId
public final java.lang.String 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.
OPTIONAL
-
withLock
public final java.lang.String withLock
Name of the lock to be acquired, if present. Optionally present only for SharedStorageAccessMethods: batchUpdate, set, append, delete, and clear.
OPTIONAL
-
batchUpdateId
public final java.lang.String 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.
OPTIONAL
-
batchSize
public final java.lang.Integer batchSize
Number of modifier methods sent in batch. Present only for SharedStorageAccessMethod: batchUpdate.
OPTIONAL
-
-
Constructor Detail
-
SharedStorageAccessParams
public SharedStorageAccessParams (ReadOnlyList<java.lang.Boolean> isPresent, java.lang.String scriptSourceUrl, java.lang.String dataOrigin, java.lang.String operationName, java.lang.String operationId, java.lang.Boolean keepAlive, Storage.SharedStoragePrivateAggregationConfig privateAggregationConfig, java.lang.String serializedData, Storage.SharedStorageUrlWithMetadata[] urlsWithMetadata, java.lang.String urnUuid, java.lang.String key, java.lang.String value, java.lang.Boolean ignoreIfPresent, java.lang.Integer workletOrdinal, java.lang.String workletTargetId, java.lang.String withLock, java.lang.String batchUpdateId, java.lang.Integer batchSize)
Constructor. Please review this class' fields for documentation.
-
-
Method Detail
-
fromJSON
public static Storage.SharedStorageAccessParams fromJSON(JsonObject jo)
Creates an instance of this class from aJsonObject.- Code:
- Exact Method Body:
return singleton.fromJSON(jo);
-
descriptor
public static NestedDescriptor<Storage.SharedStorageAccessParams> descriptor ()
Returns this class'sNestedDescriptorsingleton-instance. class / type.- Code:
- Exact Method Body:
return singleton.descriptor();
-
-