chrome.readingList

الوصف

الأذونات

لاستخدام Reading List API، أضِف إذن "readingList" في ملف البيان الخاص بالإضافة:

manifest.json:

{
  "name": "My reading list extension",
  ...
  "permissions": [
    "readingList"
  ]
}

مدى التوفّر

يتضمّن Chrome قائمة قراءة تقع في اللوحة الجانبية. تتيح هذه الميزة للمستخدمين حفظ صفحات الويب لقراءتها لاحقًا أو بلا إنترنت. استخدِم Reading List API لاسترداد العناصر الحالية وإضافة عناصر إلى القائمة أو إزالتها منها.

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

ترتيب العناصر

لا يتم ترتيب العناصر في قائمة القراءة بأي ترتيب مضمون.

تفرّد السلعة

يتم تحديد مفاتيح العناصر حسب عنوان URL. ويشمل ذلك التجزئة وسلسلة طلب البحث.

حالات الاستخدام

توضّح الأقسام التالية بعض حالات الاستخدام الشائعة لواجهة برمجة التطبيقات "قائمة القراءة". يمكنك الاطّلاع على نماذج الإضافات للحصول على أمثلة كاملة للإضافات.

إضافة عنصر

لإضافة عنصر إلى قائمة القراءة، استخدِم chrome.readingList.addEntry():

chrome.readingList.addEntry({
  title: "New to the web platform in September | web.dev",
  url: "https://developer.chrome.com/",
  hasBeenRead: false
});

عرض العناصر

لعرض عناصر من قائمة القراءة، استخدِم طريقة chrome.readingList.query() لاستردادها.

const items = await chrome.readingList.query({});

for (const item of items) {
  // Do something do display the item
}

وضع علامة "مقروءة" على عنصر

يمكنك استخدام chrome.readingList.updateEntry() لتعديل العنوان وعنوان URL وحالة القراءة. تضع التعليمة البرمجية التالية علامة "مقروءة" على رسالة:

chrome.readingList.updateEntry({
  url: "https://developer.chrome.com/",
  hasBeenRead: true
});

إزالة عنصر

لإزالة عنصر، استخدِم chrome.readingList.removeEntry():

chrome.readingList.removeEntry({
  url: "https://developer.chrome.com/"
});

عيّنات من الإضافات

للاطّلاع على المزيد من العروض التوضيحية لإضافات Reading List API، يُرجى الانتقال إلى نموذج Reading List API.

chrome.readingList.addEntry(
  entry: AddEntryOptions,
): Promise<void>

chrome.readingList.query(
  info: QueryInfo,
): Promise<ReadingListEntry[]>

chrome.readingList.removeEntry(
  info: RemoveOptions,
): Promise<void>

chrome.readingList.updateEntry(
  info: UpdateEntryOptions,
): Promise<void>

chrome.readingList.onEntryAdded.addListener(
  callback: function,
)

chrome.readingList.onEntryRemoved.addListener(
  callback: function,
)

chrome.readingList.onEntryUpdated.addListener(
  callback: function,
)