Cette traduction est incomplète. Aidez à traduire cet article depuis l'anglais.

L'API de la WebExtensions bookmarks permet à une extension d'intéragir et de manipuler le système de Bookmarking du navigateur. Vous pouvez l'utiliser pour enregistrer des marque-pages, récupérer des marque-pages existantes, et éditer, supprimer et organiser des marque-pages.

Pour utiliser cette API, une extension doit demander la permission "bookmarks" dans son fichier manifest.json.

Les Types

bookmarks.BookmarkTreeNodeUnmodifiable
Un String énumère ce qui spécifie pourquoi un marque-page ou un dossier n'est pas possible.
bookmarks.BookmarkTreeNode
Représente un marque-page ou un dossier dans l'arborescence des marque-pages.
bookmarks.CreateDetails
Comment des informations passées à la fonction bookmarks.create() lors de la création d'un nouveau marque-page.

Les fonctions

bookmarks.create()
Créer un marque-page ou un dossier
bookmarks.get()
Récupère un ou plusieurs BookmarkTreeNodes, compte tenu d'un identifiant de marque-page ou d'un ensemble d'identifiants de marque-pages.
bookmarks.getChildren()
Récupère les enfants spécifiés BookmarkTreeNode.
bookmarks.getRecent()
Retrieves a requested number of recently added bookmarks.
bookmarks.getSubTree()
Récupère un nombre demandé de favoris récemment ajoutés.
bookmarks.getTree()
Retrieves the entire bookmarks tree into an array of BookmarkTreeNode objects.
bookmarks.move()
Moves the specified BookmarkTreeNode to a new location in the bookmark tree.
bookmarks.remove()
Removes a bookmark or an empty bookmark folder, given the node's ID.
bookmarks.removeTree()
Recursively removes a bookmark folder; that is, given the ID of a folder node, removes that node and all its descendants.
bookmarks.search()
Searches for BookmarkTreeNodes matching a specified set of criteria.
bookmarks.update()
Updates the title and/or URL of a bookmark, or the name of a bookmark folder, given the bookmark's ID.

Events

bookmarks.onCreated
Fired when a bookmark or folder is created.
bookmarks.onRemoved
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
Fired when a bookmark or folder changes. Currently, only title and url changes trigger this.
bookmarks.onMoved
Fired when a bookmark or folder is moved to a different parent folder or to a new offset within its folder.
bookmarks.onChildrenReordered
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().
bookmarks.onImportBegan
Fired when a bookmark import session is begun. Expensive observers should ignore bookmarks.onCreated updates until bookmarks.onImportEnded is fired. Observers should still handle other notifications immediately.
bookmarks.onImportEnded
Fired when a bookmark import session has finished.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
BookmarkTreeNode (Oui) Non45 Non (Oui)
BookmarkTreeNodeUnmodifiable (Oui) Non45 Non (Oui)
CreateDetails (Oui) Non45 Non (Oui)
create (Oui)1545 Non (Oui)
get (Oui) Non45 Non (Oui)
getChildren (Oui) Non45 Non (Oui)
getRecent (Oui) Non47 Non (Oui)
getSubTree (Oui) Non45 Non (Oui)
getTree (Oui)1545 Non (Oui)
move (Oui)1545 Non (Oui)
onChanged (Oui) Non52 Non (Oui)
onChildrenReordered (Oui) Non Non Non (Oui)
onCreated (Oui) Non52 Non (Oui)
onImportBegan (Oui) Non Non Non (Oui)
onImportEnded (Oui) Non Non Non (Oui)
onMoved (Oui) Non52 Non (Oui)
onRemoved (Oui) Non52 Non (Oui)
remove (Oui)1545 Non (Oui)
removeTree (Oui)1547 Non (Oui)
search (Oui) Non47 Non (Oui)
update (Oui)1545 Non (Oui)

Example extensions

Remerciements :

Cette API est basée sur l'API Chromium chrome.bookmarks. Cette documentation provient de  bookmarks.json dans le code Chromium.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.

Étiquettes et contributeurs liés au document

 Contributeurs à cette page : hellosct1
 Dernière mise à jour par : hellosct1,