chrome.browsingData

Deskripsi

Gunakan chrome.browsingData API untuk menghapus data penjelajahan dari profil lokal pengguna.

Izin

browsingData

Anda harus menyatakan izin "browsingData" dalam manifes ekstensi untuk menggunakan API ini.

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

Konsep dan penggunaan

Kasus penggunaan paling sederhana untuk API ini adalah mekanisme berbasis waktu untuk menghapus data penjelajahan pengguna. Kode Anda harus menyediakan stempel waktu yang menunjukkan tanggal historis setelah data penjelajahan pengguna harus dihapus. Stempel waktu ini diformat sebagai jumlah milidetik sejak epoch Unix (yang dapat diambil dari objek Date JavaScript menggunakan metode getTime()).

Misalnya, untuk menghapus semua data penjelajahan pengguna dari minggu lalu, Anda dapat menulis kode sebagai berikut:

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

Metode chrome.browsingData.remove() memungkinkan Anda menghapus berbagai jenis data penjelajahan dengan satu panggilan, dan akan jauh lebih cepat daripada memanggil beberapa metode yang lebih spesifik. Namun, jika Anda hanya ingin menghapus satu jenis data penjelajahan tertentu (misalnya cookie), metode yang lebih terperinci menawarkan alternatif yang dapat dibaca untuk panggilan yang diisi dengan 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);

Jika pengguna menyinkronkan data mereka, chrome.browsingData.remove() dapat otomatis membuat ulang cookie untuk akun Sinkronisasi setelah menghapusnya. Hal ini untuk memastikan bahwa Sinkronisasi dapat terus berfungsi sehingga data dapat dihapus di server pada akhirnya. Namun, chrome.browsingData.removeCookies() yang lebih spesifik dapat digunakan untuk menghapus cookie untuk akun Sinkronisasi, dan dalam kasus ini Sinkronisasi akan dijeda.

Penting: Menghapus data penjelajahan melibatkan banyak tugas yang berat di latar belakang, dan dapat membutuhkan waktu puluhan detik untuk menyelesaikannya, bergantung pada profil pengguna. Anda harus menggunakan promise yang ditampilkan atau callback untuk terus memberikan informasi terbaru kepada pengguna tentang status penghapusan.

Asal tertentu

Untuk menghapus data untuk origin tertentu atau mengecualikan kumpulan origin dari penghapusan, Anda dapat menggunakan parameter RemovalOptions.origins dan RemovalOptions.excludeOrigins. Class ini hanya dapat diterapkan pada cookie, cache, dan penyimpanan (CacheStorage, FileSystems, IndexedDB, LocalStorage, ServiceWorkers, dan WebSQL).

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

Penting: Karena cookie dicakup secara lebih luas daripada jenis penyimpanan lainnya, menghapus cookie untuk origin akan menghapus semua cookie domain yang dapat didaftarkan. Misalnya, menghapus data untuk https://www.example.com juga akan menghapus cookie dengan domain .example.com.

Jenis origin

Menambahkan properti originTypes ke objek opsi API memungkinkan Anda menentukan jenis origin mana yang harus diterapkan. Asal dibagi menjadi tiga kategori:

• unprotectedWeb mencakup kasus umum situs yang dikunjungi pengguna tanpa melakukan tindakan khusus apa pun. Jika Anda tidak menentukan originTypes, secara default API akan menghapus data dari origin web yang tidak dilindungi.
• protectedWeb mencakup asal web yang telah diinstal sebagai aplikasi yang dihosting. Misalnya, menginstal Angry Birds akan melindungi origin https://chrome.angrybirds.com, dan menghapusnya dari kategori unprotectedWeb. Berhati-hatilah saat memicu penghapusan data untuk origin ini: pastikan pengguna Anda mengetahui apa yang mereka dapatkan karena tindakan ini akan menghapus data game mereka secara permanen. Tidak ada yang mau mengetuk rumah babi kecil lebih sering daripada yang diperlukan.
• extension mencakup origin dalam skema chrome-extensions:. Menghapus data ekstensi, sekali lagi, adalah sesuatu yang harus Anda perhatikan.

Kita dapat menyesuaikan contoh sebelumnya untuk menghapus hanya data dari situs yang dilindungi seperti berikut:

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

