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.BookmarkTreeNode
Représente un marque-page ou un dossier dans l'arborescence des marque-pages.
bookmarks.BookmarkTreeNodeType
Un enum String qui décrit si un noeud de l'arbre est un signet, un dossier ou un séparateur.
bookmarks.BookmarkTreeNodeUnmodifiable
Un String énumère ce qui spécifie pourquoi un marque-page ou un dossier n'est pas possible.
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
Lancé lorsqu'un signet ou un dossier est créé.
bookmarks.onRemoved
Lancé lorsqu'un signet ou un dossier est supprimé. Lorsqu'un dossier est supprimé de manière récursive, une seule notification est envoyée pour le dossier et aucune pour son contenu..
bookmarks.onChanged
Lancé lorsqu'un signet ou un dossier change. Actuellement, seuls les changements de titre et d'URL déclenchent cela.
bookmarks.onMoved
Lancé lorsqu'un signet ou un dossier est déplacé vers un dossier parent différent ou vers un nouveau décalage dans son dossier.
bookmarks.onChildrenReordered
Lancé lorsque l'utilisateur a trié les enfants d'un dossier dans l'interface utilisateur du navigateur. Ceci n'est pas appelé comme résultat d'un  move().
bookmarks.onImportBegan
Lancé lorsqu'une session d'importation de signets est commencée. Les observateurs coûteux doivent ignorer les bookmarks.onCreated mises à jour jusqu'à ce que bookmarks.onImportEnded soit déclenché. Les observateurs doivent toujours gérer d'autres notifications immédiatement.
bookmarks.onImportEnded
Lancé lorsqu'une session d'importation de signets est terminée.

Compatibilité du navigateur

ChromeEdgeFirefoxFirefox for AndroidOpera
BookmarkTreeNode Oui Non45 Non Oui
BookmarkTreeNodeType Non Non57 Non Non
BookmarkTreeNodeUnmodifiable Oui Non45 Non Oui
CreateDetails Oui Non45 Non Oui
create Oui1545 Non Oui
get Oui Non45 Non Oui
getChildren Oui Non45 Non Oui
getRecent Oui Non47 Non Oui
getSubTree Oui Non45 Non Oui
getTree Oui1545 Non Oui
move Oui1545 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 Oui1545 Non Oui
removeTree Oui1547 Non Oui
search Oui Non47 Non Oui
update Oui1545 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,