chrome.readingList

תיאור

הרשאות

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

manifest.json:

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

זמינות

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

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

chrome.readingList.query(
  info: QueryInfo,
): Promise<ReadingListEntry[]>

chrome.readingList.removeEntry(
  info: RemoveOptions,
): Promise<void>

chrome.readingList.updateEntry(
  info: UpdateEntryOptions,
): Promise<void>

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

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

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