chrome.readingList

Descrizione

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

Autorizzazioni

readingList

Per utilizzare l'API Elenco di lettura, aggiungi l'autorizzazione "readingList" nel file manifest dell'estensione:

manifest.json:

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

Disponibilità

Chrome 120+ MV3+

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

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

Concetti e utilizzo

Ordinamento degli articoli

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

Unicità dell'articolo

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

Casi d'uso

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

Aggiungere un articolo

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

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

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 di estensioni dell'API Reading List, consulta 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 elementi letti (true) o da leggere (false).

  • titolo

    stringa facoltativa

    Un titolo da cercare.

  • url

    stringa facoltativa

    Un URL da cercare.

ReadingListEntry

Proprietà

  • creationTime

    numero

    L'ora in cui è stata creata la voce. Registrato in millisecondi a partire 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 a partire 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 invariato se non viene fornito un valore.

  • titolo

    stringa facoltativa

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

  • url

    stringa

    L'URL che verrà aggiornato.

Metodi

addEntry()

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

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

Parametri

Resi

  • Promise<void>

query()

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

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

Parametri

  • informazioni

    QueryInfo

    Le proprietà da cercare.

Resi

removeEntry()

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

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

Parametri

  • informazioni

    RemoveOptions

    La voce da rimuovere dall'elenco di lettura.

Resi

  • Promise<void>

updateEntry()

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

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

Parametri

Resi

  • Promise<void>

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

Attivato quando un ReadingListEntry viene rimosso dall'elenco di lettura.

Parametri

onEntryUpdated

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

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

Parametri