Class Storage.SharedStorageAccessParams

    • Field Detail

      • serialVersionUID

        🡇     🗕  🗗  🗖
        protected static final long serialVersionUID
        This fulfils the SerialVersion UID requirement for all classes that implement Java's interface java.io.Serializable. Using the Serializable Implementation 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
      • 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
      • 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.