chrome.leeslijst

Beschrijving

Gebruik de chrome.readingList API om de items in de Leeslijst te lezen en te wijzigen.

Rechten

readingList

Om de Leeslijst-API te gebruiken, voegt u de machtiging "readingList" toe aan het extensiemanifestbestand :

manifest.json:

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

Beschikbaarheid

Chroom 120+ MV3+

Chrome heeft een leeslijst op het zijpaneel. Hiermee kunnen gebruikers webpagina's opslaan om later of offline te lezen. Gebruik de Leeslijst-API om bestaande items op te halen en items aan de lijst toe te voegen of te verwijderen.

Leeslijst met daarin een aantal artikelen
Leeslijst met daarin een aantal artikelen

Concepten en gebruik

Artikel bestellen

Items in de leeslijst staan ​​niet in een gegarandeerde volgorde.

Uniciteit van het item

Items worden gecodeerd op URL. Dit omvat de hash en de queryreeks.

Gebruiksgevallen

In de volgende secties worden enkele veelvoorkomende gebruiksscenario's voor de Leeslijst-API gedemonstreerd. Zie Extensievoorbeelden voor volledige extensievoorbeelden.

Voeg een artikel toe

Gebruik chrome.readingList.addEntry() om een ​​item aan de leeslijst toe te voegen:

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

Artikelen weergeven

Om items uit de leeslijst weer te geven, gebruikt u de chrome.readingList.query() methode om ze op te halen. methode.

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

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

Markeer een item als gelezen

U kunt chrome.readingList.updateEntry() gebruiken om de titel, URL en leesstatus bij te werken. De volgende code markeert een item als gelezen:

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

Een artikel verwijderen

Om een ​​item te verwijderen, gebruik je chrome.readingList.removeEntry() :

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

Extensiemonsters

Voor meer demo's van de Reading List API-extensies raadpleegt u het Reading List API-voorbeeld .

Soorten

AddEntryOptions

Eigenschappen

  • is gelezen

    Booleaans

    Zal true zijn als het item is gelezen.

  • titel

    snaar

    De titel van het bericht.

  • URL

    snaar

    De URL van het item.

QueryInfo

Eigenschappen

  • is gelezen

    Booleaans optioneel

    Geeft aan of er moet worden gezocht naar gelezen ( true ) of ongelezen ( false ) items.

  • titel

    tekenreeks optioneel

    Een titel om naar te zoeken.

  • URL

    tekenreeks optioneel

    Een URL om naar te zoeken.

ReadingListEntry

Eigenschappen

  • creatieTijd

    nummer

    Het tijdstip waarop het item is gemaakt. Opgenomen in milliseconden sinds 1 januari 1970.

  • is gelezen

    Booleaans

    Zal true zijn als het item is gelezen.

  • laatsteUpdateTime

    nummer

    De laatste keer dat het item is bijgewerkt. Deze waarde is in milliseconden sinds 1 januari 1970.

  • titel

    snaar

    De titel van het bericht.

  • URL

    snaar

    De URL van het item.

RemoveOptions

Eigenschappen

  • URL

    snaar

    De URL die moet worden verwijderd.

UpdateEntryOptions

Eigenschappen

  • is gelezen

    Booleaans optioneel

    De bijgewerkte leesstatus. De bestaande status blijft bestaan ​​als er geen waarde wordt opgegeven.

  • titel

    tekenreeks optioneel

    De nieuwe titel. De bestaande tegel blijft bestaan ​​als er geen waarde wordt opgegeven.

  • URL

    snaar

    De URL die wordt bijgewerkt.

Methoden

addEntry()

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

Voegt een vermelding toe aan de leeslijst als deze nog niet bestaat.

Parameters

  • Het item dat moet worden toegevoegd aan de leeslijst.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    ()=>void

Geeft terug

  • Beloof <nietig>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

query()

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

Haalt alle vermeldingen op die overeenkomen met de QueryInfo eigenschappen. Eigenschappen die niet zijn opgegeven, worden niet gematcht.

Parameters

  • informatie

    QueryInfo

    De eigenschappen waarnaar moet worden gezocht.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (entries: ReadingListEntry[])=>void

Geeft terug

  • Belofte< ReadingListEntry []>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

removeEntry()

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

Verwijdert een item uit de leeslijst als het bestaat.

Parameters

  • informatie

    Opties verwijderen

    Het item dat uit de leeslijst moet worden verwijderd.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    ()=>void

Geeft terug

  • Beloof <nietig>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

updateEntry()

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

Werkt een leeslijstvermelding bij als deze bestaat.

Parameters

  • informatie

    UpdateEntryOptions

    Het item dat moet worden bijgewerkt.

  • Bel terug

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    ()=>void

Geeft terug

  • Beloof <nietig>

    Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.

Evenementen

onEntryAdded

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

Wordt geactiveerd wanneer een ReadingListEntry wordt toegevoegd aan de leeslijst.

Parameters

onEntryRemoved

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

Wordt geactiveerd wanneer een ReadingListEntry uit de leeslijst wordt verwijderd.

Parameters

onEntryUpdated

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

Wordt geactiveerd wanneer een ReadingListEntry wordt bijgewerkt in de leeslijst.

Parameters