chrome.browsingData

الوصف

الأذونات

يجب الإفصاح عن الإذن "browsingData" في بيان الإضافة لاستخدام واجهة برمجة التطبيقات هذه.

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

المفاهيم والاستخدام

أبسط حالة استخدام لهذه الواجهة هي آلية مستندة إلى الوقت لمحو بيانات التصفّح الخاصة بالمستخدم. يجب أن يوفّر الرمز الطابع الزمني الذي يشير إلى التاريخ السابق الذي يجب بعده إزالة بيانات التصفّح الخاصة بالمستخدم. يتم تنسيق هذا الطابع الزمني على أنّه عدد الملّي ثانية منذ بداية حقبة Unix (التي يمكن استردادها من عنصر Date في JavaScript باستخدام طريقة 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 إلى عنصر خيارات واجهات برمجة التطبيقات تحديد أنواع المصادر التي يجب أن تتأثر. تنقسم المصادر إلى ثلاث فئات:

• تغطّي unprotectedWeb الحالة العامة للمواقع الإلكترونية التي يزورها المستخدمون بدون اتّخاذ أي إجراء خاص. في حال عدم تحديد originTypes، ستزيل واجهة برمجة التطبيقات البيانات تلقائيًا من مصادر الويب غير المحمية.
• تغطي 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);

أمثلة

لتجربة واجهة برمجة التطبيقات هذه، ثبِّت مثال browsingData API من مستودع chrome-extension-samples.

chrome.browsingData.remove(
  options: RemovalOptions,
  dataToRemove: DataTypeSet,
  callback?: function,
): Promise<void>

chrome.browsingData.removeAppcache(
  options: RemovalOptions,
  callback?: function,
): Promise<void>

chrome.browsingData.removeCache(
  options: RemovalOptions,
  callback?: function,
): Promise<void>

chrome.browsingData.removeCacheStorage(
  options: RemovalOptions,
  callback?: function,
): Promise<void>

chrome.browsingData.removeCookies(
  options: RemovalOptions,
  callback?: function,
): Promise<void>

chrome.browsingData.removeDownloads(
  options: RemovalOptions,
  callback?: function,
): Promise<void>

chrome.browsingData.removeFileSystems(
  options: RemovalOptions,
  callback?: function,
): Promise<void>

chrome.browsingData.removeFormData(
  options: RemovalOptions,
  callback?: function,
): Promise<void>

chrome.browsingData.removeHistory(
  options: RemovalOptions,
  callback?: function,
): Promise<void>

chrome.browsingData.removeIndexedDB(
  options: RemovalOptions,
  callback?: function,
): Promise<void>

chrome.browsingData.removeLocalStorage(
  options: RemovalOptions,
  callback?: function,
): Promise<void>

chrome.browsingData.removePasswords(
  options: RemovalOptions,
  callback?: function,
): Promise<void>

chrome.browsingData.removePluginData(
  options: RemovalOptions,
  callback?: function,
): Promise<void>

chrome.browsingData.removeServiceWorkers(
  options: RemovalOptions,
  callback?: function,
): Promise<void>

chrome.browsingData.removeWebSQL(
  options: RemovalOptions,
  callback?: function,
): Promise<void>

chrome.browsingData.settings(
  callback?: function,
): Promise<object>