chrome.readingList

Descrizione

Utilizza l'API chrome.readingList per leggere e modificare gli elementi nell'elenco di lettura.

Autorizzazioni

readingList

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 120+ MV3+

Nel riquadro laterale di Chrome è presente un elenco di lettura. Consente agli utenti di salvare le pagine web per leggerle in un secondo momento o quando sono offline. Usa l'API Reading List per recuperare gli elementi esistenti e aggiungerli o rimuoverli dall'elenco.

Elenco di lettura che mostra una serie di articoli
Elenco di lettura che mostra una serie di articoli

Concetti e utilizzo

Ordine degli articoli

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

Unicità dell'articolo

Gli elementi sono codificati in base all'URL. Sono inclusi l'hash e la stringa di query.

Casi d'uso

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

Aggiungere un articolo

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

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

Visualizza elementi

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

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

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

Contrassegnare un elemento come letto

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

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

Rimuovere una voce

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

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

Esempi di estensioni

Per altre demo sulle estensioni dell'API Reading List, vedi l'esempio dell'API Reading List.

Tipi

AddEntryOptions

Proprietà

  • hasBeenRead

    booleano

    Sarà true se la voce è stata letta.

  • titolo

    stringa

    Il titolo della voce.

  • url

    stringa

    L'URL della voce.

QueryInfo

Proprietà

  • hasBeenRead

    booleano facoltativo

    Indica se cercare gli elementi già letti (true) o da leggere (false).

  • titolo

    stringa facoltativa

    Un titolo da cercare.

  • url

    stringa facoltativo

    Un URL da cercare.

ReadingListEntry

Proprietà

  • creationTime

    numero

    L'ora in cui è stata creata la voce. Registrato in millisecondi dal 1° gennaio 1970.

  • hasBeenRead

    booleano

    Sarà true se la voce è stata letta.

  • lastUpdateTime

    numero

    L'ultima volta che la voce è stata aggiornata. Questo valore è espresso in millisecondi dal 1° gennaio 1970.

  • titolo

    stringa

    Il titolo della voce.

  • url

    stringa

    L'URL della voce.

RemoveOptions

Proprietà

  • url

    stringa

    L'URL da rimuovere.

UpdateEntryOptions

Proprietà

  • hasBeenRead

    booleano facoltativo

    Lo stato di lettura aggiornato. Lo stato esistente rimane se non viene fornito un valore.

  • titolo

    stringa facoltativo

    Il nuovo titolo. Il riquadro esistente rimane invariato se non viene fornito un valore.

  • url

    stringa

    L'URL che verrà aggiornato.

Metodi

addEntry()

Promessa 
chrome.readingList.addEntry(
  entry: AddEntryOptions,
  callback?: function,
)

Aggiunge una voce all'elenco di lettura, se non esiste.

Parametri

  • La voce da aggiungere all'elenco di lettura.

  • callback

    function facoltativa

    Il parametro callback ha il seguente aspetto: 

    () => void

Resi

  • Promise<void>

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambe nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

query()

Promessa 
chrome.readingList.query(
  info: QueryInfo,
  callback?: function,
)

Recupera tutte le voci corrispondenti alle proprietà QueryInfo. Le proprietà che non sono specificate non avranno corrispondenze.

Parametri

Resi

  • Promise<ReadingListEntry[]>

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambe nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

removeEntry()

Promessa 
chrome.readingList.removeEntry(
  info: RemoveOptions,
  callback?: function,
)

Rimuove una voce dall'elenco di lettura, se esistente.

Parametri

  • informazioni

    RemoveOptions

    La voce da rimuovere dall'elenco di lettura.

  • callback

    function facoltativa

    Il parametro callback ha il seguente aspetto: 

    () => void

Resi

  • Promise&lt;void&gt;

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambe nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

updateEntry()

Promessa 
chrome.readingList.updateEntry(
  info: UpdateEntryOptions,
  callback?: function,
)

Aggiorna una voce dell'elenco di lettura, se esistente.

Parametri

  • informazioni

    UpdateEntryOptions

    La voce da aggiornare.

  • callback

    function facoltativa

    Il parametro callback ha il seguente aspetto: 

    () => void

Resi

  • Promise&lt;void&gt;

    Le promesse sono supportate in Manifest V3 e versioni successive, ma i callback vengono forniti per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

Eventi

onEntryAdded

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

Si attiva quando un ReadingListEntry viene aggiunto all'elenco di lettura.

Parametri

onEntryRemoved

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

Viene attivato quando un ReadingListEntry viene rimosso dall'elenco di lettura.

Parametri

onEntryUpdated

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

Si attiva quando viene aggiornato un ReadingListEntry nell'elenco di lettura.

Parametri