---
title: bookmarks
slug: Mozilla/Add-ons/WebExtensions/API/bookmarks
translation_of: Mozilla/Add-ons/WebExtensions/API/bookmarks
---
<div>{{AddonSidebar}}</div>

<p>A API <a href="/en-US/docs/Mozilla/Add-ons/WebExtensions">WebExtensions</a> {{WebExtAPIRef("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.</p>

<p>Para utilizar esta API, uma extensão deve ser requisitada para o "bookmarks" <a href="https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json/permissions">permission</a> em seu arquivo <code><a href="/en-US/docs/Mozilla/Add-ons/WebExtensions/manifest.json">manifest.json</a></code> .</p>

<h2 id="Tipos">Tipos</h2>

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

<h2 id="Funções">Funções</h2>

<dl>
 <dt>{{WebExtAPIRef("bookmarks.create()")}}</dt>
 <dd>Cria um favorito ou uma pasta.</dd>
 <dt>{{WebExtAPIRef("bookmarks.get()")}}</dt>
 <dd>Retrieves one or more {{WebExtAPIRef("bookmarks.BookmarkTreeNode", "BookmarkTreeNode")}}s, given a bookmark's ID or an array of bookmark IDs.</dd>
 <dt>{{WebExtAPIRef("bookmarks.getChildren()")}}</dt>
 <dd>Recupera os filhos especificados {{WebExtAPIRef("bookmarks.BookmarkTreeNode", "BookmarkTreeNode")}}.</dd>
 <dt>{{WebExtAPIRef("bookmarks.getRecent()")}}</dt>
 <dd>Recupera um número requisitado de favoritos adicionados recentemente.</dd>
 <dt>{{WebExtAPIRef("bookmarks.getSubTree()")}}</dt>
 <dd>Recupera uma parte da árvore de favoritos, iniciando por um nó previamente especificado.</dd>
 <dt>{{WebExtAPIRef("bookmarks.getTree()")}}</dt>
 <dd>Recupera a árvore de favoritos inteira em um array de objetos {{WebExtAPIRef("bookmarks.BookmarkTreeNode", "BookmarkTreeNode")}}.</dd>
 <dt>{{WebExtAPIRef("bookmarks.move()")}}</dt>
 <dd>Move o especificado {{WebExtAPIRef("bookmarks.BookmarkTreeNode", "BookmarkTreeNode")}} para um novo local dentro da árvore de favoritos.</dd>
 <dt>{{WebExtAPIRef("bookmarks.remove()")}}</dt>
 <dd>Remove um favorito ou uma pasta de favoritos vazia dado o ID do nó.</dd>
 <dt>{{WebExtAPIRef("bookmarks.removeTree()")}}</dt>
 <dd>Remove recursivamente uma pasta de favoritos; isto é; dado o ID do nó da pasta e todos seus descendentes.</dd>
 <dt>{{WebExtAPIRef("bookmarks.search()")}}</dt>
 <dd>Procura por {{WebExtAPIRef("bookmarks.BookmarkTreeNode", "BookmarkTreeNode")}}s que batam com o conjunto de critérios especificados.</dd>
 <dt>{{WebExtAPIRef("bookmarks.update()")}}</dt>
 <dd>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.</dd>
</dl>

<h2 id="Eventos">Eventos</h2>

<dl>
 <dt>{{WebExtAPIRef("bookmarks.onCreated")}}</dt>
 <dd>Disparado quando um favorito ou uma pasta é criado.</dd>
 <dt>{{WebExtAPIRef("bookmarks.onRemoved")}}</dt>
 <dd>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.</dd>
 <dt>{{WebExtAPIRef("bookmarks.onChanged")}}</dt>
 <dd>Disparado quando um favorito ou pasta é modificado. Atualmente, somente mudanças no <code>title</code> e <code>url</code> o disparam.</dd>
 <dt>{{WebExtAPIRef("bookmarks.onMoved")}}</dt>
 <dd>Disparado quando um favorito ou pasta é movido para uma pasta pai diferente ou para um novo local dentro deste pasta.</dd>
 <dt>{{WebExtAPIRef("bookmarks.onChildrenReordered")}}</dt>
 <dd>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 {{WebExtAPIRef("bookmarks.move", "move()")}}.</dd>
 <dt>{{WebExtAPIRef("bookmarks.onImportBegan")}}</dt>
 <dd>Disparado quando uma sessão de importação de favoritos começa. Custosos observers {{WebExtAPIRef("bookmarks.onCreated")}} atualizam até o {{WebExtAPIRef("bookmarks.onImportEnded")}} ser disparado. Observers deveriam ainda manipular outras notificações imediatamente.</dd>
 <dt>{{WebExtAPIRef("bookmarks.onImportEnded")}}</dt>
 <dd>Disparado quando uma sessão de importação de favoritos é finalizada.</dd>
</dl>

<h2 id="Browser_compatibility">Compatibilidade com navegadores</h2>

<p>{{Compat("webextensions.api.bookmarks")}}</p>

<div class="hidden note">
<p>A sessão "Chrome incompatibilities" está incluso no <a href="https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities">https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities</a> usando a macro <a href="/en-US/docs/Template:WebExtChromeCompat">WebExtChromeCompat</a>.</p>

<p>Se precisar atualizar este conteúdo, edite <a href="https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities">https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities</a>, então recarregue a página para ver suas alterações.</p>
</div>

<p>{{WebExtExamples("h2")}}</p>

<div class="note"><strong>Agradecimentos</strong>

<p>Esta API é baseada na API Chromium <a href="https://developer.chrome.com/extensions/bookmarks"><code>chrome.bookmarks</code></a> . Esta documentação é derivada do <a href="https://chromium.googlesource.com/chromium/src/+/master/chrome/common/extensions/api/bookmarks.json"><code>bookmarks.json</code></a> no código do Chromium.</p>

<p>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.</p>
</div>

<div class="hidden">
<pre>// Copyright 2015 The Chromium Authors. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//    * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</pre>
</div>