Peringatan: Hati-hati dengan jenis origin protectedWeb dan extension. Ini adalah operasi destruktif yang dapat mengejutkan pengguna jika mereka tidak mengetahui dengan baik apa yang akan terjadi saat ekstensi Anda menghapus data atas nama mereka.

Contoh

Untuk mencoba API ini, instal contoh BrowsingData API dari repositori chrome-extension-samples.

Jenis

DataTypeSet

Kumpulan jenis data. Jenis data yang tidak ada ditafsirkan sebagai false.

Properti

• cache aplikasi

  boolean opsional

  Appcache situs.

• cache

  boolean opsional

  Cache browser.

• cacheStorage

  boolean opsional

  Chrome 72 dan yang lebih baru

  Penyimpanan cache

• cookie

  boolean opsional

  Cookie browser.

• download

  boolean opsional

  Daftar download browser.

• fileSystems

  boolean opsional

  Sistem file situs.

• formData

  boolean opsional

  Data formulir browser yang disimpan.

• history

  boolean opsional

  Histori browser.

• indexedDB

  boolean opsional

  Data IndexedDB situs.

• localStorage

  boolean opsional

  Data penyimpanan lokal situs.

• sandi

  boolean opsional

  Sandi tersimpan.

• pluginData

  boolean opsional

  Tidak digunakan lagi sejak Chrome 88

  Dukungan untuk Flash telah dihapus. Jenis data ini akan diabaikan.

  Data plugin.

• serverBoundCertificates

  boolean opsional

  Tidak digunakan lagi sejak Chrome 76

  Dukungan untuk sertifikat yang terikat server telah dihapus. Jenis data ini akan diabaikan.

  Sertifikat yang terikat server.

• serviceWorkers

  boolean opsional

  Service Worker.

• webSQL

  boolean opsional

  Data WebSQL situs.

RemovalOptions

Opsi yang menentukan dengan tepat data yang akan dihapus.

Properti

• excludeOrigins

  string[] opsional

  Chrome 74 dan yang lebih baru

  Jika ada, data untuk origin dalam daftar ini akan dikecualikan dari penghapusan. Tidak dapat digunakan bersama dengan origins. Hanya didukung untuk cookie, penyimpanan, dan cache. Cookie dikecualikan untuk seluruh domain yang dapat didaftarkan.

• originTypes

  objek opsional

  Objek yang propertinya menentukan jenis origin mana yang harus dihapus. Jika objek ini tidak ditentukan, setelan defaultnya adalah hanya menghapus origin yang "tidak dilindungi". Pastikan Anda benar-benar ingin menghapus data aplikasi sebelum menambahkan ' protectedWeb' atau 'ekstensi'.

  • ekstensi

    boolean opsional

    Ekstensi dan paket aplikasi yang telah diinstal pengguna (_berhati-hatilah_!).

  • protectedWeb

    boolean opsional

    Situs web yang telah diinstal sebagai aplikasi yang dihosting (hati-hati!).

  • unprotectedWeb

    boolean opsional

    Situs normal.

• origin

  string[] opsional

  Chrome 74 dan yang lebih baru

  Jika ada, hanya data untuk origin dalam daftar ini yang akan dihapus. Hanya didukung untuk cookie, penyimpanan, dan cache. Cookie akan dihapus untuk seluruh domain yang dapat didaftarkan.

• sejak

  nomor opsional

  Hapus data yang terakumulasi pada atau setelah tanggal ini, yang direpresentasikan dalam milidetik sejak epoch (dapat diakses melalui metode getTime dari objek Date JavaScript). Jika tidak ada, setelan defaultnya adalah 0 (yang akan menghapus semua data penjelajahan).

Metode

remove()

Promise

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

Menghapus berbagai jenis data penjelajahan yang disimpan di profil pengguna.

Parameter

• opsi

  RemovalOptions

• dataToRemove

  DataTypeSet

  Kumpulan jenis data yang akan dihapus.

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  ()=>void

Hasil

• Promise<void>

  Chrome 96 dan yang lebih baru

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

removeAppcache()

Promise

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

Menghapus data appcache situs.

Parameter

• opsi

  RemovalOptions

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  ()=>void

Hasil

• Promise<void>

  Chrome 96 dan yang lebih baru

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

removeCache()

Promise

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

Menghapus cache browser.

Parameter

• opsi

  RemovalOptions

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  ()=>void

Hasil

• Promise<void>

  Chrome 96 dan yang lebih baru

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

