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,
)