chrome.browsingData

توضیحات

مجوزها

برای استفاده از این API، باید مجوز "browsingData" را در فایل manifest افزونه تعریف کنید.

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

مفاهیم و کاربردها

ساده‌ترین مورد استفاده برای این API، یک مکانیزم مبتنی بر زمان برای پاک کردن داده‌های مرور کاربر است. کد شما باید یک برچسب زمانی ارائه دهد که نشان دهنده تاریخ تاریخی باشد که پس از آن داده‌های مرور کاربر باید حذف شوند. این برچسب زمانی به صورت تعداد میلی‌ثانیه‌ها از زمان آغاز یونیکس (که می‌تواند از یک شیء 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() به شما امکان می‌دهد انواع مختلف داده‌های مرور را با یک فراخوانی حذف کنید و بسیار سریع‌تر از فراخوانی چندین متد خاص‌تر خواهد بود. با این حال، اگر فقط می‌خواهید یک نوع خاص از داده‌های مرور (مثلاً کوکی‌ها) را پاک کنید، متدهای جزئی‌تر، جایگزین خوانایی برای فراخوانی پر از 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() ممکن است پس از پاک کردن کوکی برای حساب Sync، آن را به‌طور خودکار بازسازی کند. این کار برای اطمینان از ادامه‌ی کار Sync است تا داده‌ها در نهایت از روی سرور حذف شوند. با این حال، می‌توان از chrome.browsingData.removeCookies() خاص‌تر برای پاک کردن کوکی برای حساب Sync استفاده کرد و در این حالت، Sync متوقف می‌شود.

ریشه‌های خاص

برای حذف داده‌ها برای یک مبدأ خاص یا مستثنی کردن مجموعه‌ای از مبدأها از حذف، می‌توانید از پارامترهای RemovalOptions.origins و RemovalOptions.excludeOrigins استفاده کنید. آن‌ها فقط می‌توانند روی کوکی‌ها، حافظه پنهان و فضای ذخیره‌سازی (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 به شما امکان می‌دهد مشخص کنید کدام نوع از originها باید اعمال شوند. originها به سه دسته تقسیم می‌شوند:

• unprotectedWeb حالت کلی وب‌سایت‌هایی را پوشش می‌دهد که کاربران بدون انجام هیچ اقدام خاصی از آنها بازدید می‌کنند. اگر originTypes را مشخص نکنید، API به طور پیش‌فرض داده‌ها را از مبدأهای وب محافظت نشده حذف می‌کند.
• protectedWeb آن دسته از منابع وب را که به عنوان برنامه‌های میزبانی شده نصب شده‌اند، پوشش می‌دهد. به عنوان مثال، نصب Angry Birds ، منبع https://chrome.angrybirds.com را محافظت می‌کند و آن را از دسته unprotectedWeb حذف می‌کند. هنگام حذف داده‌ها برای این منابع مراقب باشید: مطمئن شوید که کاربران شما می‌دانند چه چیزی دریافت می‌کنند، زیرا این کار داده‌های بازی آنها را به طور غیرقابل برگشت حذف می‌کند. هیچ کس نمی‌خواهد خانه‌های کوچک خوک را بیش از حد لازم خراب کند.
• extension origins را تحت طرح 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، نمونه‌ی 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>