chrome.browsingData

תיאור

הרשאות

כדי להשתמש ב-API הזה, צריך להצהיר על ההרשאה "browsingData" במניפסט של התוסף.

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

מושגים ושימוש

תרחיש השימוש הפשוט ביותר ב-API הזה הוא מנגנון מבוסס-זמן למחיקת נתוני הגלישה של משתמש. הקוד צריך לספק חותמת זמן שמציינת את התאריך ההיסטורי שאחריו צריך להסיר את נתוני הגלישה של המשתמש. חותמת הזמן הזו מפורמטת כמספר המילי-שניות מאז ראשית זמן יוניקס (שאפשר לאחזר מאובייקט 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 של החשבון שמסונכרן אחרי שהוא יימחק. הסיבה לכך היא כדי להבטיח שהסנכרון ימשיך לפעול, כך שבסופו של דבר הנתונים יימחקו מהשרת. עם זאת, אפשר להשתמש בפקודה הספציפית יותר chrome.browsingData.removeCookies() כדי לנקות את קובץ ה-Cookie של חשבון הסנכרון, ובמקרה כזה הסנכרון יושהה.

מקורות ספציפיים

כדי להסיר נתונים ממקור ספציפי או להחריג קבוצה של מקורות ממחיקה, אפשר להשתמש בפרמטרים 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 הזה, מתקינים את הדוגמה ל-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>