A API WebExtensions bookmarks permite uma extensão interagir e manipular o sistema de favoritos do navegador. Você pode pode usá-lo para favoritar páginas, obter favoritos existentes e, editar, remover ou organizar os favoritos.

Para utilizar esta API, uma extensão deve ser requisitada para o "bookmarks" permission em seu arquivo manifest.json .

Tipos

bookmarks.BookmarkTreeNode
Representa um favorito ou um diretório de favoritos como árvore.
bookmarks.BookmarkTreeNodeType
O enum String o qual descreve se um nó na árvore é ou não um favorito, uma pasta ou um separador.
bookmarks.BookmarkTreeNodeUnmodifiable
O enum String o qual especifica porque um favorito ou uma pasta não pode ser modificado.
bookmarks.CreateDetails
Contém informações ao qual é passada para a função bookmarks.create() quando um novo favorito é criado.

Funções

bookmarks.create()
Cria um favorito ou uma pasta.
bookmarks.get()
Retrieves one or more BookmarkTreeNodes, given a bookmark's ID or an array of bookmark IDs.
bookmarks.getChildren()
Recupera os filhos especificados BookmarkTreeNode.
bookmarks.getRecent()
Recupera um número requisitado de favoritos adicionados recentemente.
bookmarks.getSubTree()
Recupera uma parte da árvore de favoritos, iniciando por um nó previamente especificado.
bookmarks.getTree()
Recupera a árvore de favoritos inteira em um array de objetos BookmarkTreeNode.
bookmarks.move()
Move o especificado BookmarkTreeNode para um novo local dentro da árvore de favoritos.
bookmarks.remove()
Remove um favorito ou uma pasta de favoritos vazia dado o ID do nó.
bookmarks.removeTree()
Remove recursivamente uma pasta de favoritos; isto é; dado o ID do nó da pasta e todos seus descendentes.
bookmarks.search()
Procura por BookmarkTreeNodes que batam com o conjunto de critérios especificados.
bookmarks.update()
Atualiza o título e/ou autor do favorito de uma URL, ou o nome de uma pasta de favoritos dado o ID do favorito.

Eventos

bookmarks.onCreated
Disparado quando um favorito ou uma pasta é criado.
bookmarks.onRemoved
Disparado quando um favorito ou uma pasta é removido. Quando uma pasta é removida recursivamente, uma simples notificação é disparada para o diretório, e nenhum para seu conteúdo.
bookmarks.onChanged
Disparado quando um favorito ou pasta é modificado. Atualmente, somente mudanças no title e url o disparam.
bookmarks.onMoved
Disparado quando um favorito ou pasta é movido para uma pasta pai diferente ou para um novo local dentro deste pasta.
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
Disparado quando uma sessão de importação de favoritos começa. Custosos observers bookmarks.onCreated atualizam até o bookmarks.onImportEnded ser disparado. Observers deveriam ainda manipular outras notificações imediatamente.
bookmarks.onImportEnded
Disparado quando uma sessão de importação de favoritos é finalizada.

Compatibilidade nos navegadores

ChromeEdgeFirefoxFirefox for AndroidOpera
BookmarkTreeNode Yes No45 No Yes
BookmarkTreeNodeType No No57 No No
BookmarkTreeNodeUnmodifiable Yes No45 No Yes
CreateDetails Yes No45 No Yes
create Yes1545 No Yes
get Yes No45 No Yes
getChildren Yes No45 No Yes
getRecent Yes No47 No Yes
getSubTree Yes No45 No Yes
getTree Yes1545 No Yes
move Yes1545 No Yes
onChanged Yes No52 No Yes
onChildrenReordered Yes No No No Yes
onCreated Yes No52 No Yes
onImportBegan Yes No No No Yes
onImportEnded Yes No No No Yes
onMoved Yes No52 No Yes
onRemoved Yes No52 No Yes
remove Yes1545 No Yes
removeTree Yes1547 No Yes
search Yes No47 No Yes
update Yes1545 No Yes

Example extensions

Agradecimentos

Esta API é baseada na API Chromium chrome.bookmarks . Esta documentação é derivada do bookmarks.json no código do Chromium.

Os dados de compatibilidade do Microsoft Edge são fornecidos pela Microsoft Corporation e aqui estão sob a Creative Commons Attribution 3.0 United States License.

Etiquetas do documento e colaboradores

Colaboradores desta página: thiagopelizoni
Última atualização por: thiagopelizoni,