StorageArea

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

الطُرق

clear()

الوعد 
chrome.storage.StorageArea.clear(
  callback?: function,
): Promise<void>

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

المعلمات

  • callback

    الدالة اختيارية

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

    () => void

المرتجعات

  • Promise<void>

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

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

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، ويجب أن تستخدم المنصات الأخرى عمليات رد الاتصال.

get()

الوعد 
chrome.storage.StorageArea.get(
  keys?: string | string[] | object,
  callback?: function,
): Promise<object>

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

المعلمات

  • مفاتيح

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

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

  • callback

    الدالة اختيارية

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

    (items: object) => void

    • items

      عنصر

      عنصر يتضمّن عناصر في عمليات الربط بين المفتاح والقيمة

المرتجعات

  • Promise<object>

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

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

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، ويجب أن تستخدم المنصات الأخرى عمليات رد الاتصال.

getBytesInUse()

الوعد 
chrome.storage.StorageArea.getBytesInUse(
  keys?: string | string[],
  callback?: function,
): Promise<number>

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

المعلمات

  • مفاتيح

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

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

  • callback

    الدالة اختيارية

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

    (bytesInUse: number) => void

    • bytesInUse

      الرقم

      مقدار المساحة المستخدَمة في التخزين، بالبايت

المرتجعات

  • Promise<number>

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

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

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، ويجب أن تستخدم المنصات الأخرى عمليات رد الاتصال.

getKeys()

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

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

المعلمات

  • callback

    الدالة اختيارية

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

    (keys: string[]) => void

    • مفاتيح

      string[]

      مصفوفة تتضمّن المفاتيح التي تمّت قراءتها من مساحة التخزين

المرتجعات

  • Promise<string[]>

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

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، ويجب أن تستخدم المنصات الأخرى عمليات رد الاتصال.

remove()

الوعد 
chrome.storage.StorageArea.remove(
  keys: string | string[],
  callback?: function,
): Promise<void>

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

المعلمات

  • مفاتيح

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

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

  • callback

    الدالة اختيارية

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

    () => void

المرتجعات

  • Promise<void>

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

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

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، ويجب أن تستخدم المنصات الأخرى عمليات رد الاتصال.

set()

الوعد 
chrome.storage.StorageArea.set(
  items: object,
  callback?: function,
): Promise<void>

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

المعلمات

  • items

    عنصر

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

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

  • callback

    الدالة اختيارية

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

    () => void

المرتجعات

  • Promise<void>

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

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

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، ويجب أن تستخدم المنصات الأخرى عمليات رد الاتصال.

setAccessLevel()

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

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

المعلمات

  • accessOptions

    عنصر

    • accessLevel

      AccessLevel

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

  • callback

    الدالة اختيارية

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

    () => void

المرتجعات

  • Promise<void>

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

    لا تتوفّر الوعود إلا في الإصدار Manifest V3 والإصدارات الأحدث، ويجب أن تستخدم المنصات الأخرى عمليات رد الاتصال.

الفعاليات

onChanged

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

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

المعلمات

  • callback

    دالة

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

    (changes: object) => void

    • التغييرات

      عنصر