chrome.readingList

توضیحات

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

مجوزها

readingList

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

manifest.json: 

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

در دسترس بودن

Chrome 120+ MV3+

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

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

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

سفارش اقلام

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

منحصر به فرد بودن آیتم

آیتم ها با URL کلید می شوند. این شامل هش و رشته پرس و جو می شود.

موارد استفاده کنید

بخش های زیر برخی از موارد استفاده رایج برای Reading List 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/"
});

نمونه های پسوند

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

انواع

AddEntryOptions

خواص

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

    بولی

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

  • عنوان

    رشته

    عنوان مدخل.

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

    رشته

    آدرس ورودی.

QueryInfo

خواص

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

    بولی اختیاری

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

  • عنوان

    رشته اختیاری

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

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

    رشته اختیاری

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

ReadingListEntry

خواص

  • زمان خلقت

    شماره

    زمانی که ورودی ایجاد شد. از 1 ژانویه 1970 در میلی ثانیه ضبط شده است.

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

    بولی

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

  • lastUpdateTime

    شماره

    آخرین باری که ورودی به روز شد. این مقدار از 1 ژانویه 1970 بر حسب میلی ثانیه است.

  • عنوان

    رشته

    عنوان مدخل.

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

    رشته

    آدرس ورودی.

RemoveOptions

خواص

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

    رشته

    آدرس اینترنتی برای حذف.

UpdateEntryOptions

خواص

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

    بولی اختیاری

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

  • عنوان

    رشته اختیاری

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

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

    رشته

    آدرس اینترنتی که به روز می شود.

روش ها

addEntry()

قول بده
chrome.readingList.addEntry(
  entry: AddEntryOptions,
  callback?: function,
)

در صورت عدم وجود ورودی به لیست خواندن اضافه می کند.

پارامترها

  • ورود

    AddEntryOptions

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

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

query()

قول بده
chrome.readingList.query(
  info: QueryInfo,
  callback?: function,
)

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

پارامترها

  • اطلاعات

    QueryInfo

    خواص برای جستجو

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    (entries: ReadingListEntry[]) => void

برمی گرداند

  • Promise< ReadingListEntry []>

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

removeEntry()

قول بده
chrome.readingList.removeEntry(
  info: RemoveOptions,
  callback?: function,
)

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

پارامترها

  • اطلاعات

    RemoveOptions

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

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

updateEntry()

قول بده
chrome.readingList.updateEntry(
  info: UpdateEntryOptions,
  callback?: function,
)

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

پارامترها

  • اطلاعات

    UpdateEntryOptions

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

  • پاسخ به تماس

    عملکرد اختیاری

    پارامتر callback به نظر می رسد: 

    () => void

برمی گرداند

  • قول<باطل>

    Promises در Manifest V3 و نسخه های جدیدتر پشتیبانی می شود، اما callbacks برای سازگاری به عقب ارائه شده است. شما نمی توانید از هر دو در یک فراخوانی تابع استفاده کنید. وعده با همان نوعی که به callback ارسال می شود حل می شود.

رویدادها

onEntryAdded

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

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

پارامترها

onEntryRemoved

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

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

پارامترها

onEntryUpdated

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

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

پارامترها