bookmarks

Die WebExtensions bookmarks API ermöglicht es einer Erweiterung, mit dem Lesezeichen-System des Browsers zu interagieren und es zu manipulieren. Sie können es verwenden, um Seiten zu bookmarken, vorhandene Lesezeichen abzurufen und Lesezeichen zu bearbeiten, zu entfernen und zu organisieren.

Um diese API zu verwenden, muss eine Erweiterung die "bookmarks" Berechtigung in ihrer manifest.json Datei anfordern.

Erweiterungen können keine Lesezeichen im Stammknoten des Lesezeichenbaums erstellen, ändern oder löschen. Ein solcher Versuch führt zu einem Fehler mit der Meldung: "The bookmark root cannot be modified"

Typen

bookmarks.BookmarkTreeNode: Repräsentiert ein Lesezeichen oder einen Ordner im Lesezeichenbaum.
bookmarks.BookmarkTreeNodeType: Ein String Enum, das beschreibt, ob ein Knoten im Baum ein Lesezeichen, ein Ordner oder ein Separator ist.
bookmarks.BookmarkTreeNodeUnmodifiable: Ein String Enum, das angibt, warum ein Lesezeichen oder Ordner nicht modifizierbar ist.
bookmarks.CreateDetails: Enthält Informationen, die der Funktion bookmarks.create() beim Erstellen eines neuen Lesezeichens übergeben werden.

Funktionen

bookmarks.create(): Erstellt ein Lesezeichen oder einen Ordner.
bookmarks.get(): Ruft ein oder mehrere BookmarkTreeNodes ab, basierend auf der ID eines Lesezeichens oder einem Array von Lesezeichen-IDs.
bookmarks.getChildren(): Ruft die Kinder des angegebenen BookmarkTreeNode ab.
bookmarks.getRecent(): Ruft eine angeforderte Anzahl von vor Kurzem hinzugefügten Lesezeichen ab.
bookmarks.getSubTree(): Ruft einen Teil des Lesezeichenbaums ab, beginnend beim angegebenen Knoten.
bookmarks.getTree(): Ruft den gesamten Lesezeichenbaum als ein Array von BookmarkTreeNode Objekten ab.
bookmarks.move(): Verschiebt das angegebene BookmarkTreeNode an eine neue Position im Lesezeichenbaum.
bookmarks.remove(): Entfernt ein Lesezeichen oder einen leeren Lesezeichenordner basierend auf der ID des Knotens.
bookmarks.removeTree(): Entfernt rekursiv einen Lesezeichenordner; das heißt, basierend auf der ID eines Ordnerknotens werden dieser Knoten und alle seine Nachkommen entfernt.
bookmarks.search(): Sucht nach BookmarkTreeNodes, die einem bestimmten Satz von Kriterien entsprechen.
bookmarks.update(): Aktualisiert den Titel und/oder die URL eines Lesezeichens oder den Namen eines Lesezeichenordners basierend auf der ID des Lesezeichens.

Ereignisse

bookmarks.onCreated: Wird ausgelöst, wenn ein Lesezeichen oder Ordner erstellt wird.
bookmarks.onRemoved: Wird ausgelöst, wenn ein Lesezeichen oder Ordner entfernt wird. Wenn ein Ordner rekursiv entfernt wird, wird eine einzige Benachrichtigung für den Ordner ausgelöst, jedoch keine für dessen Inhalt.
bookmarks.onChanged: Wird ausgelöst, wenn sich ein Lesezeichen oder Ordner ändert. Derzeit lösen nur Änderungen des title und der url dies aus.
bookmarks.onMoved: Wird ausgelöst, wenn ein Lesezeichen oder Ordner in einen anderen übergeordneten Ordner oder an eine neue Position innerhalb seines Ordners verschoben wird.
bookmarks.onChildrenReordered: Wird ausgelöst, wenn der Benutzer die Kinder eines Ordners in der Benutzeroberfläche des Browsers sortiert hat. Dies wird nicht als Ergebnis einer move() aufgerufen.
bookmarks.onImportBegan: Wird ausgelöst, wenn eine Lesezeichen-Importaktion beginnt. Leistungsintensive Beobachter sollten bookmarks.onCreated Aktualisierungen ignorieren, bis bookmarks.onImportEnded ausgelöst wird. Beobachter sollten dennoch andere Benachrichtigungen sofort behandeln.
bookmarks.onImportEnded: Wird ausgelöst, wenn eine Lesezeichen-Importaktion abgeschlossen ist.

Browser-Kompatibilität

BCD tables only load in the browser

Beispielerweiterungen

Hinweis: Diese API basiert auf der chrome.bookmarks API von Chromium. Diese Dokumentation ist von bookmarks.json im Chromium-Code abgeleitet.