Beschrijving
Gebruik de chrome.readingList API om items in de leeslijst te lezen en te wijzigen.
Toestemmingen
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 te verwijderen.
Concepten en gebruik
Artikel bestellen
De items op de leeslijst staan niet in een vaste volgorde.
Uniekheid van het item
Items worden gekoppeld aan de hand van de URL. Dit omvat de hash en de queryreeks.
Gebruiksvoorbeelden
De volgende secties illustreren enkele veelvoorkomende gebruiksscenario's voor de Reading List API. Zie de voorbeelden van extensies voor complete voorbeelden.
Een item toevoegen
Om een item aan de leeslijst toe te voegen, gebruik je chrome.readingList.addEntry() :
chrome.readingList.addEntry({
title: "New to the web platform in September | web.dev",
url: "https://developer.chrome.com/",
hasBeenRead: false
});
Toon artikelen
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
Je 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, gebruik je chrome.readingList.removeEntry() :
chrome.readingList.removeEntry({
url: "https://developer.chrome.com/"
});
Uitbreidingsvoorbeelden
Voor meer demonstraties van API-extensies voor leeslijsten, zie het voorbeeld van de API voor leeslijsten .
Soorten
AddEntryOptions
Eigenschappen
- hasBeenRead
booleaans
Dit is
trueals het bericht is gelezen. - titel
snaar
De titel van het item.
- URL
snaar
De URL van het bericht.
QueryInfo
Eigenschappen
- hasBeenRead
boolean optioneel
Geeft aan of er gezocht moet worden naar gelezen (
true) of ongelezen (false) items. - titel
string optioneel
Een titel om naar te zoeken.
- URL
string optioneel
Een URL om naar te zoeken.
ReadingListEntry
Eigenschappen
- creatietijd
nummer
Het tijdstip waarop de vermelding is aangemaakt. Geregistreerd in milliseconden sinds 1 januari 1970.
- hasBeenRead
booleaans
Dit is
trueals het bericht is gelezen. - lastUpdateTime
nummer
De laatste keer dat de gegevens zijn bijgewerkt. Deze waarde is in milliseconden sinds 1 januari 1970.
- titel
snaar
De titel van het item.
- URL
snaar
De URL van het bericht.
RemoveOptions
Eigenschappen
- URL
snaar
De URL die verwijderd moet worden.
UpdateEntryOptions
Eigenschappen
- hasBeenRead
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 er nog niet in staat.
Parameters
- invoer
Het item om toe te voegen aan de leeslijst.
Retourneert
Promise<void>
Wordt opgelost zodra de vermelding is toegevoegd.
query()
chrome.readingList.query(
info: QueryInfo,
): Promise<ReadingListEntry[]>
Haalt alle resultaten op die overeenkomen met de QueryInfo eigenschappen. Eigenschappen die niet worden opgegeven, worden niet meegenomen in de zoekresultaten.
Parameters
- informatie
De eigenschappen waarnaar gezocht moet worden.
Retourneert
Promise< ReadingListEntry []>
De zoekopdracht wordt voltooid zodra de resultaten overeenkomen.
removeEntry()
chrome.readingList.removeEntry(
info: RemoveOptions,
): Promise<void>
Verwijdert een item uit de leeslijst, indien aanwezig.
Parameters
- informatie
Het item dat van de leeslijst verwijderd moet worden.
Retourneert
Promise<void>
Het probleem is opgelost zodra de vermelding is verwijderd.
updateEntry()
chrome.readingList.updateEntry(
info: UpdateEntryOptions,
): Promise<void>
Werkt een item in de leeslijst bij, indien aanwezig.
Parameters
- informatie
De te actualiseren invoer.
Retourneert
Promise<void>
Het probleem wordt opgelost zodra de overeenkomende vermeldingen zijn bijgewerkt.
Evenementen
onEntryAdded
chrome.readingList.onEntryAdded.addListener(
callback: function,
)
Wordt geactiveerd wanneer een ReadingListEntry aan de leeslijst wordt toegevoegd.
Parameters
- terugbelverzoek
functie
De
callbackparameter ziet er als volgt uit:(entry: ReadingListEntry) => void
- invoer
onEntryRemoved
chrome.readingList.onEntryRemoved.addListener(
callback: function,
)
Wordt geactiveerd wanneer een ReadingListEntry uit de leeslijst wordt verwijderd.
Parameters
- terugbelverzoek
functie
De
callbackparameter ziet er als volgt uit:(entry: ReadingListEntry) => void
- invoer
onEntryUpdated
chrome.readingList.onEntryUpdated.addListener(
callback: function,
)
Wordt geactiveerd wanneer een item in de leeslijst ReadingListEntry ) wordt bijgewerkt.
Parameters
- terugbelverzoek
functie
De
callbackparameter ziet er als volgt uit:(entry: ReadingListEntry) => void
- invoer