browsingData.RemovalOptions
The browsingData.RemovalOptions
type contains options to control certain aspects of browsing data removal.
Type
Values of this type are objects. They contain the following properties:
cookieStoreId
Optional-
string
. This property only applies to cookies and indexedDB items. The removal is limited to items belonging to a specific cookie store as specified by the ID.Note: On Firefox Nightly removal of localStorage items by
cookieStoreId
is also supported.
hostnames
Optional-
Array
ofstring
. This property only applies to cookies and local storage items. Only remove cookies and local storage items which are associated with these hostnames.You must pass in just a hostname here, without protocol (for example: "google.com" not https://google.com"). You can use the
URL
interface to parse a raw URL and retrieve just the hostname. Items associated with subdomains of a given hostname will not be removed: you must explicitly list subdomains. originTypes
Optional-
object
. Used to control whether to remove data only from normal web pages, or also from hosted web apps and extensions. If this option is omitted, only data from normal web pages ("unprotectedWeb
") is removed. Before removing data from web apps or extensions, be very careful to ensure that this is really what the user wants.This object may contain any of the following properties:
unprotectedWeb
Optionalboolean
. If present andtrue
, remove data from normal web pages.protectedWeb
Optionalboolean
. If present andtrue
, remove data from websites that have been installed as hosted apps.extension
Optionalboolean
. If present andtrue
, remove data from extensions.
since
Optionalnumber
. How far back in time to remove data, given in milliseconds since the UNIX epoch. Note that when removing the browser cache, the entire cache is always removed and this option is ignored. If thesince
property is omitted, it defaults to 0, which means "forever".
Browser compatibility
Report problems with this compatibility data on GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
cookieStoreId | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support84 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidNo supportNo |
hostnames | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support56 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidFull support85 |
originTypes | ChromeFull supportYes | EdgeFull support79 | FirefoxNo supportNo | OperaFull supportYes | SafariNo supportNo | Firefox for AndroidNo supportNo |
originTypes.extension | ChromeFull supportYes | EdgeFull support79 | FirefoxNo supportNo | OperaFull supportYes | SafariNo supportNo | Firefox for AndroidNo supportNo |
originTypes.protectedWeb | ChromeFull supportYes | EdgeFull support79 | FirefoxNo supportNo | OperaFull supportYes | SafariNo supportNo | Firefox for AndroidNo supportNo |
since | ChromeFull supportYes | EdgeFull support79 | FirefoxFull support53
| OperaFull supportYes | SafariNo supportNo | Firefox for AndroidNo support56 — 79
|
Legend
- Full support
- Full support
- No support
- No support
- See implementation notes.
This API is based on Chromium's chrome.browsingData
API.