Lesezeichen

Die WebExtensions bookmarks API erlaubt es einer Erweiterung mit dem Lesezeichensystem des Browsers interagieren und dieses zu manipulieren. Sie können die API verwenden, um für Seiten Lesezeichen zu setzen, vorhandene Lesezeichen abzurufen und Lesezeichen zu bearbeiten, zu entfernen und zu organisieren.

Um diese API zu verwenden, muss die Erweiterung die Berechtigung "Lesezeichen" in der manifest.json Datei besitzen.

Types

bookmarks.BookmarkTreeNodeUnmodifiable (en-US)
Ein String enum, das angibt, warum ein Lesezeichen oder ein Ordner unmodifizierbar ist.
bookmarks.BookmarkTreeNode (en-US)
Stellt ein Lesezeichen oder einen Ordner im Lesezeichenbaum dar.
bookmarks.CreateDetails (en-US)
Enthält Informationen, die bei der Erstellung eines neuen Lesezeichens an die bookmarks.create() (en-US) Funktion übergeben werden.

Functions

bookmarks.create() (en-US)
Erstellt ein Lesezeichen oder Ordner.
bookmarks.get() (en-US)
Ruft eine oder mehrere BookmarkTreeNode (en-US) ab und übergibt eine Lesezeichen-ID oder ein Array von Lesezeichen ID.
bookmarks.getChildren() (en-US)
Ruft die Kinder des angegebenen BookmarkTreeNode (en-US) ab.
bookmarks.getRecent() (en-US)
Ruft eine angeforderte Anzahl von zuletzt hinzugefügten Lesezeichen ab.
bookmarks.getSubTree() (en-US)
Ruft einen Teil des Lesezeichenbaums ab und beginnt am angegebenen Knoten.
bookmarks.getTree() (en-US)
Ruft den gesamten Lesezeichenbaum in ein Array von BookmarkTreeNode (en-US) Objekte auf.
bookmarks.move() (en-US)
Moves the specified BookmarkTreeNode (en-US) to a new location in the bookmark tree.
bookmarks.remove() (en-US)
Removes a bookmark or an empty bookmark folder, given the node's ID.
bookmarks.removeTree() (en-US)
Recursively removes a bookmark folder; that is, given the ID of a folder node, removes that node and all its descendants.
bookmarks.search() (en-US)
Searches for BookmarkTreeNode (en-US)s matching a specified set of criteria.
bookmarks.update() (en-US)
Updates the title and/or URL of a bookmark, or the name of a bookmark folder, given the bookmark's ID.

Events

bookmarks.onCreated (en-US)
Fired when a bookmark or folder is created.
bookmarks.onRemoved (en-US)
Fired when a bookmark or folder is removed. When a folder is removed recursively, a single notification is fired for the folder, and none for its contents.
bookmarks.onChanged (en-US)
Fired when a bookmark or folder changes. Currently, only title and url changes trigger this.
bookmarks.onMoved (en-US)
Fired when a bookmark or folder is moved to a different parent folder or to a new offset within its folder.
bookmarks.onChildrenReordered (en-US)
Fired when the user has sorted the children of a folder in the browser's UI. This is not called as a result of a move() (en-US).
bookmarks.onImportBegan (en-US)
Fired when a bookmark import session is begun. Expensive observers should ignore bookmarks.onCreated (en-US) updates until bookmarks.onImportEnded (en-US) is fired. Observers should still handle other notifications immediately.
bookmarks.onImportEnded (en-US)
Fired when a bookmark import session has finished.

Browser compatibility

BCD tables only load in the browser

Edge incompatibilities

Promises are not supported in Edge. Use callbacks instead.

Example extensions

Acknowledgements

This API is based on Chromium's chrome.bookmarks API. This documentation is derived from bookmarks.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.