StorageArea

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

الطُرق

clear()

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

تتم إزالة جميع العناصر من مساحة التخزين.

المرتجعات

  • Promise<void>

    الإصدار 95 من Chrome والإصدارات الأحدث

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

get()

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

تعرض هذه الطريقة عنصرًا واحدًا أو أكثر من مساحة التخزين.

المعلمات

  • مفاتيح

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

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

المرتجعات

  • Promise<object>

    الإصدار 95 من Chrome والإصدارات الأحدث

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

getBytesInUse()

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

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

المعلمات

  • مفاتيح

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

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

المرتجعات

  • Promise<number>

    الإصدار 95 من Chrome والإصدارات الأحدث

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

getKeys()

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

تعرض هذه الطريقة جميع المفاتيح من مساحة التخزين.

المرتجعات

  • Promise<string[]>

    وعد يتم تنفيذه باستخدام مفاتيح التخزين، أو يتم رفضه عند حدوث خطأ.

remove()

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

تزيل هذه الطريقة عنصرًا واحدًا أو أكثر من مساحة التخزين.

المعلمات

  • مفاتيح

    سلسلة | سلسلة[]

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

المرتجعات

  • Promise<void>

    الإصدار 95 من Chrome والإصدارات الأحدث

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

set()

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

تضبط هذه السمة عناصر متعدّدة.

المعلمات

  • items

    عنصر

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

    سيتم تسلسل القيم الأساسية، مثل الأرقام، على النحو المتوقّع. سيتم عادةً تحويل القيم التي تتضمّن typeof و"object" و"function" إلى {}، باستثناء Array (يتم تحويلها كما هو متوقّع) وDate وRegex (يتم تحويلها باستخدام تمثيل String).

المرتجعات

  • Promise<void>

    الإصدار 95 من Chrome والإصدارات الأحدث

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

setAccessLevel()

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

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

المعلمات

  • accessOptions

    عنصر

    • accessLevel

      AccessLevel

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

المرتجعات

  • Promise<void>

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

الفعاليات

onChanged

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

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

المعلمات

  • callback

    دالة

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

    (changes: object) => void

    • التغييرات

      عنصر