bookmarks

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 (en-US) .

Tipos

bookmarks.BookmarkTreeNode (en-US)

Representa um favorito ou um diretório de favoritos como árvore.

bookmarks.BookmarkTreeNodeType (en-US)

O enum String o qual descreve se um nó na árvore é ou não um favorito, uma pasta ou um separador.

bookmarks.BookmarkTreeNodeUnmodifiable (en-US)

O enum String o qual especifica porque um favorito ou uma pasta não pode ser modificado.

bookmarks.CreateDetails (en-US)

Contém informações ao qual é passada para a função bookmarks.create() (en-US) quando um novo favorito é criado.

Funções

bookmarks.create() (en-US)

Cria um favorito ou uma pasta.

bookmarks.get() (en-US)

Retrieves one or more BookmarkTreeNode (en-US)s, given a bookmark's ID or an array of bookmark IDs.

bookmarks.getChildren() (en-US)

Recupera os filhos especificados BookmarkTreeNode (en-US).

bookmarks.getRecent() (en-US)

Recupera um número requisitado de favoritos adicionados recentemente.

bookmarks.getSubTree() (en-US)

Recupera uma parte da árvore de favoritos, iniciando por um nó previamente especificado.

bookmarks.getTree() (en-US)

Recupera a árvore de favoritos inteira em um array de objetos BookmarkTreeNode (en-US).

bookmarks.move() (en-US)

Move o especificado BookmarkTreeNode (en-US) para um novo local dentro da árvore de favoritos.

bookmarks.remove() (en-US)

Remove um favorito ou uma pasta de favoritos vazia dado o ID do nó.

bookmarks.removeTree() (en-US)

Remove recursivamente uma pasta de favoritos; isto é; dado o ID do nó da pasta e todos seus descendentes.

bookmarks.search() (en-US)

Procura por BookmarkTreeNode (en-US)s que batam com o conjunto de critérios especificados.

bookmarks.update() (en-US)

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 (en-US)

Disparado quando um favorito ou uma pasta é criado.

bookmarks.onRemoved (en-US)

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 (en-US)

Disparado quando um favorito ou pasta é modificado. Atualmente, somente mudanças no title e url o disparam.

bookmarks.onMoved (en-US)

Disparado quando um favorito ou pasta é movido para uma pasta pai diferente ou para um novo local dentro deste pasta.

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)

Disparado quando uma sessão de importação de favoritos começa. Custosos observers bookmarks.onCreated (en-US) atualizam até o bookmarks.onImportEnded (en-US) ser disparado. Observers deveriam ainda manipular outras notificações imediatamente.

bookmarks.onImportEnded (en-US)

Disparado quando uma sessão de importação de favoritos é finalizada.

Compatibilidade com navegadores

BCD tables only load in the browser

Example extensions

Nota: AgradecimentosEsta 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.