Beschrijving
Gebruik de chrome.readingList API om items in de leeslijst te lezen en te wijzigen.
Machtigingen
readingList Om de Reading List API te gebruiken, voegt u de machtiging "readingList" toe aan het manifestbestand van de extensie:
manifest.json:
{
"name": "My reading list extension",
...
"permissions": [
"readingList"
]
}
Beschikbaarheid
Chrome heeft een leeslijst in het zijpaneel. Hiermee kunnen gebruikers webpagina's opslaan om 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.
Begrippen en gebruik
Artikelbestelling
De volgorde van de items in de leeslijst is niet gegarandeerd.
Uniekheid van het item
Items worden gekoppeld aan een URL. Dit omvat de hash en querystring.
Gebruiksscenario's
De volgende secties tonen enkele veelvoorkomende use cases voor de Reading List API. Zie de extensievoorbeelden voor volledige extensievoorbeelden.
Een item toevoegen
Om een item aan de leeslijst toe te voegen, gebruikt u chrome.readingList.addEntry() :
chrome.readingList.addEntry({
title: "New to the web platform in September | web.dev",
url: "https://developer.chrome.com/",
hasBeenRead: false
});
Weergave-items
Om items uit de leeslijst weer te geven, gebruikt u de methode chrome.readingList.query() om ze op te halen.
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 item verwijderen
Om een item te verwijderen, gebruikt u chrome.readingList.removeEntry() :
chrome.readingList.removeEntry({
url: "https://developer.chrome.com/"
});
Extensiemonsters
Zie het Reading List API- voorbeeld voor meer demo's van Reading List API- extensies.
Typen
AddEntryOptions
Eigenschappen
- is gelezen
Booleaanse
Zal
truezijn als het item gelezen is. - titel
snaar
De titel van het item.
- url
snaar
De url van het item.
QueryInfo
Eigenschappen
- is gelezen
boolean optioneel
Geeft aan of er naar gelezen (
true) of ongelezen (false) items moet worden gezocht. - titel
string optioneel
Een titel om naar te zoeken.
- url
string optioneel
Een URL waarnaar gezocht moet worden.
ReadingListEntry
Eigenschappen
- scheppingstijd
nummer
Het tijdstip waarop het item is aangemaakt. Vastgelegd in milliseconden sinds 1 januari 1970.
- is gelezen
Booleaanse
Zal
truezijn als het item gelezen is. - laatsteUpdateTijd
nummer
De laatste keer dat het item is bijgewerkt. Deze waarde is in milliseconden sinds 1 januari 1970.
- titel
snaar
De titel van het item.
- url
snaar
De url van het item.
RemoveOptions
Eigenschappen
- url
snaar
De url die verwijderd moet worden.
UpdateEntryOptions
Eigenschappen
- is gelezen
boolean optioneel
De bijgewerkte leesstatus. De bestaande status blijft behouden als er geen waarde wordt opgegeven.
- titel
string optioneel
De nieuwe titel. De bestaande tegel blijft behouden als er geen waarde wordt opgegeven.
- url
snaar
De URL die wordt bijgewerkt.
Methoden
addEntry()
chrome.readingList.addEntry(
entry: AddEntryOptions,
): Promise<void>
Voegt een item toe aan de leeslijst als het nog niet bestaat.
Parameters
- toegang
Het item dat aan de leeslijst moet worden toegevoegd.
Retourneren
Belofte<leegte>
query()
chrome.readingList.query(
info: QueryInfo,
): Promise<ReadingListEntry[]>
Haalt alle items op die voldoen aan de QueryInfo eigenschappen. Eigenschappen die niet zijn opgegeven, worden niet gematcht.
Parameters
- informatie
De eigenschappen waarnaar u wilt zoeken.
Retourneren
Belofte< ReadingListEntry []>
removeEntry()
chrome.readingList.removeEntry(
info: RemoveOptions,
): Promise<void>
Verwijdert een item uit de leeslijst als het bestaat.
Parameters
- informatie
Het item dat u uit de leeslijst wilt verwijderen.
Retourneren
Belofte<leegte>
updateEntry()
chrome.readingList.updateEntry(
info: UpdateEntryOptions,
): Promise<void>
Werkt een vermelding in de leeslijst bij als deze bestaat.
Parameters
- informatie
Het item dat moet worden bijgewerkt.
Retourneren
Belofte<leegte>
Evenementen
onEntryAdded
chrome.readingList.onEntryAdded.addListener(
callback: function,
)
Wordt geactiveerd wanneer een ReadingListEntry aan de leeslijst wordt toegevoegd.
Parameters
- terugbellen
functie
De
callbackziet er als volgt uit:(entry: ReadingListEntry) => void
- toegang
onEntryRemoved
chrome.readingList.onEntryRemoved.addListener(
callback: function,
)
Wordt geactiveerd wanneer een ReadingListEntry uit de leeslijst wordt verwijderd.
Parameters
- terugbellen
functie
De
callbackziet er als volgt uit:(entry: ReadingListEntry) => void
- toegang
onEntryUpdated
chrome.readingList.onEntryUpdated.addListener(
callback: function,
)
Wordt geactiveerd wanneer een ReadingListEntry wordt bijgewerkt in de leeslijst.
Parameters
- terugbellen
functie
De
callbackziet er als volgt uit:(entry: ReadingListEntry) => void
- toegang