browser.readingList

תיאור

משתמשים ב-API של chrome.readingList כדי לקרוא ולשנות את הפריטים ברשימת הקריאה.

הרשאות

readingList

כדי להשתמש ב-Reading List API, צריך להוסיף את ההרשאה "readingList" בקובץ המניפסט של התוסף:

manifest.json:

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

זמינות

‫Chrome 120 ואילך ‫browser.* ‎ מגרסה Chrome 148 ‫MV3 ואילך

ב-Chrome יש רשימת קריאה בחלונית הצדדית. היא מאפשרת למשתמשים לשמור דפי אינטרנט כדי לקרוא אותם מאוחר יותר, גם במצב אופליין. אתם יכולים להשתמש ב-Reading List API כדי לאחזר פריטים קיימים ולהוסיף או להסיר פריטים מהרשימה.

רשימת קריאה עם מספר מאמרים
רשימת קריאה עם כמה מאמרים

מושגים ושימוש

סידור הפריטים

הפריטים ברשימת הקריאה לא מסודרים בסדר מסוים.

ייחודיות הפריט

הפריטים ממוינים לפי כתובת URL. הכתובת כוללת את ה-hash ואת מחרוזת השאילתה.

תרחישים לדוגמה

בקטעים הבאים מוצגים כמה תרחישים נפוצים לשימוש ב-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
});

פריטים ברשת המדיה

כדי להציג פריטים מרשימת הקריאה, משתמשים ב-method‏ browser.readingList.query() כדי לאחזר אותם.

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

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

סימון פריט כ"כבר קראתי"

אתם יכולים להשתמש ב-browser.readingList.updateEntry() כדי לעדכן את הכותרת, את כתובת ה-URL ואת סטטוס הקריאה. הקוד הבא מסמן פריט כ"כבר קראתי":

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

הסרת פריט

כדי להסיר פריט, משתמשים ב-browser.readingList.removeEntry():

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

דוגמאות לתוספים

בדוגמה הזו אפשר לראות עוד הדגמות של Reading List API.

סוגים

AddEntryOptions

מאפיינים

  • hasBeenRead

    בוליאני

    הערך יהיה true אם הרשומה נקראה.

  • title

    מחרוזת

    שם הרשומה.

  • url

    מחרוזת

    כתובת ה-URL של הרשומה.

QueryInfo

מאפיינים

  • hasBeenRead

    בוליאני אופציונלי

    מציין אם לחפש פריטים שנקראו (true) או שלא נקראו (false).

  • title

    מחרוזת אופציונלי

    שם הפריט שרוצים לחפש.

  • url

    מחרוזת אופציונלי

    כתובת URL לחיפוש.

ReadingListEntry

מאפיינים

  • creationTime

    number

    השעה שבה נוצרה הרשומה. הזמן נמדד באלפיות השנייה מאז 1 בינואר 1970.

  • hasBeenRead

    בוליאני

    הערך יהיה true אם הרשומה נקראה.

  • lastUpdateTime

    number

    הפעם האחרונה שבה הרשומה עודכנה. הערך הזה הוא באלפיות השנייה מאז 1 בינואר 1970.

  • title

    מחרוזת

    שם הרשומה.

  • url

    מחרוזת

    כתובת ה-URL של הרשומה.

RemoveOptions

מאפיינים

  • url

    מחרוזת

    כתובת ה-URL שרוצים להסיר.

UpdateEntryOptions

מאפיינים

  • hasBeenRead

    בוליאני אופציונלי

    סטטוס הקריאה המעודכן. אם לא מציינים ערך, הסטטוס הקיים נשאר.

  • title

    מחרוזת אופציונלי

    השם החדש. אם לא מציינים ערך, המשבצת הקיימת נשארת.

  • url

    מחרוזת

    כתובת ה-URL שתעודכן.

Methods

addEntry()

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

הוספת רשומה לרשימת הקריאה אם היא לא קיימת.

פרמטרים

  • הרשומה שרוצים להוסיף לרשימת הקריאה.

החזרות

  • 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>

מעדכן רשומה ברשימת הקריאה אם היא קיימת.

פרמטרים

החזרות

  • Promise<void>

    הפעולה מסתיימת אחרי שהרשומות התואמות מתעדכנות.

אירועים

onEntryAdded

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

מופעל כשמוסיפים ReadingListEntry לרשימת הקריאה.

פרמטרים

onEntryRemoved

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

מופעל כשמסירים ReadingListEntry מרשימת הקריאה.

פרמטרים

onEntryUpdated

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

מופעל כש-ReadingListEntry מתעדכן ברשימת הקריאה.

פרמטרים