chrome.browsingData

توضیحات

مجوزها

آشکار

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

{
  "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 ممکن است پس از پاک کردن، کوکی را برای حساب همگام‌سازی به‌طور خودکار بازسازی کند. این برای اطمینان از اینکه همگام‌سازی می‌تواند به کار خود ادامه دهد، به طوری که داده‌ها در نهایت روی سرور حذف شوند، انجام می‌شود. با این حال می‌توان از chrome.browsingData.removeCookies خاص‌تر برای پاک کردن کوکی حساب همگام‌سازی استفاده کرد و در این مورد همگام‌سازی موقتاً متوقف می‌شود.

خاستگاه های خاص

برای حذف داده‌های یک مبدا خاص یا حذف مجموعه‌ای از مبداها از حذف، می‌توانید از پارامترهای 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 به شما این امکان را می دهد که مشخص کنید کدام نوع از مبداها باید اعمال شوند. در حال حاضر ریشه ها به سه دسته تقسیم می شوند:

• 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، نمونه browsingData API را از مخزن chrome-extension-samples نصب کنید.

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