chrome.readingList

Beschreibung

Mit der chrome.readingList API kannst du die Elemente in der Leseliste auslesen und ändern.

Berechtigungen

readingList

Um die Reading List API zu verwenden, fügen Sie der Manifestdatei der Erweiterung die Berechtigung "readingList" hinzu:

manifest.json:

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

Verfügbarkeit

Chrome 120 oder höher MV3+

In Chrome befindet sich in der Seitenleiste eine Leseliste. Damit können Nutzer Webseiten speichern, um sie später oder offline zu lesen. Verwenden Sie die Reading List API, um vorhandene Elemente abzurufen und Elemente zur Liste hinzuzufügen oder daraus zu entfernen.

<ph type="x-smartling-placeholder">
</ph> Leseliste mit einer Reihe von Artikeln <ph type="x-smartling-placeholder">
</ph> Leseliste mit einer Reihe von Artikeln

Konzepte und Verwendung

Artikelreihenfolge

Die Reihenfolge der Artikel in der Leseliste ist nicht garantiert.

Einzigartigkeit von Elementen

Die Elemente werden nach URL eingegeben. Dazu gehören der Hash- und Abfragestring.

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

Wenn Sie der Leseliste einen Artikel hinzufügen möchten, 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
});

Artikel anzeigen

Verwende die chrome.readingList.query()-Methode, um Elemente aus der Leseliste abzurufen. .

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

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

Artikel 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

Wenn Sie ein Element entfernen möchten, verwenden Sie chrome.readingList.removeEntry():

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

Erweiterungsbeispiele

Weitere Demos zu Reading List API-Erweiterungen finden Sie im Reading List API-Beispiel.

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) Nachrichten 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. Aufgezeichnet in Millisekunden seit dem 1. Januar 1970.

  • hasBeenRead

    boolean

    Ist true, wenn der Eintrag gelesen wurde.

  • lastUpdateTime

    Zahl

    Der Zeitpunkt der letzten Aktualisierung des Eintrags. Dieser Wert ist 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 zu entfernende URL.

UpdateEntryOptions

Attribute

  • hasBeenRead

    Boolescher Wert optional

    Der aktualisierte Lesestatus. Der vorhandene Status bleibt bestehen, wenn kein Wert angegeben wird.

  • Titel

    String optional

    Der neue Titel. Die vorhandene Kachel bleibt erhalten, wenn kein Wert angegeben wird.

  • URL

    String

    Die URL, die aktualisiert wird.

Methoden

addEntry()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.readingList.addEntry(
  entry: AddEntryOptions,
  callback?: function,
)

Fügt der Leseliste einen Eintrag hinzu, falls dieser noch nicht vorhanden ist.

Parameter

  • Eintrag

    AddEntryOptions

    Der Eintrag, der der Leseliste hinzugefügt werden soll.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    () => void

Gibt Folgendes zurück:

  • Versprechen<void>

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

query()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.readingList.query(
  info: QueryInfo,
  callback?: function,
)

Ruft alle Einträge ab, die mit den QueryInfo-Attributen übereinstimmen. Unterkünfte, die nicht angegeben sind, werden nicht abgeglichen.

Parameter

  • Info

    QueryInfo

    Die zu suchenden Eigenschaften.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    (entries: ReadingListEntry[]) => void

Gibt Folgendes zurück:

  • Promise&lt;ReadingListEntry[]&gt;

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

removeEntry()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.readingList.removeEntry(
  info: RemoveOptions,
  callback?: function,
)

Entfernt einen Eintrag aus der Leseliste, falls vorhanden.

Parameter

  • Der Eintrag, der aus der Leseliste entfernt werden soll.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    () => void

Gibt Folgendes zurück:

  • Versprechen<void>

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

updateEntry()

<ph type="x-smartling-placeholder"></ph> Versprechen 
chrome.readingList.updateEntry(
  info: UpdateEntryOptions,
  callback?: function,
)

Aktualisiert einen Leselisteneintrag, falls vorhanden.

Parameter

  • Der Eintrag, der aktualisiert werden soll.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: <ph type="x-smartling-placeholder"></ph>

    () => void

Gibt Folgendes zurück:

  • Versprechen<void>

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

Ereignisse

onEntryAdded

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

Wird ausgelöst, wenn ein ReadingListEntry zur Leseliste hinzugefügt wird.

Parameter

onEntryRemoved

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

Wird ausgelöst, wenn ein ReadingListEntry aus der Leseliste entfernt wird.

Parameter

onEntryUpdated

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

Wird ausgelöst, wenn ein ReadingListEntry in der Leseliste aktualisiert wird.

Parameter