chrome.readingList

Mô tả

Quyền

Để sử dụng Reading List API (API Danh sách đọc), hãy thêm quyền "readingList" vào tệp manifest của tiện ích:

manifest.json:

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

Phạm vi cung cấp

Chrome có một danh sách đọc nằm trên bảng điều khiển bên. Tính năng này cho phép người dùng lưu các trang web để đọc sau hoặc khi không có mạng. Sử dụng Reading List API để truy xuất các mục hiện có và thêm hoặc xoá các mục khỏi danh sách.

Khái niệm và cách sử dụng

Thứ tự sắp xếp mặt hàng

Các mục trong danh sách đọc không được sắp xếp theo thứ tự đảm bảo.

Tính duy nhất của mặt hàng

Các mục được khoá bằng URL. Điều này bao gồm cả hàm băm và chuỗi truy vấn.

Trường hợp sử dụng

Các phần sau đây minh hoạ một số trường hợp sử dụng phổ biến cho Reading List API. Hãy xem Các mẫu tiện ích để biết các ví dụ đầy đủ về tiện ích.

Thêm một mục

Để thêm một mục vào danh sách đọc, hãy sử dụng biểu tượng chrome.readingList.addEntry():

chrome.readingList.addEntry({   title: "New to the web platform in September | web.dev",   url: "https://developer.chrome.com/",   hasBeenRead: false }); 

Hiển thị các mục

Để hiển thị các mục trong danh sách đọc, hãy sử dụng phương thức chrome.readingList.query() để truy xuất các mục đó.

const items = await chrome.readingList.query({});  for (const item of items) {   // Do something do display the item } 

Đánh dấu một mục là đã đọc

Bạn có thể dùng chrome.readingList.updateEntry() để cập nhật tiêu đề, URL và trạng thái đã đọc. Đoạn mã sau đây đánh dấu một mục là đã đọc:

chrome.readingList.updateEntry({   url: "https://developer.chrome.com/",   hasBeenRead: true }); 

Xóa một mục

Để xoá một mục, hãy dùng chrome.readingList.removeEntry():

chrome.readingList.removeEntry({   url: "https://developer.chrome.com/" }); 

Mẫu tiện ích

Để xem thêm các bản minh hoạ về tiện ích Reading List API, hãy xem mẫu 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,
)