chrome.readingList

Descrizione

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

Autorizzazioni

readingList

Per usare 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 e versioni successive MV3 o versioni successive

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 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

Ordinazione articolo

Gli elementi nell'elenco di lettura non sono in alcun 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. Per esempi completi di estensioni, consulta Esempi 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 dall'elenco di lettura, utilizza il metodo chrome.readingList.query() per recuperarli. 

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
});

Rimuovi un elemento

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 di API Reading List.

Tipi

AddEntryOptions

Proprietà

  • hasBeenRead

    boolean

    Se la voce è stata letta, sarà true.

  • title

    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).

  • title

    stringa facoltativo

    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

    boolean

    Se la voce è stata letta, sarà true.

  • lastUpdateTime

    numero

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

  • title

    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. Se non viene specificato un valore, lo stato esistente rimane invariato.

  • title

    stringa facoltativo

    Il nuovo titolo. Il riquadro esistente rimane 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

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    ()=>void

Ritorni

  • Promise<void>

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per garantire la compatibilità con le versioni precedenti. Non puoi utilizzarli entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo trasmesso al callback.

query()

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

Recupera tutte le voci che corrispondono alle proprietà QueryInfo. Le proprietà non fornite non corrisponderanno.

Parametri

Ritorni

  • Promise<ReadingListEntry[]>

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per garantire la compatibilità con le versioni precedenti. Non puoi utilizzarli entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo trasmesso 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

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    ()=>void

Ritorni

  • Promise<void>

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per garantire la compatibilità con le versioni precedenti. Non puoi utilizzarli entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo trasmesso 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

    funzione facoltativa

    Il parametro callback ha il seguente aspetto: 

    ()=>void

Ritorni

  • Promise<void>

    Le promesse sono supportate in Manifest V3 e versioni successive, ma vengono forniti callback per garantire la compatibilità con le versioni precedenti. Non puoi utilizzarli entrambi nella stessa chiamata di funzione. La promessa viene risolta con lo stesso tipo trasmesso al callback.

Eventi

onEntryAdded

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

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

Parametri

onEntryRemoved

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

Si attiva quando un oggetto ReadingListEntry viene rimosso dall'elenco di lettura.

Parametri

onEntryUpdated

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

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

Parametri