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() เพื่อดึงข้อมูล 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

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,
)