chrome.browsingData

Описание

Разрешения

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

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

Концепции и использование

Простейший вариант использования этого API — механизм очистки данных о просмотренных страницах пользователя по времени. Ваш код должен предоставлять временную метку, указывающую дату, после которой данные о просмотренных страницах пользователя должны быть удалены. Эта временная метка форматируется как количество миллисекунд с начала эпохи Unix (которое можно получить из объекта JavaScript Date с помощью метода getTime() ).

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

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 для учётной записи Sync после её очистки. Это необходимо для обеспечения дальнейшей работы Sync, чтобы данные могли быть удалены с сервера. Однако более специфичный метод chrome.browsingData.removeCookies() можно использовать для очистки cookie для учётной записи Sync, и в этом случае синхронизация будет приостановлена.

Конкретное происхождение

Чтобы удалить данные из определённого источника или исключить набор источников из удаления, можно использовать параметры 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);

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

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

• 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, установите пример API browsingData из репозитория 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>