browser.readingList

Mô tả

Sử dụng API chrome.readingList để đọc và sửa đổi các mục trong Danh sách đọc.

Quyền

readingList

Để sử dụng Reading List API, 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 120 trở lên browser.* kể từ Chrome 148 MV3 trở lên

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.

Danh sách đọc cho thấy một số bài viết
Danh sách đọc cho thấy một số bài viết

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

Thứ tự sắp xếp mục

Các mục trong danh sách đọc không theo thứ tự nào cả.

Tính độc đáo của mặt hàng

Các mục được khoá theo URL. Điều này bao gồm cả chuỗi 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 phần 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 dùng browser.readingList.addEntry():

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

Mục hiển thị

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

const items = await browser.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ể sử dụng browser.readingList.updateEntry() để cập nhật tiêu đề, URL và trạng thái đọc. Mã sau đây đánh dấu một mục là đã đọc:

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

Xóa một mục

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

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

Mẫu tiện ích

Để xem thêm bản minh hoạ về tiện ích API Danh sách đọc, hãy xem Mẫu API Danh sách đọc.

Loại

AddEntryOptions

Thuộc tính

  • hasBeenRead

    boolean

    Sẽ là true nếu mục nhập đã được đọc.

  • tiêu đề

    chuỗi

    Tiêu đề của mục.

  • url

    chuỗi

    URL của mục.

QueryInfo

Thuộc tính

  • hasBeenRead

    boolean không bắt buộc

    Cho biết nên tìm các mục đã đọc (true) hay chưa đọc (false).

  • tiêu đề

    chuỗi không bắt buộc

    Tiêu đề cần tìm.

  • url

    chuỗi không bắt buộc

    Một URL để tìm kiếm.

ReadingListEntry

Thuộc tính

  • creationTime

    số

    Thời điểm tạo mục. Được ghi lại bằng mili giây kể từ ngày 1 tháng 1 năm 1970.

  • hasBeenRead

    boolean

    Sẽ là true nếu mục nhập đã được đọc.

  • lastUpdateTime

    số

    Lần gần đây nhất mục nhập được cập nhật. Giá trị này được tính bằng mili giây kể từ ngày 1 tháng 1 năm 1970.

  • tiêu đề

    chuỗi

    Tiêu đề của mục.

  • url

    chuỗi

    URL của mục.

RemoveOptions

Thuộc tính

  • url

    chuỗi

    URL cần xoá.

UpdateEntryOptions

Thuộc tính

  • hasBeenRead

    boolean không bắt buộc

    Trạng thái đã đọc mới. Trạng thái hiện tại sẽ được giữ nguyên nếu bạn không cung cấp giá trị.

  • tiêu đề

    chuỗi không bắt buộc

    Tiêu đề mới. Thẻ thông tin hiện có sẽ được giữ nguyên nếu bạn không cung cấp giá trị.

  • url

    chuỗi

    URL sẽ được cập nhật.

Phương thức

addEntry()

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

Thêm một mục vào danh sách đọc nếu mục đó chưa có.

Thông số

Giá trị trả về

  • Promise<void>

    Giải quyết sau khi mục nhập được thêm.

query()

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

Truy xuất tất cả các mục khớp với thuộc tính QueryInfo. Những cơ sở lưu trú không được cung cấp sẽ không được so khớp.

Thông số

  • info

    QueryInfo

    Các thuộc tính cần tìm kiếm.

Giá trị trả về

  • Promise<ReadingListEntry[]>

    Giải quyết sau khi các mục nhập đã được so khớp.

removeEntry()

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

Xoá một mục khỏi danh sách đọc nếu mục đó tồn tại.

Thông số

Giá trị trả về

  • Promise<void>

    Phân giải sau khi mục nhập đã bị xoá.

updateEntry()

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

Cập nhật một mục trong danh sách đọc nếu mục đó tồn tại.

Thông số

Giá trị trả về

  • Promise<void>

    Giải quyết sau khi các mục nhập trùng khớp được cập nhật.

Sự kiện

onEntryAdded

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

Được kích hoạt khi một ReadingListEntry được thêm vào danh sách đọc.

Thông số

onEntryRemoved

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

Được kích hoạt khi một ReadingListEntry bị xoá khỏi danh sách đọc.

Thông số

onEntryUpdated

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

Được kích hoạt khi một ReadingListEntry được cập nhật trong danh sách đọc.

Thông số