browser.readingList

شرح

از chrome.readingList API برای خواندن و اصلاح موارد در فهرست خواندن استفاده کنید.

اجازه‌ها

readingList

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

manifest.json:

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

دردسترس بودن

Chrome 120+ browser.* از Chrome 148 MV3+

Chrome دارای فهرست خواندنی است که در پانل کناری قرار دارد. این ویژگی به کاربران امکان می‌دهد صفحه‌های وب را ذخیره کنند تا در فرصتی دیگر یا زمانی که آفلاین هستند آن‌ها را بخوانند. از Reading List API برای بازیابی موارد موجود و افزودن یا برداشتن موارد از فهرست استفاده کنید.

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

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

ترتیب‌بندی موارد

موارد موجود در فهرست خواندنی‌ها ترتیب تضمین‌شده‌ای ندارند.

منحصربه‌فرد بودن مورد

موارد براساس نشانی وب کلیدگذاری شده‌اند. این شامل درهم‌سازی و رشته پُرسمان می‌شود.

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

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

افزودن مورد

برای افزودن مورد به فهرست خواندن، از browser.readingList.addEntry() استفاده کنید:

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

نمایش موارد

برای نمایش موارد از فهرست خواندن، از روش browser.readingList.query() برای بازیابی آن‌ها استفاده کنید. روش.

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

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

علامت‌گذاری مورد به‌عنوان خوانده‌شده

می‌توانید از browser.readingList.updateEntry() برای به‌روزرسانی عنوان، نشانی وب، و وضعیت خوانده شدن استفاده کنید. کد زیر موردی را به‌عنوان خوانده‌شده علامت‌گذاری می‌کند:

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

برداشتن مورد

برای برداشتن مورد، از browser.readingList.removeEntry() استفاده کنید:

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

نمونه‌های افزونه

برای مشاهده نمونه‌های بیشتر افزونه‌های Reading List API، نمونه Reading List API را ببینید.

انواع

AddEntryOptions

مشخصات

• hasBeenRead

  بولی

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

• عنوان

  رشته

  عنوان ورودی.

• نشانی وب

  رشته

  نشانی وب ورودی.

QueryInfo

مشخصات

• hasBeenRead

  بولی اختیاری

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

• عنوان

  رشته اختیاری

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

• نشانی وب

  رشته اختیاری

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

ReadingListEntry

مشخصات

• creationTime

  شماره

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

• hasBeenRead

  بولی

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

• lastUpdateTime

  شماره

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

• عنوان

  رشته

  عنوان ورودی.

• نشانی وب

  رشته

  نشانی وب ورودی.

RemoveOptions

مشخصات

• نشانی وب

  رشته

  نشانی وب برای برداشتن.

UpdateEntryOptions

مشخصات

• hasBeenRead

  بولی اختیاری

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

• عنوان

  رشته اختیاری

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

• نشانی وب

  رشته

  نشانی وبی که به‌روز خواهد شد.

روش‌ها

addEntry()

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

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

پارامترها

• ورودی

  AddEntryOptions

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

بازگشتی‌ها

• Promise<void>

  وقتی ورودی اضافه شد، حل می‌شود.

query()

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

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

پارامترها

• اطلاعات

  QueryInfo

  خصوصیات مورد جستجو.

بازگشتی‌ها

• Promise<ReadingListEntry[]>

  وقتی ورودی‌ها مطابقت داده شوند، مشکل حل می‌شود.

removeEntry()

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

اگر ورودی در فهرست خواندن وجود داشته باشد، آن را برمی‌دارد.

پارامترها

• اطلاعات

  RemoveOptions

  ورودی‌ای که باید از فهرست خواندن برداشته شود.

بازگشتی‌ها

• Promise<void>

  وقتی ورودی برداشته شود، حل‌وفصل می‌شود.

updateEntry()

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

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

پارامترها

• اطلاعات

  UpdateEntryOptions

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

بازگشتی‌ها

• Promise<void>

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

رویدادها

onEntryAdded

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

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

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (entry: ReadingListEntry) => void

  • ورودی

    ReadingListEntry

onEntryRemoved

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

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

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (entry: ReadingListEntry) => void

  • ورودی

    ReadingListEntry

onEntryUpdated

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

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

پارامترها

• تماس برگشتی

  عملکرد

  پارامتر callback به‌صورت زیر است:

  (entry: ReadingListEntry) => void

  • ورودی

    ReadingListEntry