chrome.readingList

תיאור

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

הרשאות

readingList

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

manifest.json:

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

זמינות

Chrome 120+ MV3+

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

רשימת קריאה שבה מוצג מספר מאמרים
רשימת קריאה שבה מוצג מספר מאמרים

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

סדר הפריטים

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

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

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

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

בקטעים הבאים מתוארים כמה תרחישים נפוצים לדוגמה ב-Reader 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() כדי לאחזר אותם. method.

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

מאפיינים

  • hasBeenRead

    בוליאני

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

  • title

    מחרוזת

    הכותרת של הרשומה.

  • כתובת אתר

    מחרוזת

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

QueryInfo

מאפיינים

  • hasBeenRead

    ערך בוליאני אופציונלי

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

  • title

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

    כותרת לחיפוש.

  • כתובת אתר

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

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

ReadingListEntry

מאפיינים

  • creationTime

    number

    השעה שבה נוצרה הרשומה. הסרטון הוקלט באלפיות שנייה מ-1 בינואר 1970.

  • hasBeenRead

    בוליאני

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

  • lastUpdateTime

    number

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

  • title

    מחרוזת

    הכותרת של הרשומה.

  • כתובת אתר

    מחרוזת

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

RemoveOptions

מאפיינים

  • כתובת אתר

    מחרוזת

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

UpdateEntryOptions

מאפיינים

  • hasBeenRead

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

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

  • title

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

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

  • כתובת אתר

    מחרוזת

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

שיטות

addEntry()

Promise 
chrome.readingList.addEntry(
  entry: AddEntryOptions,
  callback?: function,
)

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

פרמטרים

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

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

query()

Promise 
chrome.readingList.query(
  info: QueryInfo,
  callback?: function,
)

אחזור כל הרשומות שתואמות למאפיינים של QueryInfo. נכסים שלא יסופקו לא יותאמו.

פרמטרים

  • מידע

    QueryInfo

    המאפיינים שצריך לחפש.

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    (entries: ReadingListEntry[]) => void

החזרות

  • Promise&lt;ReadingListEntry[]&gt;

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

removeEntry()

Promise 
chrome.readingList.removeEntry(
  info: RemoveOptions,
  callback?: function,
)

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

פרמטרים

  • מידע

    RemoveOptions

    הרשומה שצריך להסיר מרשימת הקריאה.

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-callback.

updateEntry()

Promise 
chrome.readingList.updateEntry(
  info: UpdateEntryOptions,
  callback?: function,
)

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

פרמטרים

  • הרשומה שרוצים לעדכן.

  • קריאה חוזרת (callback)

    פונקציה אופציונלי

    הפרמטר callback נראה כך: 

    () => void

החזרות

  • Promise<void>

    הבטחות נתמכות במניפסט מגרסה V3 ואילך, אבל ניתנות קריאות חוזרות (callback) בשביל תאימות לאחור. אי אפשר להשתמש בשניהם באותה קריאה לפונקציה. הפתרון של ההבטחה יהיה באותו סוג שהוענק ל-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 מתעדכן ברשימת הקריאה.

פרמטרים