Package Torello.Browser.BrowserAPI
Class Storage
- java.lang.Object
-
- Torello.Browser.BrowserAPI.Storage
-
public class Storage extends java.lang.Object
This class was built using the Chrome Remote Dev-Tools A.P.I., which is specified by two JSON-RPC Files. These files were obtained from the Chrome Dev Tools Protocol Git Hub Page, which has a "Tip of Tree" (the latest) API-Specification Page Here: JSON-RPC Protocol Specification.
These files were converted into this Java-Browser (CDP) Library. The intention is to have them function in a similar fasion to the Node.js Tool known as 'Puppeteer', Microsoft's 'Playwright' and of course the Main-Stay 'Selenium.' The Java-HTML JAR Library merely implements the Java Types & Commands defined by Google's DevTools Protocol.
🧠View the Google CDP API:
[No Description Provided by Google]
The top-level description and explanation for this class (this comment, at the top this Java-Doc Page) is repeated, verbatim, across all of the domain classes which comprise Google's CDP API.This class is intended to be used with a Browser Instance
These methods have been tested, to some degree, using Google Chrome. In order to use this class you must start a web-browser instance and make a connection to the browser using aRemote Debugging Port. Google-Corporation is the developer of this API, but any browser which accepts a Remote Debug Port Connection over Web-Sockets.
Google-Chrome was used during the development process of the classes in this particular package. Lately, it has been asserted Microsoft has switched to using the Chrome Browser-Engine for its Microsoft Edge Internal Code-Base. Therefore, there may some functionality available when running the methods in this class with Microsoft-Edge.
Check whether the your Web-Browser will allow itself to be driven by theWeb-Socket RDP-Port 9223. See the examples available in packageTorello.Browserto undertand how to build aPageConnandBrowserConnWeb-Socket Connection, and how to build aWebSocketSenderinstance in order to execute the methods in this class.
Web-Socket & JSON API:
Every one of the methods that reside in this class are designed to do nothing more than:- Accept Parameters from the User, and "Marshall Them" into a Valid JSON-Request
- Transmit the Marshalled Request-JSON to a Headless Web-Browser over a Web-Socket Connection
- Receive BOTH that Command-Results AND any Browser Event-Firings from the Web-Socket
- Parse JSON Method-Results and Browser-Event Firings, and Subsequently Convert them to Standard Java-Types
- Report these Method-Results and Browser-Events to the User via a User-Registered, Event-Listener (Events) or a Promise Object (Command Responses / Results)
Unlike the bulk of the Java HTML JAR Library, there is very little native Java-Code, and very little testing that may be done on any of the classes & methods in this package. The code inside these classes does nothing more than marshall-and-unmarshall Java-Types into Json-Requests (and vice-versa). The Java-Script & Browser modules inside of a Google-Chrome instance are, theoretically, handling these requests, and returning their results (or events) over the Web-Socket Connection.
It has been asserted (by Google Chrome Developers) that some of these methods are only "partially working" or "experimental".
Asking Chat-GPT for Help:
The LLM otherwise known as "Chat-GPT" does, indeed, have an expert level of knowledge about the "Remote DevTools Protocol". The API that theChrome DevTools Protocl (CDP)exports is extremely well understood by the LLM, and generally I have found that Chat-GPT understands (by 2 or 3 orders of magnitude) better what my Auto-Generated JSON-Wrappers can do in controlling a Web-Browser than I could ever possibly hope to understand.
Though not available today, there will soon be an automatically downloadable Token-Stream (AI Embeddings) BUTTON available on my Java-Doc Pages that should hopefully make it extremely easy to post my code-base, RAG Style, to Chat-GPT and other LLM's when 'interogating' them. Presently, because my "Get Token Stream Button" does not exist yet on any of my pages, what you can do is copy-and-paste any Method-Signature from any one of these pages and then ask Chat-GPT to explain what that Browser or Java-Script Function is actually doing. It is very likely to give you some pretty neat answers.
I have found that every single one of the Domains, Types & Events which are offered by the CDP Protocol (though not documented very well by Google), are perfectly understood by the A.I. LLM - literally to the point where it does know (much better than I ever could) what my own code base actually does!
Try it out, it's a lot of fun. Note that this package and these classes were originally developed solely to be able to execute the Java-Script that a browser executes when visiting a Web-Site. Complete HTML-Page Content can be scraped (using the HTML Data-Scraping Tools in Java-HTML) off of Web-Sites that have dynamic / Java-Script Generated Content.
Conspicuous Boxed-Types Usage:
You may notice that there are many methods that have parameters which accept, for instance, anInteger, instead of a primitiveint. Just to remind the readiner, in Java Programs aBoxed Typeis a standard Java-Primitive which has been converted into an Object-Reference. The use of Boxed-Types in this code base is an easy-and-fast-way to allow for the concept of "Optional Parameters" or "Optional Field Value."
Whenever you see a method that accepts anInteger, the reason for this Parameter-Type choice is actually to allow a user to pass 'null' to it. This is a simple way to ELIDE passing any value at all to parameters which Google-Chrome would otherwise assert are "Optional." Whenever you pass 'null' to a Boxed-Types in this class, the Json-Processor will simply eliminate that Object-Property from the command altogether; and the browser will simply not receive any value for that parameter when that command is invoked.
The Java Language Specification does not have an easy or well defined means of accepting optional method parameters; so Boxed-Types and 'null' are utilized here. Note that 'null' may be passed to any Command Method-Parameter that is listed asOptionalon the Java-Doc Page description for that parameter.
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: 177,866 Bytes Line Count: 4,239 '\n' Characters Found
Helper: Command Invocation Helpers
- View Here: Storage$$Commands.java
- Open New Browser-Tab: Storage$$Commands.java
File Size: 9,078 Bytes Line Count: 217 '\n' Characters Found
Stateless Class:This class neither contains any program-state, nor can it be instantiated. The@StaticFunctionalAnnotation may also be called 'The Spaghetti Report'.Static-Functionalclasses are, essentially, C-Styled Files, without any constructors or non-static member fields. It is a concept very similar to the Java-Bean's@StatelessAnnotation.
- 1 Constructor(s), 1 declared private, zero-argument constructor
- 37 Method(s), 37 declared static
- 19 Field(s), 19 declared static, 19 declared final
-
-
Nested Class Summary
Type Nested Classes: Types / Classes that Are Used & Exported by this Domain Modifier and Type Class Description static classStorage.AttributionReportingAggregatableDebugReportingConfig[No Description Provided by Google]static classStorage.AttributionReportingAggregatableDebugReportingData[No Description Provided by Google]static classStorage.AttributionReportingAggregatableDedupKey[No Description Provided by Google]static classStorage.AttributionReportingAggregatableTriggerData[No Description Provided by Google]static classStorage.AttributionReportingAggregatableValueDictEntry[No Description Provided by Google]static classStorage.AttributionReportingAggregatableValueEntry[No Description Provided by Google]static classStorage.AttributionReportingAggregationKeysEntry[No Description Provided by Google]static classStorage.AttributionReportingEventReportWindows[No Description Provided by Google]static classStorage.AttributionReportingEventTriggerData[No Description Provided by Google]static classStorage.AttributionReportingFilterConfig[No Description Provided by Google]static classStorage.AttributionReportingFilterDataEntry[No Description Provided by Google]static classStorage.AttributionReportingFilterPair[No Description Provided by Google]static classStorage.AttributionReportingNamedBudgetCandidate[No Description Provided by Google]static classStorage.AttributionReportingNamedBudgetDef[No Description Provided by Google]static classStorage.AttributionReportingSourceRegistration[No Description Provided by Google]static classStorage.AttributionReportingTriggerRegistration[No Description Provided by Google]static classStorage.AttributionScopesData[No Description Provided by Google]static classStorage.RelatedWebsiteSetA single Related Website Set object.static classStorage.SharedStorageAccessParamsBundles the parameters for shared storage access events whose presence/absence can vary according to SharedStorageAccessType.static classStorage.SharedStorageEntryStruct for a single key-value pair in an origin's shared storage.static classStorage.SharedStorageMetadataDetails for an origin's shared storage.static classStorage.SharedStoragePrivateAggregationConfigRepresents a dictionary object passed in as privateAggregationConfig to run or selectURL.static classStorage.SharedStorageReportingMetadataPair of reporting metadata details for a candidate URL forselectURL().static classStorage.SharedStorageUrlWithMetadataBundles a candidate URL with its reporting metadata.static classStorage.StorageBucket[No Description Provided by Google]static classStorage.StorageBucketInfo[No Description Provided by Google]static classStorage.TrustTokensPair of issuer origin and number of available (signed, but not used) Trust Tokens from that issuer.static classStorage.UsageForTypeUsage for a storage type.Event Nested Classes: Browser Events, as Java Inner Classes, Which are Fired by this Domain Modifier and Type Class Description static classStorage.attributionReportingReportSent[No Description Provided by Google]static classStorage.attributionReportingSourceRegistered[No Description Provided by Google]static classStorage.attributionReportingTriggerRegistered[No Description Provided by Google]static classStorage.attributionReportingVerboseDebugReportSent[No Description Provided by Google]static classStorage.cacheStorageContentUpdatedA cache's contents have been modified.static classStorage.cacheStorageListUpdatedA cache has been added/deleted.static classStorage.indexedDBContentUpdatedThe origin's IndexedDB object store has been modified.static classStorage.indexedDBListUpdatedThe origin's IndexedDB database list has been modified.static classStorage.interestGroupAccessedOne of the interest groups was accessed.static classStorage.interestGroupAuctionEventOccurredAn auction involving interest groups is taking place.static classStorage.interestGroupAuctionNetworkRequestCreatedSpecifies which auctions a particular network fetch may be related to, and in what role.static classStorage.sharedStorageAccessedShared storage was accessed by the associated page.static classStorage.sharedStorageWorkletOperationExecutionFinishedA shared storage run or selectURL operation finished its execution.static classStorage.storageBucketCreatedOrUpdated[No Description Provided by Google]static classStorage.storageBucketDeleted[No Description Provided by Google]Command-Returns Nested Classes: Domain-Commands with Multiple Return-Values, and a Dedicated Inner-Class Modifier and Type Class Description static classStorage.getUsageAndQuota$$RETReturns usage and quota in bytes.
-
Field Summary
Enumerated Strings: Like Java 'enum' Types, but Converted to Read-Only String-Lists Modifier and Type Field Description static ReadOnlyList<String>AttributionReportingAggregatableResult[No Description Provided by Google]static ReadOnlyList<String>AttributionReportingEventLevelResult[No Description Provided by Google]static ReadOnlyList<String>AttributionReportingReportResult[No Description Provided by Google]static ReadOnlyList<String>AttributionReportingSourceRegistrationResult[No Description Provided by Google]static ReadOnlyList<String>AttributionReportingSourceRegistrationTimeConfig[No Description Provided by Google]static ReadOnlyList<String>AttributionReportingSourceType[No Description Provided by Google]static ReadOnlyList<String>AttributionReportingTriggerDataMatching[No Description Provided by Google]static ReadOnlyList<String>InterestGroupAccessTypeEnum of interest group access types.static ReadOnlyList<String>InterestGroupAuctionEventTypeEnum of auction events.static ReadOnlyList<String>InterestGroupAuctionFetchTypeEnum of network fetches auctions can do.static ReadOnlyList<String>SharedStorageAccessMethodEnum of shared storage access methods.static ReadOnlyList<String>SharedStorageAccessScopeEnum of shared storage access scopes.static ReadOnlyList<String>StorageBucketsDurability[No Description Provided by Google]static ReadOnlyList<String>StorageTypeEnum of possible storage types.Eliminated Types: Removed CDP Types which Have Been Re-Mapped to Basic Java String Constants Modifier and Type Field Description static StringInterestGroupAuctionIdProtected audience interest group auction identifier.static StringSerializedStorageKey[No Description Provided by Google]static StringSignedInt64AsBase10[No Description Provided by Google]static StringUnsignedInt128AsBase16[No Description Provided by Google]static StringUnsignedInt64AsBase10[No Description Provided by Google]
-
Method Summary
Storage Domain Commands Script Returns Modifier and Type Method Voidstatic Script<>clearCookies(String browserContextId)
Clears cookies.Voidstatic Script<>clearDataForOrigin(String origin, String storageTypes)
Clears storage for origin.Voidstatic Script<>clearDataForStorageKey(String storageKey, String storageTypes)
Clears storage for storage key.Voidstatic Script<>clearSharedStorageEntries(String ownerOrigin)
Clears all entries for a given origin's shared storage.Booleanstatic Script<>clearTrustTokens(String issuerOrigin)
Removes all Trust Tokens issued by the provided issuerOrigin.Voidstatic Script<>deleteSharedStorageEntry(String ownerOrigin, String key)
Deletes entry forkey(if it exists) for a given origin's shared storage.Voidstatic Script<>deleteStorageBucket(Storage.StorageBucket bucket)
Deletes the Storage Bucket with the given storage key and bucket name.String[]static Script<>getAffectedUrlsForThirdPartyCookieMetadata(String firstPartyUrl, String[] thirdPartyUrls)
Returns the list of URLs from a page and its embedded resources that match existing grace period URL pattern rules.Network.Cookie[]static Script<>getCookies(String browserContextId)
Returns all browser cookies.JsonValuestatic Script<>getInterestGroupDetails(String ownerOrigin, String name)
Gets details for a named interest group.Storage.RelatedWebsiteSet[]static Script<>getRelatedWebsiteSets()
Returns the effective Related Website Sets in use by this profile for the browser session.Storage.SharedStorageEntry[]static Script<>getSharedStorageEntries(String ownerOrigin)
Gets the entries in an given origin's shared storage.Storage.SharedStorageMetadatastatic Script<>getSharedStorageMetadata(String ownerOrigin)
Gets metadata for an origin's shared storage.Stringstatic Script<>getStorageKeyForFrame(String frameId)
Returns a storage key given a frame id.Storage.TrustTokens[]static Script<>getTrustTokens()
Returns the number of stored Trust Tokens per issuer for the current browsing context.Storage.getUsageAndQuota$$RETstatic Script<>getUsageAndQuota(String origin)
Returns usage and quota in bytes.Voidstatic Script<>overrideQuotaForOrigin(String origin, Number quotaSize)
Override quota for the specified originVoidstatic Script<>resetSharedStorageBudget(String ownerOrigin)
Resets the budget forownerOriginby clearing all budget withdrawals.String[]static Script<>runBounceTrackingMitigations()
Deletes state for sites identified as potential bounce trackers, immediately.Integerstatic Script<>sendPendingAttributionReports()
Sends all pending Attribution Reports immediately, regardless of their scheduled report time.Voidstatic Script<>setAttributionReportingLocalTestingMode(boolean enabled)
https://wicg.github.io/attribution-reporting-api/Voidstatic Script<>setAttributionReportingTracking(boolean enable)
Enables/disables issuing of Attribution Reporting events.Voidstatic Script<>setCookies(Network.CookieParam[] cookies, String browserContextId)
Sets given cookies.Voidstatic Script<>setInterestGroupAuctionTracking(boolean enable)
Enables/Disables issuing of interestGroupAuctionEventOccurred and interestGroupAuctionNetworkRequestCreated.Voidstatic Script<>setInterestGroupTracking(boolean enable)
Enables/Disables issuing of interestGroupAccessed events.Voidstatic Script<>setProtectedAudienceKAnonymity(String owner, String name, String[] hashes)
[No Description Provided by Google]Voidstatic Script<>setSharedStorageEntry(String ownerOrigin, String key, String value, Boolean ignoreIfPresent)
Sets entry withkeyandvaluefor a given origin's shared storage.Voidstatic Script<>setSharedStorageTracking(boolean enable)
Enables/disables issuing of sharedStorageAccessed events.Voidstatic Script<>setStorageBucketTracking(String storageKey, boolean enable)
Set tracking for a storage key's buckets.Voidstatic Script<>trackCacheStorageForOrigin(String origin)
Registers origin to be notified when an update occurs to its cache storage list.Voidstatic Script<>trackCacheStorageForStorageKey(String storageKey)
Registers storage key to be notified when an update occurs to its cache storage list.Voidstatic Script<>trackIndexedDBForOrigin(String origin)
Registers origin to be notified when an update occurs to its IndexedDB.Voidstatic Script<>trackIndexedDBForStorageKey(String storageKey)
Registers storage key to be notified when an update occurs to its IndexedDB.Voidstatic Script<>untrackCacheStorageForOrigin(String origin)
Unregisters origin from receiving notifications for cache storage.Voidstatic Script<>untrackCacheStorageForStorageKey(String storageKey)
Unregisters storage key from receiving notifications for cache storage.Voidstatic Script<>untrackIndexedDBForOrigin(String origin)
Unregisters origin from receiving notifications for IndexedDB.Voidstatic Script<>untrackIndexedDBForStorageKey(String storageKey)
Unregisters storage key from receiving notifications for IndexedDB.
-
-
-
Field Detail
-
InterestGroupAuctionId
public static final java.lang.String InterestGroupAuctionId
Protected audience interest group auction identifier.
The TypeInterestGroupAuctionIdhas been eliminated, because it is a direct mapping to a basic Java-Type; it has no additional fields, or other distinguishing properties. Instead, this CDP defined type has been relegated to a simpleStringConstant, for documentation & reference purposes only.
The code which is generated which employs this type replaces its use with the Standard Java-Type:String
Eliminated Type- See Also:
- Constant Field Values
-
SerializedStorageKey
public static final java.lang.String SerializedStorageKey
[No Description Provided by Google]
The TypeSerializedStorageKeyhas been eliminated, because it is a direct mapping to a basic Java-Type; it has no additional fields, or other distinguishing properties. Instead, this CDP defined type has been relegated to a simpleStringConstant, for documentation & reference purposes only.
The code which is generated which employs this type replaces its use with the Standard Java-Type:String
Eliminated Type- See Also:
- Constant Field Values
-
SignedInt64AsBase10
public static final java.lang.String SignedInt64AsBase10
[No Description Provided by Google]
EXPERIMENTAL
The TypeSignedInt64AsBase10has been eliminated, because it is a direct mapping to a basic Java-Type; it has no additional fields, or other distinguishing properties. Instead, this CDP defined type has been relegated to a simpleStringConstant, for documentation & reference purposes only.
The code which is generated which employs this type replaces its use with the Standard Java-Type:String
Eliminated Type- See Also:
- Constant Field Values
-
UnsignedInt128AsBase16
public static final java.lang.String UnsignedInt128AsBase16
[No Description Provided by Google]
EXPERIMENTAL
The TypeUnsignedInt128AsBase16has been eliminated, because it is a direct mapping to a basic Java-Type; it has no additional fields, or other distinguishing properties. Instead, this CDP defined type has been relegated to a simpleStringConstant, for documentation & reference purposes only.
The code which is generated which employs this type replaces its use with the Standard Java-Type:String
Eliminated Type- See Also:
- Constant Field Values
-
UnsignedInt64AsBase10
public static final java.lang.String UnsignedInt64AsBase10
[No Description Provided by Google]
EXPERIMENTAL
The TypeUnsignedInt64AsBase10has been eliminated, because it is a direct mapping to a basic Java-Type; it has no additional fields, or other distinguishing properties. Instead, this CDP defined type has been relegated to a simpleStringConstant, for documentation & reference purposes only.
The code which is generated which employs this type replaces its use with the Standard Java-Type:String
Eliminated Type- See Also:
- Constant Field Values
-
AttributionReportingAggregatableResult
public static final ReadOnlyList<java.lang.String> AttributionReportingAggregatableResult
[No Description Provided by Google]
EXPERIMENTAL
String-Enumeration Type
-
AttributionReportingEventLevelResult
public static final ReadOnlyList<java.lang.String> AttributionReportingEventLevelResult
[No Description Provided by Google]
EXPERIMENTAL
String-Enumeration Type
-
AttributionReportingReportResult
public static final ReadOnlyList<java.lang.String> AttributionReportingReportResult
[No Description Provided by Google]
EXPERIMENTAL
String-Enumeration Type
-
AttributionReportingSourceRegistrationResult
public static final ReadOnlyList<java.lang.String> AttributionReportingSourceRegistrationResult
[No Description Provided by Google]
EXPERIMENTAL
String-Enumeration Type
-
AttributionReportingSourceRegistrationTimeConfig
public static final ReadOnlyList<java.lang.String> AttributionReportingSourceRegistrationTimeConfig
[No Description Provided by Google]
EXPERIMENTAL
String-Enumeration Type
-
AttributionReportingSourceType
public static final ReadOnlyList<java.lang.String> AttributionReportingSourceType
[No Description Provided by Google]
EXPERIMENTAL
String-Enumeration Type
-
AttributionReportingTriggerDataMatching
public static final ReadOnlyList<java.lang.String> AttributionReportingTriggerDataMatching
[No Description Provided by Google]
EXPERIMENTAL
String-Enumeration Type
-
InterestGroupAccessType
public static final ReadOnlyList<java.lang.String> InterestGroupAccessType
Enum of interest group access types.
String-Enumeration Type
-
InterestGroupAuctionEventType
public static final ReadOnlyList<java.lang.String> InterestGroupAuctionEventType
Enum of auction events.
String-Enumeration Type
-
InterestGroupAuctionFetchType
public static final ReadOnlyList<java.lang.String> InterestGroupAuctionFetchType
Enum of network fetches auctions can do.
String-Enumeration Type
-
SharedStorageAccessMethod
public static final ReadOnlyList<java.lang.String> SharedStorageAccessMethod
Enum of shared storage access methods.
String-Enumeration Type
-
SharedStorageAccessScope
public static final ReadOnlyList<java.lang.String> SharedStorageAccessScope
Enum of shared storage access scopes.
String-Enumeration Type
-
StorageBucketsDurability
public static final ReadOnlyList<java.lang.String> StorageBucketsDurability
[No Description Provided by Google]
String-Enumeration Type
-
StorageType
public static final ReadOnlyList<java.lang.String> StorageType
Enum of possible storage types.
String-Enumeration Type
-
-
Method Detail
-
clearCookies
public static Script<java.lang.Void> clearCookies (java.lang.String browserContextId)
Clears cookies.- Parameters:
browserContextId- Browser context to use when called on the browser endpoint.
OPTIONAL- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
clearDataForOrigin
public static Script<java.lang.Void> clearDataForOrigin (java.lang.String origin, java.lang.String storageTypes)
Clears storage for origin.- Parameters:
origin- Security origin.storageTypes- Comma separated list of StorageType to clear.- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
clearDataForStorageKey
public static Script<java.lang.Void> clearDataForStorageKey (java.lang.String storageKey, java.lang.String storageTypes)
Clears storage for storage key.- Parameters:
storageKey- Storage key.storageTypes- Comma separated list of StorageType to clear.- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
clearSharedStorageEntries
public static Script<java.lang.Void> clearSharedStorageEntries (java.lang.String ownerOrigin)
Clears all entries for a given origin's shared storage.
EXPERIMENTAL- Parameters:
ownerOrigin- -- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
clearTrustTokens
public static Script<java.lang.Boolean> clearTrustTokens (java.lang.String issuerOrigin)
Removes all Trust Tokens issued by the provided issuerOrigin. Leaves other stored data, including the issuer's Redemption Records, intact.
EXPERIMENTAL- Parameters:
issuerOrigin- -- Returns:
- An instance of
Script<Boolean>
This script may be executed, usingScript.exec, and afterwards, aPromise<Boolean>will be returned
Finally, thePromisemay be awaited, usingPromise.await(), and the returned result of this Browser Function may be retrieved.This Browser Function'sPromisereturns:Boolean (didDeleteTokens)
True if any tokens were deleted, false otherwise.
-
deleteSharedStorageEntry
public static Script<java.lang.Void> deleteSharedStorageEntry (java.lang.String ownerOrigin, java.lang.String key)
Deletes entry forkey(if it exists) for a given origin's shared storage.
EXPERIMENTAL- Parameters:
ownerOrigin- -key- -- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
deleteStorageBucket
public static Script<java.lang.Void> deleteStorageBucket (Storage.StorageBucket bucket)
Deletes the Storage Bucket with the given storage key and bucket name.
EXPERIMENTAL- Parameters:
bucket- -- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
getAffectedUrlsForThirdPartyCookieMetadata
public static Script<java.lang.String[]> getAffectedUrlsForThirdPartyCookieMetadata (java.lang.String firstPartyUrl, java.lang.String[] thirdPartyUrls)
Returns the list of URLs from a page and its embedded resources that match existing grace period URL pattern rules. https://developers.google.com/privacy-sandbox/cookies/temporary-exceptions/grace-period
EXPERIMENTAL- Parameters:
firstPartyUrl- The URL of the page currently being visited.thirdPartyUrls- The list of embedded resource URLs from the page.- Returns:
- An instance of
Script<String[]>
This script may be executed, usingScript.exec, and afterwards, aPromise<String[]>will be returned
Finally, thePromisemay be awaited, usingPromise.await(), and the returned result of this Browser Function may be retrieved.This Browser Function'sPromisereturns:String[] (matchedUrls)
Array of matching URLs. If there is a primary pattern match for the first- party URL, only the first-party URL is returned in the array.
-
getCookies
public static Script<Network.Cookie[]> getCookies (java.lang.String browserContextId)
Returns all browser cookies.- Parameters:
browserContextId- Browser context to use when called on the browser endpoint.
OPTIONAL- Returns:
- An instance of
Script<Network.Cookie[]>
This script may be executed, usingScript.exec, and afterwards, aPromise<will be returnedNetwork.Cookie[]>
Finally, thePromisemay be awaited, usingPromise.await(), and the returned result of this Browser Function may be retrieved.
-
getInterestGroupDetails
public static Script<JsonValue> getInterestGroupDetails (java.lang.String ownerOrigin, java.lang.String name)
Gets details for a named interest group.
EXPERIMENTAL- Parameters:
ownerOrigin- -name- -- Returns:
- An instance of
Script<JsonValue>
This script may be executed, usingScript.exec, and afterwards, aPromise<JsonValue>will be returned
Finally, thePromisemay be awaited, usingPromise.await(), and the returned result of this Browser Function may be retrieved.This Browser Function'sPromisereturns:JsonValue (details)
This largely corresponds to: https://wicg.github.io/turtledove/#dictdef-generatebidinterestgroup but has absolute expirationTime instead of relative lifetimeMs and also adds joiningOrigin.
-
getRelatedWebsiteSets
public static Script<Storage.RelatedWebsiteSet[]> getRelatedWebsiteSets()
Returns the effective Related Website Sets in use by this profile for the browser session. The effective Related Website Sets will not change during a browser session.
EXPERIMENTAL- Returns:
- An instance of
Script<Storage.RelatedWebsiteSet[]>
This script may be executed, usingScript.exec, and afterwards, aPromise<will be returnedStorage.RelatedWebsiteSet[]>
Finally, thePromisemay be awaited, usingPromise.await(), and the returned result of this Browser Function may be retrieved.This Browser Function'sPromisereturns:Storage.RelatedWebsiteSet[] (sets)
-
getSharedStorageEntries
public static Script<Storage.SharedStorageEntry[]> getSharedStorageEntries (java.lang.String ownerOrigin)
Gets the entries in an given origin's shared storage.
EXPERIMENTAL- Parameters:
ownerOrigin- -- Returns:
- An instance of
Script<Storage.SharedStorageEntry[]>
This script may be executed, usingScript.exec, and afterwards, aPromise<will be returnedStorage.SharedStorageEntry[]>
Finally, thePromisemay be awaited, usingPromise.await(), and the returned result of this Browser Function may be retrieved.This Browser Function'sPromisereturns:Storage.SharedStorageEntry[] (entries)
-
getSharedStorageMetadata
public static Script<Storage.SharedStorageMetadata> getSharedStorageMetadata (java.lang.String ownerOrigin)
Gets metadata for an origin's shared storage.
EXPERIMENTAL- Parameters:
ownerOrigin- -- Returns:
- An instance of
Script<Storage.SharedStorageMetadata>
This script may be executed, usingScript.exec, and afterwards, aPromise<will be returnedStorage.SharedStorageMetadata>
Finally, thePromisemay be awaited, usingPromise.await(), and the returned result of this Browser Function may be retrieved.This Browser Function'sPromisereturns:Storage.SharedStorageMetadata(metadata)
-
getStorageKeyForFrame
public static Script<java.lang.String> getStorageKeyForFrame (java.lang.String frameId)
Returns a storage key given a frame id.- Parameters:
frameId- -- Returns:
- An instance of
Script<String>
This script may be executed, usingScript.exec, and afterwards, aPromise<String>will be returned
Finally, thePromisemay be awaited, usingPromise.await(), and the returned result of this Browser Function may be retrieved.This Browser Function'sPromisereturns:String (storageKey)
-
getTrustTokens
public static Script<Storage.TrustTokens[]> getTrustTokens()
Returns the number of stored Trust Tokens per issuer for the current browsing context.
EXPERIMENTAL- Returns:
- An instance of
Script<Storage.TrustTokens[]>
This script may be executed, usingScript.exec, and afterwards, aPromise<will be returnedStorage.TrustTokens[]>
Finally, thePromisemay be awaited, usingPromise.await(), and the returned result of this Browser Function may be retrieved.This Browser Function'sPromisereturns:Storage.TrustTokens[] (tokens)
-
getUsageAndQuota
public static Script<Storage.getUsageAndQuota$$RET> getUsageAndQuota (java.lang.String origin)
Returns usage and quota in bytes.- Parameters:
origin- Security origin.- Returns:
- An instance of
Script<Storage.getUsageAndQuota$$RET>
This script may be executed, usingScript.exec, and afterwards, aPromise<will be returnedStorage.getUsageAndQuota$$RET>
Finally, thePromisemay be awaited, usingPromise.await(), and the returned result of this Browser Function may be retrieved.This Browser Function'sPromisereturns:Storage.getUsageAndQuota$$RETA dedicated return type implies that the browser may return more than 1 datum
-
overrideQuotaForOrigin
public static Script<java.lang.Void> overrideQuotaForOrigin (java.lang.String origin, java.lang.Number quotaSize)
Override quota for the specified origin
EXPERIMENTAL- Parameters:
origin- Security origin.quotaSize- The quota size (in bytes) to override the original quota with. If this is called multiple times, the overridden quota will be equal to the quotaSize provided in the final call. If this is called without specifying a quotaSize, the quota will be reset to the default value for the specified origin. If this is called multiple times with different origins, the override will be maintained for each origin until it is disabled (called without a quotaSize).
OPTIONAL- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
resetSharedStorageBudget
public static Script<java.lang.Void> resetSharedStorageBudget (java.lang.String ownerOrigin)
Resets the budget forownerOriginby clearing all budget withdrawals.
EXPERIMENTAL- Parameters:
ownerOrigin- -- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
runBounceTrackingMitigations
public static Script<java.lang.String[]> runBounceTrackingMitigations()
Deletes state for sites identified as potential bounce trackers, immediately.
EXPERIMENTAL- Returns:
- An instance of
Script<String[]>
This script may be executed, usingScript.exec, and afterwards, aPromise<String[]>will be returned
Finally, thePromisemay be awaited, usingPromise.await(), and the returned result of this Browser Function may be retrieved.This Browser Function'sPromisereturns:String[] (deletedSites)
-
sendPendingAttributionReports
public static Script<java.lang.Integer> sendPendingAttributionReports()
Sends all pending Attribution Reports immediately, regardless of their scheduled report time.
EXPERIMENTAL- Returns:
- An instance of
Script<Integer>
This script may be executed, usingScript.exec, and afterwards, aPromise<Integer>will be returned
Finally, thePromisemay be awaited, usingPromise.await(), and the returned result of this Browser Function may be retrieved.This Browser Function'sPromisereturns:Integer (numSent)
The number of reports that were sent.
-
setAttributionReportingLocalTestingMode
public static Script<java.lang.Void> setAttributionReportingLocalTestingMode (boolean enabled)
https://wicg.github.io/attribution-reporting-api/
EXPERIMENTAL- Parameters:
enabled- If enabled, noise is suppressed and reports are sent immediately.- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
setAttributionReportingTracking
public static Script<java.lang.Void> setAttributionReportingTracking (boolean enable)
Enables/disables issuing of Attribution Reporting events.
EXPERIMENTAL- Parameters:
enable- -- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
setCookies
public static Script<java.lang.Void> setCookies (Network.CookieParam[] cookies, java.lang.String browserContextId)
Sets given cookies.- Parameters:
cookies- Cookies to be set.browserContextId- Browser context to use when called on the browser endpoint.
OPTIONAL- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
setInterestGroupAuctionTracking
public static Script<java.lang.Void> setInterestGroupAuctionTracking (boolean enable)
Enables/Disables issuing of interestGroupAuctionEventOccurred and interestGroupAuctionNetworkRequestCreated.
EXPERIMENTAL- Parameters:
enable- -- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
setInterestGroupTracking
public static Script<java.lang.Void> setInterestGroupTracking (boolean enable)
Enables/Disables issuing of interestGroupAccessed events.
EXPERIMENTAL- Parameters:
enable- -- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
setProtectedAudienceKAnonymity
public static Script<java.lang.Void> setProtectedAudienceKAnonymity (java.lang.String owner, java.lang.String name, java.lang.String[] hashes)
[No Description Provided by Google]- Parameters:
owner- -name- -hashes- -- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
setSharedStorageEntry
public static Script<java.lang.Void> setSharedStorageEntry (java.lang.String ownerOrigin, java.lang.String key, java.lang.String value, java.lang.Boolean ignoreIfPresent)
Sets entry withkeyandvaluefor a given origin's shared storage.
EXPERIMENTAL- Parameters:
ownerOrigin- -key- -value- -ignoreIfPresent- IfignoreIfPresentis included and true, then only sets the entry ifkeydoesn't already exist.
OPTIONAL- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
setSharedStorageTracking
public static Script<java.lang.Void> setSharedStorageTracking (boolean enable)
Enables/disables issuing of sharedStorageAccessed events.
EXPERIMENTAL- Parameters:
enable- -- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
setStorageBucketTracking
public static Script<java.lang.Void> setStorageBucketTracking (java.lang.String storageKey, boolean enable)
Set tracking for a storage key's buckets.
EXPERIMENTAL- Parameters:
storageKey- -enable- -- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
trackCacheStorageForOrigin
public static Script<java.lang.Void> trackCacheStorageForOrigin (java.lang.String origin)
Registers origin to be notified when an update occurs to its cache storage list.- Parameters:
origin- Security origin.- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
trackCacheStorageForStorageKey
public static Script<java.lang.Void> trackCacheStorageForStorageKey (java.lang.String storageKey)
Registers storage key to be notified when an update occurs to its cache storage list.- Parameters:
storageKey- Storage key.- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
trackIndexedDBForOrigin
public static Script<java.lang.Void> trackIndexedDBForOrigin (java.lang.String origin)
Registers origin to be notified when an update occurs to its IndexedDB.- Parameters:
origin- Security origin.- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
trackIndexedDBForStorageKey
public static Script<java.lang.Void> trackIndexedDBForStorageKey (java.lang.String storageKey)
Registers storage key to be notified when an update occurs to its IndexedDB.- Parameters:
storageKey- Storage key.- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
untrackCacheStorageForOrigin
public static Script<java.lang.Void> untrackCacheStorageForOrigin (java.lang.String origin)
Unregisters origin from receiving notifications for cache storage.- Parameters:
origin- Security origin.- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
untrackCacheStorageForStorageKey
public static Script<java.lang.Void> untrackCacheStorageForStorageKey (java.lang.String storageKey)
Unregisters storage key from receiving notifications for cache storage.- Parameters:
storageKey- Storage key.- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
untrackIndexedDBForOrigin
public static Script<java.lang.Void> untrackIndexedDBForOrigin (java.lang.String origin)
Unregisters origin from receiving notifications for IndexedDB.- Parameters:
origin- Security origin.- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
untrackIndexedDBForStorageKey
public static Script<java.lang.Void> untrackIndexedDBForStorageKey (java.lang.String storageKey)
Unregisters storage key from receiving notifications for IndexedDB.- Parameters:
storageKey- Storage key.- Returns:
- An instance of
Script<Void>
ThisScriptinstance must be executed before the browser receives the invocation-request.This Browser-Function does not have a return-value. You may choose to await thePromise<Void>to ensure that the Browser Function has run to completion.
-
-