browser.readingList

Descrizione

Autorizzazioni

Per utilizzare l'API Reading List, aggiungi l'autorizzazione "readingList" nel file manifest dell'estensione:

manifest.json:

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

Disponibilità

Chrome dispone di un elenco di lettura situato nel riquadro laterale. Consente agli utenti di salvare le pagine web per leggerle in un secondo momento o quando sono offline. Utilizza l'API Reading List per recuperare gli elementi esistenti e aggiungere o rimuovere elementi dall'elenco.

Concetti e utilizzo

Ordinamento degli elementi

Gli elementi nell'elenco di lettura non sono in un ordine garantito.

Unicità degli articoli

Gli elementi sono identificati dall'URL. Sono inclusi l'hash e la stringa di query.

Casi d'uso

Le sezioni seguenti mostrano alcuni casi d'uso comuni dell'API Reading List. Consulta Esempi di estensioni per esempi completi di estensioni.

Aggiungere un articolo

Per aggiungere un elemento all'elenco di lettura, utilizza browser.readingList.addEntry():

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

Elementi display

Per visualizzare gli elementi dell'elenco di lettura, utilizza il metodo browser.readingList.query() per recuperarli.

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

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

Contrassegna un elemento come letto

Puoi utilizzare browser.readingList.updateEntry() per aggiornare il titolo, l'URL e lo stato di lettura. Il seguente codice contrassegna un elemento come letto:

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

Rimuovere una voce

Per rimuovere un elemento, utilizza browser.readingList.removeEntry():

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

Esempi di estensioni

Per altre demo delle estensioni dell'API Reading List, consulta l'esempio di API Reading List.

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

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

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

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

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

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

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