chrome.browsingData

说明

权限

您必须在扩展程序清单中声明 "browsingData" 权限，才能使用此 API。

{
  "name": "My extension",
  ...
  "permissions": [
    "browsingData",
  ],
  ...
}

概念和用法

此 API 最简单的用例是一种基于时间的机制，用于清除用户浏览数据。您的代码应提供一个时间戳，指明历史日期，在此日期之后应移除用户的浏览数据。此时间戳的格式设置为从 Unix 纪元（可以使用 getTime() 方法从 JavaScript Date 对象中检索）开始计算的毫秒数。

例如，如需清除用户过去一周的所有浏览数据，您可以编写如下代码：

var callback = function () {
  // Do something clever here once data has been removed.
};

var millisecondsPerWeek = 1000 * 60 * 60 * 24 * 7;
var oneWeekAgo = (new Date()).getTime() - millisecondsPerWeek;
chrome.browsingData.remove({
  "since": oneWeekAgo
}, {
  "appcache": true,
  "cache": true,
  "cacheStorage": true,
  "cookies": true,
  "downloads": true,
  "fileSystems": true,
  "formData": true,
  "history": true,
  "indexedDB": true,
  "localStorage": true,
  "passwords": true,
  "serviceWorkers": true,
  "webSQL": true
}, callback);

借助 chrome.browsingData.remove() 方法，您只需调用一次即可移除各种类型的浏览数据，并且比调用多个更具体的方法的速度快得多。不过，如果您只想清除一种特定类型的浏览数据（例如 Cookie），可以使用更细化的方法，以一种简单易懂的方式替代填充 JSON 的调用。

var callback = function () {
  // Do something clever here once data has been removed.
};

var millisecondsPerWeek = 1000 * 60 * 60 * 24 * 7;
var oneWeekAgo = (new Date()).getTime() - millisecondsPerWeek;
chrome.browsingData.removeCookies({
  "since": oneWeekAgo
}, callback);

如果用户正在同步其数据，chrome.browsingData.remove() 可能会在清除后自动为同步帐号重新生成 Cookie。这是为了确保同步功能可以继续运行，以便最终将数据删除服务器上的数据。不过，可以使用更具体的 chrome.browsingData.removeCookies() 清除同步账号的 Cookie，在这种情况下，同步操作将会暂停。

特定来源

如需移除特定来源的数据或排除一组来源以免删除的数据，您可以使用 RemovalOptions.origins 和 RemovalOptions.excludeOrigins 参数。它们只能应用于 Cookie、缓存和存储空间（CacheStorage、FileSystems、IndexedDB、LocalStorage、ServiceWorkers 和 WebSQL）。

chrome.browsingData.remove({
  "origins": ["https://www.example.com"]
}, {
  "cacheStorage": true,
  "cookies": true,
  "fileSystems": true,
  "indexedDB": true,
  "localStorage": true,
  "serviceWorkers": true,
  "webSQL": true
}, callback);

来源类型

通过向 API 选项对象添加 originTypes 属性，您可以指定应受影响的来源类型。源分为三个类别：

• unprotectedWeb 涵盖了用户在未执行任何特殊操作的情况下访问的网站的一般情况。如果您未指定 originTypes，该 API 会默认移除来自不受保护的网站源的数据。
• protectedWeb 涵盖那些已经作为托管应用安装的网站源。例如，安装 Angry Birds 可保护源 https://chrome.angrybirds.com，并将其从 unprotectedWeb 类别中移除。在触发删除这些来源的数据时要小心：确保用户知道他们将获得什么，因为此操作会不可撤消地移除他们的游戏数据。没人愿意不必要地频繁翻翻小猪屋。
• extension 涵盖采用 chrome-extensions: 架构的来源。同样，移除扩展程序数据也需要格外小心

我们可以调整上一个示例，以便仅删除来自受保护网站的数据，如下所示：

var callback = function () {
  // Do something clever here once data has been removed.
};

var millisecondsPerWeek = 1000 * 60 * 60 * 24 * 7;
var oneWeekAgo = (new Date()).getTime() - millisecondsPerWeek;
chrome.browsingData.remove({
  "since": oneWeekAgo,
  "originTypes": {
    "protectedWeb": true
  }
}, {
  "appcache": true,
  "cache": true,
  "cacheStorage": true,
  "cookies": true,
  "downloads": true,
  "fileSystems": true,
  "formData": true,
  "history": true,
  "indexedDB": true,
  "localStorage": true,
  "passwords": true,
  "serviceWorkers": true,
  "webSQL": true
}, callback);

示例

若要试用此 API，请从 chrome-extension-samples 代码库安装 browsingData API 示例。

chrome.browsingData.remove(
  options: RemovalOptions,
  dataToRemove: DataTypeSet,
  callback?: function,
)

chrome.browsingData.removeAppcache(
  options: RemovalOptions,
  callback?: function,
)

chrome.browsingData.removeCache(
  options: RemovalOptions,
  callback?: function,
)

chrome.browsingData.removeCacheStorage(
  options: RemovalOptions,
  callback?: function,
)

chrome.browsingData.removeCookies(
  options: RemovalOptions,
  callback?: function,
)

chrome.browsingData.removeDownloads(
  options: RemovalOptions,
  callback?: function,
)

chrome.browsingData.removeFileSystems(
  options: RemovalOptions,
  callback?: function,
)

chrome.browsingData.removeFormData(
  options: RemovalOptions,
  callback?: function,
)

chrome.browsingData.removeHistory(
  options: RemovalOptions,
  callback?: function,
)

chrome.browsingData.removeIndexedDB(
  options: RemovalOptions,
  callback?: function,
)

chrome.browsingData.removeLocalStorage(
  options: RemovalOptions,
  callback?: function,
)

chrome.browsingData.removePasswords(
  options: RemovalOptions,
  callback?: function,
)

chrome.browsingData.removePluginData(
  options: RemovalOptions,
  callback?: function,
)

chrome.browsingData.removeServiceWorkers(
  options: RemovalOptions,
  callback?: function,
)

chrome.browsingData.removeWebSQL(
  options: RemovalOptions,
  callback?: function,
)

chrome.browsingData.settings(
  callback?: function,
)