DieWebExtensionsbookmarks API ermöglicht es einer Erweiterung, mit dem Lesezeichensystem des Browsers zu interagieren und dieses zu manipulieren. Sie können es verwenden, um Seiten zu bookmarken, vorhandene Lesezeichen abzurufen sowie Lesezeichen zu bearbeiten, zu entfernen und zu organisieren.

Um diese API zu verwenden, muss eine Erweiterung die "bookmarks"Berechtigung in ihrermanifest.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

Stellt ein Lesezeichen oder einen Ordner im Lesezeichenbaum dar.

bookmarks.BookmarkTreeNodeType

EinString-Enum, das beschreibt, ob ein Knoten im Baum ein Lesezeichen, ein Ordner oder ein Trennzeichen ist.

bookmarks.BookmarkTreeNodeUnmodifiable

EinString-Enum, das angibt, warum ein Lesezeichen oder Ordner nicht modifizierbar ist.

bookmarks.CreateDetails

Enthält Informationen, die an diebookmarks.create()-Funktion übergeben werden, wenn ein neues Lesezeichen erstellt wird.

Funktionen

bookmarks.create()

Erstellt ein Lesezeichen oder einen Ordner.

bookmarks.get()

Ruft ein oder mehrereBookmarkTreeNodes ab, basierend auf einer Lesezeichen-ID oder einem Array von Lesezeichen-IDs.

bookmarks.getChildren()

Ruft die Kinder des angegebenenBookmarkTreeNode ab.

bookmarks.getRecent()

Ruft eine angeforderte Anzahl kürzlich hinzugefügter Lesezeichen ab.

bookmarks.getSubTree()

Ruft einen Teil des Lesezeichenbaums ab, beginnend am angegebenen Knoten.

bookmarks.getTree()

Ruft den gesamten Lesezeichenbaum in ein Array vonBookmarkTreeNode-Objekten ab.

bookmarks.move()

Verschiebt das angegebeneBookmarkTreeNode an einen neuen Ort im Lesezeichenbaum.

bookmarks.remove()

Entfernt ein Lesezeichen oder einen leeren Lesezeichenordner, basierend auf der ID des Knotens.

bookmarks.removeTree()

Entfernt rekursiv einen Lesezeichenordner; das bedeutet, dass der Knoten und alle seine Nachkommen, basierend auf der ID eines Ordnerknotens, entfernt werden.

bookmarks.search()

Sucht nachBookmarkTreeNodes, 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 aktiviert, wenn ein Lesezeichen oder Ordner erstellt wird.

bookmarks.onRemoved

Wird aktiviert, wenn ein Lesezeichen oder Ordner entfernt wird. Wenn ein Ordner rekursiv entfernt wird, wird eine einzelne Benachrichtigung für den Ordner erzeugt, und keine für dessen Inhalte.

bookmarks.onChanged

Wird aktiviert, wenn sich ein Lesezeichen oder Ordner ändert. Derzeit lösen nur Änderungen imtitle undurl dies aus.

bookmarks.onMoved

Wird aktiviert, wenn ein Lesezeichen oder Ordner in einen anderen übergeordneten Ordner oder an eine neue Position innerhalb eines Ordners verschoben wird.

bookmarks.onChildrenReordered

Wird aktiviert, wenn der Benutzer die Kinder eines Ordners in der Benutzeroberfläche des Browsers sortiert hat. Dies wird nicht als Folge einesmove() aufgerufen.

bookmarks.onImportBegan

Wird aktiviert, wenn eine Import-Sitzung für Lesezeichen begonnen wird. Leistungsintensive Beobachter solltenbookmarks.onCreated-Updates ignorieren, bisbookmarks.onImportEnded aktiviert wird. Beobachter sollten jedoch andere Benachrichtigungen sofort behandeln.

bookmarks.onImportEnded

Wird aktiviert, wenn eine Import-Sitzung für Lesezeichen beendet ist.

Beispielerweiterungen

• bookmark-it

Browser-Kompatibilität