StorageArea

تستخدم واجهة برمجة التطبيقات browser.storage واجهة StorageArea.

الطُرق

clear()

browser.storage.StorageArea.clear(): Promise<void>

تؤدي هذه الطريقة إلى إزالة جميع العناصر من مساحة التخزين.

المرتجعات

  • وعد<فراغ>

    الإصدار 95 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    وعد يتم الوفاء به في حال النجاح، أو رفضه في حال الفشل.

get()

browser.storage.StorageArea.get(
  keys?: string | string[] | object,
): Promise<object>

للحصول على عنصر واحد أو أكثر من مساحة التخزين

المعلمات

  • مفاتيح

    string | string[] | object اختيارية

    مفتاح واحد للحصول على قائمة بالمفاتيح أو قاموس يحدّد القيم التلقائية (راجِع وصف العنصر). ستؤدي القائمة أو العنصر الفارغ إلى عرض عنصر نتيجة فارغ. مرِّر null للحصول على محتوى مساحة التخزين بالكامل.

المرتجعات

  • وعد<كائن>

    الإصدار 95 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    وعد يتم حله باستخدام كائن يحتوي على خريطة مفتاح-قيمة للعناصر المطلوبة، أو يتم رفضه في حال تعذّر ذلك.

getBytesInUse()

browser.storage.StorageArea.getBytesInUse(
  keys?: string | string[],
): Promise<number>

للحصول على مقدار المساحة (بالبايت) التي يستخدمها عنصر واحد أو أكثر

المعلمات

  • مفاتيح

    string | string[] اختيارية

    مفتاح واحد أو قائمة مفاتيح للحصول على إجمالي الاستخدام. وستعرض القائمة الفارغة القيمة 0. مرِّر null للحصول على إجمالي استخدام مساحة التخزين بالكامل.

المرتجعات

  • <number>

    الإصدار 95 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    وعد يتم حله باستخدام مقدار المساحة التي تستخدمها مساحة التخزين، أو يتم رفضه في حال تعذّر ذلك.

getKeys()

الإصدار 130 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome 
browser.storage.StorageArea.getKeys(): Promise<string[]>

للحصول على جميع المفاتيح من مساحة التخزين

المرتجعات

  • وعد<سلسلة نصية[]>

    وعد يتم حله باستخدام مفاتيح التخزين أو رفضه في حال تعذّر ذلك

remove()

browser.storage.StorageArea.remove(
  keys: string | string[],
): Promise<void>

لإزالة عنصر واحد أو أكثر من مساحة التخزين

المعلمات

  • مفاتيح

    string | string[]

    مفتاح واحد أو قائمة مفاتيح للعناصر المطلوب إزالتها

المرتجعات

  • وعد<فراغ>

    الإصدار 95 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    وعد يتم الوفاء به في حال النجاح، أو رفضه في حال الفشل.

set()

browser.storage.StorageArea.set(
  items: object,
): Promise<void>

لضبط عناصر متعددة

المعلمات

  • items

    عنصر

    عنصر يوفّر كل زوج من المفاتيح والقيم لتعديل مساحة التخزين به ولن تتأثر أي أزواج مفاتيح/قيم أخرى في مساحة التخزين.

    سيتم تسلسل القيم الأساسية، مثل الأرقام، على النحو المتوقّع. typeof "object" and "function" values will typically serialize to {}, with the exception of Array (serializes as expected), Date, and Regex (serialize using their String representation).

المرتجعات

  • وعد<فراغ>

    الإصدار 95 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome

    وعد يتم الوفاء به في حال النجاح، أو رفضه في حال الفشل.

setAccessLevel()

الإصدار 102 من Chrome والإصدارات الأحدث browser.* منذ الإصدار 148 من Chrome 
browser.storage.StorageArea.setAccessLevel(
  accessOptions: object,
): Promise<void>

يحدّد مستوى الوصول المطلوب إلى مساحة التخزين. بشكل تلقائي، تقتصر مساحة التخزين session على السياقات الموثوق بها (صفحات الإضافات ومشغّلي الخدمات)، بينما تتيح مساحات التخزين managed وlocal وsync الوصول من السياقات الموثوق بها وغير الموثوق بها.

المعلمات

  • accessOptions

    عنصر

    • accessLevel

      AccessLevel

      مستوى الوصول إلى مساحة التخزين

المرتجعات

  • وعد<فراغ>

    وعد يتم الوفاء به في حال النجاح، أو رفضه في حال الفشل.

الفعاليات

onChanged

الإصدار 73 من Chrome والإصدارات الأحدث browser.* ‎ منذ الإصدار 148 من Chrome 
browser.storage.StorageArea.onChanged.addListener(
  callback: function,
)

يتم تنشيطه عند تغيير عنصر واحد أو أكثر.

المعلمات

  • callback

    دالة

    تظهر المَعلمة callback على النحو التالي: 

    (changes: object) => void

    • التغييرات

      عنصر