removeCacheStorage()

Promise Chrome 72+

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

Menghapus data penyimpanan cache situs.

Parameter

• opsi

  RemovalOptions

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  ()=>void

Hasil

• Promise<void>

  Chrome 96 dan yang lebih baru

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

removeCookies()

Promise

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

Menghapus cookie browser dan sertifikat terikat server yang dimodifikasi dalam jangka waktu tertentu.

Parameter

• opsi

  RemovalOptions

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  ()=>void

Hasil

• Promise<void>

  Chrome 96 dan yang lebih baru

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

removeDownloads()

Promise

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

Menghapus daftar file yang didownload browser (bukan file yang didownload itu sendiri).

Parameter

• opsi

  RemovalOptions

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  ()=>void

Hasil

• Promise<void>

  Chrome 96 dan yang lebih baru

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

removeFileSystems()

Promise

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

Menghapus data sistem file situs.

Parameter

• opsi

  RemovalOptions

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  ()=>void

Hasil

• Promise<void>

  Chrome 96 dan yang lebih baru

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

removeFormData()

Promise

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

Menghapus data formulir yang disimpan di browser (isi otomatis).

Parameter

• opsi

  RemovalOptions

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  ()=>void

Hasil

• Promise<void>

  Chrome 96 dan yang lebih baru

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

removeHistory()

Promise

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

Menghapus histori browser.

Parameter

• opsi

  RemovalOptions

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  ()=>void

Hasil

• Promise<void>

  Chrome 96 dan yang lebih baru

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

removeIndexedDB()

Promise

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

Menghapus data IndexedDB situs.

Parameter

• opsi

  RemovalOptions

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  ()=>void

Hasil

• Promise<void>

  Chrome 96 dan yang lebih baru

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

removeLocalStorage()

Promise

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

Menghapus data penyimpanan lokal situs.

Parameter

• opsi

  RemovalOptions

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  ()=>void

Hasil

• Promise<void>

  Chrome 96 dan yang lebih baru

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

removePasswords()

Promise

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

Menghapus sandi browser yang disimpan.

Parameter

• opsi

  RemovalOptions

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  ()=>void

Hasil

• Promise<void>

  Chrome 96 dan yang lebih baru

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

removePluginData()

Promise Tidak digunakan lagi sejak Chrome 88

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

Dukungan untuk Flash telah dihapus. Fungsi ini tidak berpengaruh.

Menghapus data plugin.

Parameter

• opsi

  RemovalOptions

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  ()=>void

Hasil

• Promise<void>

  Chrome 96 dan yang lebih baru

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

removeServiceWorkers()

Promise Chrome 72+

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

Menghapus pekerja layanan situs.

Parameter

• opsi

  RemovalOptions

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  ()=>void

Hasil

• Promise<void>

  Chrome 96 dan yang lebih baru

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

removeWebSQL()

Promise

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

Menghapus data WebSQL situs.

Parameter

• opsi

  RemovalOptions

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  ()=>void

Hasil

• Promise<void>

  Chrome 96 dan yang lebih baru

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.

settings()

Promise

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

Melaporkan jenis data yang sedang dipilih di UI setelan 'Hapus data penjelajahan'. Catatan: beberapa jenis data yang disertakan dalam API ini tidak tersedia di UI setelan, dan beberapa setelan UI mengontrol lebih dari satu jenis data yang tercantum di sini.

Parameter

• callback

  fungsi opsional

  Parameter callback terlihat seperti:

  (result: object)=>void

  • hasil

    objek

    • dataRemovalPermitted

      DataTypeSet

      Semua jenis tersebut akan ada dalam hasil, dengan nilai true jika diizinkan untuk dihapus (misalnya, oleh kebijakan perusahaan) dan false jika tidak diizinkan.

    • dataToRemove

      DataTypeSet

      Semua jenis akan ada dalam hasil, dengan nilai true jika keduanya dipilih untuk dihapus dan diizinkan untuk dihapus, jika tidak, false.

    • opsi

      RemovalOptions

Hasil

• Promise<object>

  Chrome 96 dan yang lebih baru

  Promise didukung di Manifes V3 dan yang lebih baru, tetapi callback disediakan untuk kompatibilitas mundur. Anda tidak dapat menggunakan keduanya pada panggilan fungsi yang sama. Promise di-resolve dengan jenis yang sama yang diteruskan ke callback.