chrome.readingList

תיאור

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

הרשאות

readingList

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

manifest.json:

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

זמינות

Chrome 120+ MV3+

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

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 של רשימת הקריאה, ראו דוגמה ל-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()

הבטחה 
chrome.readingList.addEntry(
  entry: AddEntryOptions,
  callback?: function,
)

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

פרמטרים

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

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

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

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

    () => void

החזרות

  • הבטחה<Empty>

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

query()

הבטחה 
chrome.readingList.query(
  info: QueryInfo,
  callback?: function,
)

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

פרמטרים

  • מידע

    QueryInfo

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

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

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

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

    (entries: ReadingListEntry[]) => void

החזרות

  • Promise&lt;ReadingListEntry[]&gt;

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

removeEntry()

הבטחה 
chrome.readingList.removeEntry(
  info: RemoveOptions,
  callback?: function,
)

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

פרמטרים

  • מידע

    RemoveOptions

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

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

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

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

    () => void

החזרות

  • הבטחה<Empty>

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

updateEntry()

הבטחה 
chrome.readingList.updateEntry(
  info: UpdateEntryOptions,
  callback?: function,
)

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

פרמטרים

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

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

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

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

    () => void

החזרות

  • הבטחה<Empty>

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

פרמטרים