browser.readingList

Beschrijving

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

Rechten

readingList

Als je de Reading List API wilt gebruiken, voeg je het recht "readingList" toe aan het manifest-bestand van de extensie:

manifest.json:

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

Beschikbaarheid

Chrome 120+ browser.* sinds Chrome 148 MV3+

Chrome heeft een leeslijst in het zijvenster. Hiermee kunnen gebruikers webpagina's opslaan om ze later of offline te lezen. Gebruik de Reading List API om bestaande items op te halen en items aan de lijst toe te voegen of eruit te verwijderen.

Leeslijst met een aantal artikelen
Leeslijst met een aantal artikelen

Concepten en gebruik

Volgorde van items

Items in de leeslijst staan niet in een gegarandeerde volgorde.

Uniekheid van item

Items worden gecodeerd op URL. Dit omvat de hash- en querytekenreeks.

Toepassingen

In de volgende gedeelten worden enkele veelvoorkomende toepassingen van de Reading List API beschreven. Ga naar Voorbeelden van extensies voor volledige voorbeelden van extensies.

Een artikel toevoegen

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

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

Items tonen

Als je items uit de leeslijst wilt tonen, gebruik je de methode browser.readingList.query() om ze op te halen.

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

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

Een item markeren als gelezen

Je kunt browser.readingList.updateEntry() gebruiken om de titel, URL en leesstatus te updaten. Met de volgende code wordt een item gemarkeerd als gelezen:

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

Een item verwijderen

Gebruik browser.readingList.removeEntry() om een item te verwijderen:

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

Voorbeelden van extensies

Ga naar het voorbeeld van de Reading List API voor meer demo's van Reading List API-extensies.

Typen

AddEntryOptions

Eigenschappen

  • hasBeenRead

    booleaans

    Is true als het item is gelezen.

  • titel

    tekenreeks

    De titel van het item.

  • url

    tekenreeks

    De URL van het item.

QueryInfo

Eigenschappen

  • hasBeenRead

    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

  • creationTime

    getal

    De tijd waarop het item is gemaakt. Geregistreerd in milliseconden sinds 1 januari 1970.

  • hasBeenRead

    booleaans

    Is true als het item is gelezen.

  • lastUpdateTime

    getal

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

  • titel

    tekenreeks

    De titel van het item.

  • url

    tekenreeks

    De URL van het item.

RemoveOptions

Eigenschappen

  • url

    tekenreeks

    De URL die moet worden verwijderd.

UpdateEntryOptions

Eigenschappen

  • hasBeenRead

    booleaans optioneel

    De geüpdatete leesstatus. De bestaande status blijft behouden als er geen waarde wordt ingevoerd.

  • titel

    tekenreeks optioneel

    De nieuwe titel. De bestaande tegel blijft staan als er geen waarde wordt ingevoerd.

  • url

    tekenreeks

    De URL die wordt geüpdatet.

Methoden

addEntry()

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

Voegt een item toe aan de leeslijst als het nog niet bestaat.

Parameters

  • vermelding

    AddEntryOptions

    Het item dat je aan de leeslijst wilt toevoegen.

Retourzendingen

  • Promise<void>

    Wordt opgelost nadat de invoer is toegevoegd.

query()

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

Haalt alle items op die overeenkomen met de QueryInfo-eigenschappen. Eigenschappen die niet worden verstrekt, worden niet gematcht.

Parameters

  • info

    QueryInfo

    De property's waarnaar je wilt zoeken.

Retourzendingen

removeEntry()

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

Verwijdert een item uit de leeslijst als het bestaat.

Parameters

  • Het item dat je uit de leeslijst wilt verwijderen.

Retourzendingen

  • Promise<void>

    Wordt opgelost zodra de invoer is verwijderd.

updateEntry()

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

Updatet een item in de leeslijst als het bestaat.

Parameters

Retourzendingen

  • Promise<void>

    Wordt opgelost zodra de overeenkomende vermeldingen zijn geüpdatet.

Evenementen

onEntryAdded

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

Wordt geactiveerd als een ReadingListEntry wordt toegevoegd aan de leeslijst.

Parameters

onEntryRemoved

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

Wordt geactiveerd als een ReadingListEntry uit de leeslijst wordt verwijderd.

Parameters

onEntryUpdated

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

Wordt geactiveerd als een ReadingListEntry wordt geüpdatet in de leeslijst.

Parameters