Baseline 2023 *
Newly available
The requestStorageAccess()
method of the Document
interface allows content loaded in a third-party context (i.e., embedded in an <iframe>
) to request access to third-party cookies and unpartitioned state. This is relevant to user agents that, by default, block access to third-party, unpartitioned cookies to improve privacy (e.g., to prevent tracking), and is part of the Storage Access API.
To check whether permission to access third-party cookies has already been granted, you can call Permissions.query()
, specifying the feature name "storage-access"
.
Note: Usage of this feature may be blocked by a storage-access
Permissions Policy set on your server. In addition, the document must pass additional browser-specific checks such as allowlists, blocklists, on-device classification, user settings, anti-clickjacking heuristics, or prompting the user for explicit permission.
requestStorageAccess()
requestStorageAccess(types)
Parameters
types
Optional
An object containing properties that control what unpartitioned state is made accessible. If not specified, the default value of the property is false
. Available properties are as follows:
all
A boolean specifying all possible unpartitioned states should be made accessible.
cookies
A boolean specifying third-party cookies should be made accessible.
sessionStorage
A boolean specifying StorageAccessHandle.sessionStorage
should be made accessible.
localStorage
A boolean specifying StorageAccessHandle.localStorage
should be made accessible.
indexedDB
A boolean specifying StorageAccessHandle.indexedDB
should be made accessible.
locks
A boolean specifying StorageAccessHandle.locks
should be made accessible.
caches
A boolean specifying StorageAccessHandle.caches
should be made accessible.
getDirectory
A boolean specifying StorageAccessHandle.getDirectory()
should be made accessible.
estimate
A boolean specifying StorageAccessHandle.estimate()
should be made accessible.
createObjectURL
A boolean specifying StorageAccessHandle.createObjectURL()
should be made accessible.
revokeObjectURL
A boolean specifying StorageAccessHandle.revokeObjectURL()
should be made accessible.
BroadcastChannel
A boolean specifying StorageAccessHandle.BroadcastChannel()
should be made accessible.
A boolean specifying StorageAccessHandle.SharedWorker()
should be made accessible.
A Promise
that fulfills with undefined
if the access to third-party cookies was granted and no types
parameter was provided, fulfills with StorageAccessHandle
if the access to unpartitioned state requested by the types
parameter was provided, and rejects if access was denied.
requestStorageAccess()
requests are automatically denied unless the embedded content is currently processing a user gesture such as a tap or click (transient activation), or unless permission was already granted previously. If permission was not previously granted, they need to be run inside a user gesture-based event handler. The user gesture behavior depends on the state of the promise:
requestStorageAccess()
in a loop until the user accepts the prompt.InvalidStateError
DOMException
Thrown if:
Document
is not yet active.types
parameter is provided and all of its properties are false
.NotAllowedError
DOMException
Thrown if:
storage-access
Permissions Policy.null
origin.<iframe>
is sandboxed, and the allow-storage-access-by-user-activation
token is not set.document.requestStorageAccess().then(
() => {
console.log("cookie access granted");
},
() => {
console.log("cookie access denied");
},
);
document.requestStorageAccess({ localStorage: true }).then(
(handle) => {
console.log("localStorage access granted");
handle.localStorage.setItem("foo", "bar");
},
() => {
console.log("localStorage access denied");
},
);
Note: See Using the Storage Access API for a more complete example.
Specifications Browser compatibility See alsoRetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4