browser.readingList

Deskripsi

Gunakan chrome.readingList API untuk membaca dan mengubah item dalam Daftar Bacaan.

Izin

readingList

Untuk menggunakan Reading List API, tambahkan izin "readingList" dalam file manifest ekstensi:

manifest.json:

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

Ketersediaan

Chrome 120+ browser.* sejak Chrome 148 MV3+

Chrome memiliki daftar bacaan yang terletak di panel samping. Fitur ini memungkinkan pengguna menyimpan halaman web untuk dibaca nanti atau saat offline. Gunakan Reading List API untuk mengambil item yang ada dan menambahkan atau menghapus item dari daftar.

Daftar bacaan yang menampilkan sejumlah artikel
Daftar bacaan yang menampilkan sejumlah artikel

Konsep dan penggunaan

Pengurutan item

Item dalam daftar bacaan tidak memiliki urutan yang dijamin.

Keunikan item

Item diidentifikasi berdasarkan URL. Hal ini mencakup hash dan string kueri.

Kasus penggunaan

Bagian berikut menunjukkan beberapa kasus penggunaan umum untuk Reading List API. Lihat Contoh ekstensi untuk mengetahui contoh ekstensi lengkap.

Tambahkan item

Untuk menambahkan item ke daftar bacaan, gunakan browser.readingList.addEntry():

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

Menampilkan item

Untuk menampilkan item dari daftar bacaan, gunakan metode browser.readingList.query() untuk mengambilnya.

const items = await browser.readingList.query({});

for (const item of items) {
  // Do something do display the item
}

Menandai item sebagai sudah dibaca

Anda dapat menggunakan browser.readingList.updateEntry() untuk memperbarui judul, URL, dan status baca. Kode berikut menandai item sebagai telah dibaca:

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

Menghapus item

Untuk menghapus item, gunakan browser.readingList.removeEntry():

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

Contoh ekstensi

Untuk demo ekstensi Reading List API lainnya, lihat contoh Reading List API.

Jenis

AddEntryOptions

Properti

  • hasBeenRead

    boolean

    Akan menjadi true jika entri telah dibaca.

  • judul

    string

    Judul entri.

  • url

    string

    URL entri.

QueryInfo

Properti

  • hasBeenRead

    boolean opsional

    Menunjukkan apakah akan menelusuri item yang sudah dibaca (true) atau belum dibaca (false).

  • judul

    string opsional

    Judul yang akan ditelusuri.

  • url

    string opsional

    URL yang akan ditelusuri.

ReadingListEntry

Properti

  • creationTime

    angka

    Waktu pembuatan entri. Dicatat dalam milidetik sejak 1 Jan 1970.

  • hasBeenRead

    boolean

    Akan menjadi true jika entri telah dibaca.

  • lastUpdateTime

    angka

    Waktu terakhir entri diperbarui. Nilai ini dalam milidetik sejak 1 Januari 1970.

  • judul

    string

    Judul entri.

  • url

    string

    URL entri.

RemoveOptions

Properti

  • url

    string

    URL yang akan dihapus.

UpdateEntryOptions

Properti

  • hasBeenRead

    boolean opsional

    Status baca yang diperbarui. Status yang ada akan tetap ada jika nilai tidak diberikan.

  • judul

    string opsional

    Judul baru. Kartu yang ada akan tetap ada jika nilai tidak diberikan.

  • url

    string

    URL yang akan diperbarui.

Metode

addEntry()

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

Menambahkan entri ke daftar bacaan jika belum ada.

Parameter

Hasil

  • Promise<void>

    Menyelesaikan setelah entri ditambahkan.

query()

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

Mengambil semua entri yang cocok dengan properti QueryInfo. Properti yang tidak diberikan tidak akan dicocokkan.

Parameter

  • info

    QueryInfo

    Properti yang akan ditelusuri.

Hasil

removeEntry()

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

Menghapus entri dari daftar bacaan jika ada.

Parameter

Hasil

  • Promise<void>

    Menyelesaikan setelah entri dihapus.

updateEntry()

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

Memperbarui entri daftar bacaan jika ada.

Parameter

Hasil

  • Promise<void>

    Me-resolve setelah entri yang cocok diperbarui.

Acara

onEntryAdded

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

Dipicu saat ReadingListEntry ditambahkan ke daftar bacaan.

Parameter

onEntryRemoved

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

Dipicu saat ReadingListEntry dihapus dari daftar bacaan.

Parameter

onEntryUpdated

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

Dipicu saat ReadingListEntry diperbarui di daftar bacaan.

Parameter