Beschreibung
Mit der chrome.readingList
API kannst du aus den Elementen in der Leseliste lesen und diese ändern.
Berechtigungen
readingList
Wenn Sie die Reading List API verwenden möchten, fügen Sie in der Datei manifest der Erweiterung die Berechtigung "readingList"
hinzu:
manifest.json:
{
"name": "My reading list extension",
...
"permissions": [
"readingList"
]
}
Verfügbarkeit
In der Seitenleiste von Chrome befindet sich eine Leseliste. Damit können Nutzer Webseiten speichern, um sie später oder offline zu lesen. Mit der Reading List API können Sie vorhandene Elemente abrufen und Elemente zur Liste hinzufügen oder daraus entfernen.
![Leseliste mit einer Reihe von Artikeln](https://developer.chrome.google.cn/static/docs/extensions/reference/api/readingList/image/reading-list-showing-num-a0718c5ab1fe5.png?authuser=6&hl=de)
Konzepte und Nutzung
Artikelreihenfolge
Die Reihenfolge der Elemente auf der Leseliste ist nicht garantiert.
Eindeutigkeit des Elements
Elemente werden nach URL eingegeben. Dies schließt den Hash und den Abfragestring ein.
Anwendungsfälle
In den folgenden Abschnitten werden einige häufige Anwendungsfälle für die Reading List API beschrieben. Vollständige Beispiele für Erweiterungen finden Sie unter Beispiele für Erweiterungen.
Hinzufügen
Um der Leseliste einen Artikel hinzuzufügen, verwenden Sie chrome.readingList.addEntry()
:
chrome.readingList.addEntry({
title: "New to the web platform in September | web.dev",
url: "https://developer.chrome.com/",
hasBeenRead: false
});
Elemente anzeigen
Zum Anzeigen von Elementen aus der Leseliste verwenden Sie die Methode chrome.readingList.query()
, um sie abzurufen.
const items = await chrome.readingList.query({});
for (const item of items) {
// Do something do display the item
}
Element als gelesen markieren
Mit chrome.readingList.updateEntry()
kannst du den Titel, die URL und den Lesestatus aktualisieren. Mit dem folgenden Code wird ein Element als gelesen markiert:
chrome.readingList.updateEntry({
url: "https://developer.chrome.com/",
hasBeenRead: true
});
Elemente entfernen
Mit chrome.readingList.removeEntry()
können Sie ein Element entfernen:
chrome.readingList.removeEntry({
url: "https://developer.chrome.com/"
});
Beispiele für Erweiterungen
Weitere Demos zu Reading List API-Erweiterungen finden Sie im Beispiel zur Reading List API.
Typen
AddEntryOptions
Attribute
-
hasBeenRead
boolean
Ist
true
, wenn der Eintrag gelesen wurde. -
Titel
String
Der Titel des Eintrags.
-
url
String
Die URL des Eintrags.
QueryInfo
Attribute
-
hasBeenRead
Boolescher Wert optional
Gibt an, ob nach gelesenen (
true
) oder ungelesenen (false
) Elementen gesucht werden soll. -
Titel
String optional
Ein Titel, nach dem gesucht werden soll.
-
url
String optional
Eine URL, nach der gesucht werden soll.
ReadingListEntry
Attribute
-
creationTime
Zahl
Der Zeitpunkt, zu dem der Eintrag erstellt wurde. Seit dem 1. Januar 1970 in Millisekunden aufgezeichnet.
-
hasBeenRead
boolean
Ist
true
, wenn der Eintrag gelesen wurde. -
lastUpdateTime
Zahl
Der Zeitpunkt der letzten Aktualisierung des Eintrags. Dieser Wert wird in Millisekunden seit dem 1. Januar 1970 angegeben.
-
Titel
String
Der Titel des Eintrags.
-
url
String
Die URL des Eintrags.
RemoveOptions
Attribute
-
url
String
Die URL, die entfernt werden soll.
UpdateEntryOptions
Attribute
-
hasBeenRead
Boolescher Wert optional
Der aktualisierte Lesestatus. Wird kein Wert angegeben, bleibt der aktuelle Status erhalten.
-
Titel
String optional
Der neue Titel. Wird kein Wert angegeben, bleibt die vorhandene Kachel erhalten.
-
url
String
Die URL, die aktualisiert wird.
Methoden
addEntry()
chrome.readingList.addEntry(
entry: AddEntryOptions,
callback?: function,
)
Fügt der Leseliste einen Eintrag hinzu, falls noch nicht vorhanden.
Parameter
-
Eintrag
Der Eintrag, der der Leseliste hinzugefügt werden soll.
-
callback
Funktion optional
Der Parameter
callback
sieht so aus:() => void
Rückgaben
-
Promise<void>
Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.
query()
chrome.readingList.query(
info: QueryInfo,
callback?: function,
)
Ruft alle Einträge ab, die den Attributen QueryInfo
entsprechen. Unterkünfte, die nicht angegeben sind, werden nicht zugeordnet.
Parameter
-
Info
Die Eigenschaften, nach denen gesucht werden soll.
-
callback
Funktion optional
Der Parameter
callback
sieht so aus:(entries: ReadingListEntry[]) => void
-
entries
-
Rückgaben
-
Promise<ReadingListEntry[]>
Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.
removeEntry()
chrome.readingList.removeEntry(
info: RemoveOptions,
callback?: function,
)
Entfernt einen Eintrag aus der Leseliste, sofern vorhanden.
Parameter
-
Info
Der Eintrag, der aus der Leseliste entfernt werden soll.
-
callback
Funktion optional
Der Parameter
callback
sieht so aus:() => void
Rückgaben
-
Promise<void>
Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.
updateEntry()
chrome.readingList.updateEntry(
info: UpdateEntryOptions,
callback?: function,
)
Aktualisiert einen Leselisteneintrag, sofern vorhanden.
Parameter
-
Info
Der zu aktualisierende Eintrag.
-
callback
Funktion optional
Der Parameter
callback
sieht so aus:() => void
Rückgaben
-
Promise<void>
Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.
Veranstaltungen
onEntryAdded
chrome.readingList.onEntryAdded.addListener(
callback: function,
)
Wird ausgelöst, wenn der Leseliste ein ReadingListEntry
hinzugefügt wird.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:(entry: ReadingListEntry) => void
-
Eintrag
-
onEntryRemoved
chrome.readingList.onEntryRemoved.addListener(
callback: function,
)
Wird ausgelöst, wenn ein ReadingListEntry
aus der Leseliste entfernt wird.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:(entry: ReadingListEntry) => void
-
Eintrag
-
onEntryUpdated
chrome.readingList.onEntryUpdated.addListener(
callback: function,
)
Wird ausgelöst, wenn ein ReadingListEntry
in der Leseliste aktualisiert wird.
Parameter
-
callback
Funktion
Der Parameter
callback
sieht so aus:(entry: ReadingListEntry) => void
-
Eintrag
-