chrome.readingList

توضیحات

از API مربوط به chrome.readingList برای خواندن و تغییر موارد موجود در Reading List استفاده کنید.

مجوزها

readingList

برای استفاده از API فهرست مطالعه، مجوز "readingList" را در فایل مانیفست افزونه اضافه کنید:

مانیفست.json:

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

در دسترس بودن

کروم ۱۲۰+ نسخه ۳+

کروم دارای یک فهرست مطالعه در پنل کناری است. این فهرست به کاربران امکان می‌دهد صفحات وب را ذخیره کنند تا بعداً یا در حالت آفلاین بخوانند. از API فهرست مطالعه برای بازیابی موارد موجود و اضافه یا حذف موارد از فهرست استفاده کنید.

فهرست مطالعه که تعدادی مقاله را نشان می‌دهد

مفاهیم و کاربردها

سفارش کالا

موارد موجود در لیست مطالعه هیچ ترتیب تضمین‌شده‌ای ندارند.

منحصر به فرد بودن کالا

آیتم‌ها با استفاده از URL مشخص می‌شوند. این شامل هش و رشته‌ی جستجو می‌شود.

موارد استفاده

بخش‌های زیر برخی از موارد استفاده رایج برای API فهرست مطالعه را نشان می‌دهند. برای مثال‌های کامل افزونه، به نمونه‌های افزونه مراجعه کنید.

یک مورد اضافه کنید

برای افزودن یک آیتم به لیست مطالعه، از 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/"
});

نمونه‌های الحاقی

برای مشاهده دموهای بیشتر از افزونه‌های API فهرست مطالعه، به نمونه API فهرست مطالعه مراجعه کنید.

انواع

AddEntryOptions

خواص

• خوانده شده است

  بولی

  اگر ورودی خوانده شده باشد، true خواهد بود.

• عنوان

  رشته

  عنوان نوشته.

• آدرس اینترنتی

  رشته

  آدرس اینترنتی (url) ورودی.

QueryInfo

خواص

• خوانده شده است

  بولی اختیاری

  مشخص می‌کند که آیا موارد خوانده شده ( true ) یا خوانده نشده ( false ) جستجو شوند.

• عنوان

  رشته اختیاری

  عنوانی برای جستجو.

• آدرس اینترنتی

  رشته اختیاری

  یک آدرس اینترنتی برای جستجو.

ReadingListEntry

خواص

• زمان ایجاد

  شماره

  زمان ایجاد ورودی. از اول ژانویه ۱۹۷۰ بر حسب میلی‌ثانیه ثبت شده است.

• خوانده شده است

  بولی

  اگر ورودی خوانده شده باشد، true خواهد بود.

• آخرین زمان به‌روزرسانی

  شماره

  آخرین باری که ورودی به‌روزرسانی شده است. این مقدار از اول ژانویه ۱۹۷۰ به میلی‌ثانیه است.

• عنوان

  رشته

  عنوان نوشته.

• آدرس اینترنتی

  رشته

  آدرس اینترنتی (url) ورودی.

RemoveOptions

خواص

• آدرس اینترنتی

  رشته

  آدرس اینترنتی (url) که باید حذف شود.

UpdateEntryOptions

خواص

• خوانده شده است

  بولی اختیاری

  وضعیت خواندن به‌روزرسانی‌شده. اگر مقداری ارائه نشود، وضعیت موجود باقی می‌ماند.

• عنوان

  رشته اختیاری

  عنوان جدید. اگر مقداری ارائه نشود، کاشی موجود باقی می‌ماند.

• آدرس اینترنتی

  رشته

  آدرس اینترنتی (url) که به‌روزرسانی خواهد شد.

روش‌ها

addEntry()

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

اگر مطلبی وجود نداشته باشد، آن را به فهرست مطالعه اضافه می‌کند.

پارامترها

• ورود

  گزینه‌های ورود را اضافه کنید

  مطلبی که باید به فهرست مطالعه اضافه شود.

بازگشت‌ها

• قول<void>

  پس از اضافه شدن ورودی، مشکل برطرف می‌شود.

query()

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

تمام ورودی‌هایی که با ویژگی‌های QueryInfo مطابقت دارند را بازیابی می‌کند. ویژگی‌هایی که ارائه نشده‌اند، مطابقت داده نخواهند شد.

پارامترها

• اطلاعات

  اطلاعات پرس و جو

  خواصی که باید جستجو شوند.

بازگشت‌ها

• قول < ReadingListEntry []>

  پس از تطبیق ورودی‌ها، حل می‌شود.

removeEntry()

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

در صورت وجود، ورودی را از لیست خواندن حذف می‌کند.

پارامترها

• اطلاعات

  حذف گزینه‌ها

  ورودی برای حذف از فهرست خواندن.

بازگشت‌ها

• قول<void>

  پس از حذف ورودی، مشکل برطرف می‌شود.

updateEntry()

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

در صورت وجود، ورودی فهرست خواندن را به‌روزرسانی می‌کند.

پارامترها

• اطلاعات

  گزینه‌های ورود به‌روزرسانی

  ورودی برای به‌روزرسانی.

بازگشت‌ها

• قول<void>

  پس از به‌روزرسانی ورودی‌های منطبق، برطرف می‌شود.

رویدادها

onEntryAdded

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

زمانی که یک ReadingListEntry به لیست خواندن اضافه شود، فعال می‌شود.

پارامترها

• تماس برگشتی

  تابع

  پارامتر callback به شکل زیر است:

  (entry: ReadingListEntry) => void

  • ورود

    ورودی لیست خواندن

onEntryRemoved

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

زمانی که یک ReadingListEntry از لیست خواندن حذف شود، فعال می‌شود.

پارامترها

• تماس برگشتی

  تابع

  پارامتر callback به شکل زیر است:

  (entry: ReadingListEntry) => void

  • ورود

    ورودی لیست خواندن

onEntryUpdated

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

زمانی که یک ReadingListEntry در لیست خواندن به‌روزرسانی شود، فعال می‌شود.

پارامترها

• تماس برگشتی

  تابع

  پارامتر callback به شکل زیر است:

  (entry: ReadingListEntry) => void

  • ورود

    ورودی لیست خواندن