תיאור
אפשר להשתמש ב-API chrome.readingList
כדי לקרוא פריטים ברשימת הקריאה ולשנות אותם.
הרשאות
readingList
כדי להשתמש ב-API של רשימת הקריאה, מוסיפים את ההרשאה "readingList"
בקובץ המניפסט של התוסף:
manifest.json:
{
"name": "My reading list extension",
...
"permissions": [
"readingList"
]
}
זמינות
ב-Chrome מופיעה רשימת קריאה בחלונית הצדדית. היא מאפשרת למשתמשים לשמור דפי אינטרנט כדי לקרוא אותם מאוחר יותר או כשהם במצב אופליין. השתמש בממשק ה-API של רשימת הקריאה כדי לאחזר פריטים קיימים ולהוסיף או להסיר פריטים לרשימה.
מושגים ושימוש
סדר הפריטים
הסדר של הפריטים ברשימת הקריאה לא מובטח.
ייחודיות הפריט
המפתחות לפריטים לפי כתובת URL. זה כולל את הגיבוב ואת מחרוזת השאילתה.
תרחישים לדוגמה
הקטעים הבאים מציגים כמה תרחישים נפוצים של שימוש ב-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 של רשימת קריאה, ראו את דוגמה של ממשק API של רשימת קריאה.
סוגים
AddEntryOptions
תכונות
-
hasBeenRead
boolean
אם הרשומה נקראה, הערך יהיה
true
. -
title
מחרוזת
כותרת הרשומה.
-
כתובת אתר
מחרוזת
כתובת ה-URL של הרשומה.
QueryInfo
תכונות
-
hasBeenRead
בוליאני אופציונלי
מציין אם לחפש פריטים שנקראו (
true
) או פריטים שלא נקראו (false
). -
title
מחרוזת אופציונלי
כותרת לחיפוש.
-
כתובת אתר
מחרוזת אופציונלי
כתובת URL לחיפוש.
ReadingListEntry
תכונות
-
creationTime
מספר
השעה שבה הרשומה נוצרה. הוקלט באלפיות שנייה מ-1 בינואר 1970.
-
hasBeenRead
boolean
אם הרשומה נקראה, הערך יהיה
true
. -
lastUpdateTime
מספר
הפעם האחרונה שבה הרשומה עודכנה. הערך הזה הוא באלפיות השנייה מ-1 בינואר 1970.
-
title
מחרוזת
כותרת הרשומה.
-
כתובת אתר
מחרוזת
כתובת ה-URL של הרשומה.
RemoveOptions
תכונות
-
כתובת אתר
מחרוזת
כתובת ה-URL להסרה.
UpdateEntryOptions
תכונות
-
hasBeenRead
בוליאני אופציונלי
סטטוס הקריאה המעודכן. הסטטוס הקיים יישאר אם לא תספקו ערך.
-
title
מחרוזת אופציונלי
השם החדש. אם לא מזינים ערך, המשבצת הקיימת לא משתנה.
-
כתובת אתר
מחרוזת
כתובת ה-URL שתעודכן.
שיטות
addEntry()
chrome.readingList.addEntry(
entry: AddEntryOptions,
callback?: function,
)
הוספת רשומה לרשימת הקריאה אם היא לא קיימת.
פרמטרים
-
רשומה
הערך שצריך להוסיף לרשימת הקריאה.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.
query()
chrome.readingList.query(
info: QueryInfo,
callback?: function,
)
מאחזר את כל הרשומות שתואמות למאפיינים של QueryInfo
. נכסים שלא סופקו לא יותאמו.
פרמטרים
-
מידע
המאפיינים שצריך לחפש.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(entries: ReadingListEntry[]) => void
-
רשומות
-
החזרות
-
Promise<ReadingListEntry[]>
יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.
removeEntry()
chrome.readingList.removeEntry(
info: RemoveOptions,
callback?: function,
)
הסרה של רשומה מרשימת הקריאה, אם היא קיימת.
פרמטרים
-
מידע
הערך להסרה מרשימת הקריאה.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.
updateEntry()
chrome.readingList.updateEntry(
info: UpdateEntryOptions,
callback?: function,
)
מעדכנת רשומה ברשימת הקריאה, אם יש כזו.
פרמטרים
-
מידע
הרשומה שיש לעדכן.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
יש תמיכה בהבטחות במניפסט מגרסה V3 ואילך, אבל אפשר לבצע קריאה חוזרת (callback) לצורך תאימות לאחור. אי אפשר להשתמש בשתיהן באותה בקשה להפעלת פונקציה. ההבטחה מסתיימת עם אותו הסוג שמועבר לקריאה החוזרת.
אירועים
onEntryAdded
chrome.readingList.onEntryAdded.addListener(
callback: function,
)
מופעל כאשר ReadingListEntry
נוסף לרשימת הקריאה.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(entry: ReadingListEntry) => void
-
רשומה
-
onEntryRemoved
chrome.readingList.onEntryRemoved.addListener(
callback: function,
)
מופעל כאשר ReadingListEntry
מוסר מרשימת הקריאה.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(entry: ReadingListEntry) => void
-
רשומה
-
onEntryUpdated
chrome.readingList.onEntryUpdated.addListener(
callback: function,
)
מופעל כשReadingListEntry
ברשימת הקריאה מתעדכן.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:(entry: ReadingListEntry) => void
-
רשומה
-