browser.browsingData

Описание

Разрешения

Для использования этого API необходимо указать разрешение "browsingData" в манифесте расширения .

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

Понятия и применение

The simplest use-case for this API is a time-based mechanism for clearing a user's browsing data. Your code should provide a timestamp which indicates the historical date after which the user's browsing data should be removed. This timestamp is formatted as the number of milliseconds since the Unix epoch (which can be retrieved from a JavaScript Date object using the getTime() method).

Например, чтобы очистить все данные о просмотре страниц пользователя за последнюю неделю, можно написать следующий код:

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;
browser.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);

Метод browser.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;
browser.browsingData.removeCookies({
  "since": oneWeekAgo
}, callback);

If the user is syncing their data, browser.browsingData.remove() may automatically rebuild the cookie for the Sync account after clearing it. This is to ensure that Sync can continue working, so that the data can be eventually deleted on the server. However the more specific browser.browsingData.removeCookies() can be used to clear the cookie for the Sync account, and Sync will be paused in this case.

Конкретные истоки

Для удаления данных из определенного источника или исключения набора источников из удаления можно использовать параметры RemovalOptions.origins и RemovalOptions.excludeOrigins . Они применимы только к cookie, кэшу и хранилищам (CacheStorage, FileSystems, IndexedDB, LocalStorage, ServiceWorkers и WebSQL).

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

Типы происхождения

Добавление свойства originTypes в объект параметров API позволяет указать, какие типы источников должны быть затронуты. Источники делятся на три категории:

• unprotectedWeb охватывает общий случай веб-сайтов, которые пользователи посещают без каких-либо специальных действий. Если вы не укажете originTypes , API по умолчанию удалит данные с незащищенных веб-источников.
• protectedWeb covers those web origins that have been installed as hosted applications. Installing Angry Birds , for example, protects the origin https://chrome.angrybirds.com , and removes it from the unprotectedWeb category. Be careful when triggering deletion of data for these origins: make sure your users know what they're getting, as this will irrevocably remove their game data. No one wants to knock tiny pig houses over more often than necessary.
• 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;
browser.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, установите пример browsingData API из репозитория chrome-extension-samples .

chrome.browsingData.remove(
  options: RemovalOptions,
  dataToRemove: DataTypeSet,
): Promise<void>

chrome.browsingData.removeAppcache(
  options: RemovalOptions,
): Promise<void>

chrome.browsingData.removeCache(
  options: RemovalOptions,
): Promise<void>

chrome.browsingData.removeCacheStorage(
  options: RemovalOptions,
): Promise<void>

chrome.browsingData.removeCookies(
  options: RemovalOptions,
): Promise<void>

chrome.browsingData.removeDownloads(
  options: RemovalOptions,
): Promise<void>

chrome.browsingData.removeFileSystems(
  options: RemovalOptions,
): Promise<void>

chrome.browsingData.removeFormData(
  options: RemovalOptions,
): Promise<void>

chrome.browsingData.removeHistory(
  options: RemovalOptions,
): Promise<void>

chrome.browsingData.removeIndexedDB(
  options: RemovalOptions,
): Promise<void>

chrome.browsingData.removeLocalStorage(
  options: RemovalOptions,
): Promise<void>

chrome.browsingData.removePasswords(
  options: RemovalOptions,
): Promise<void>

chrome.browsingData.removePluginData(
  options: RemovalOptions,
): Promise<void>

chrome.browsingData.removeServiceWorkers(
  options: RemovalOptions,
): Promise<void>

chrome.browsingData.removeWebSQL(
  options: RemovalOptions,
): Promise<void>

chrome.browsingData.settings(): Promise<object>