Закладки
API WebExtensions bookmarks позволяет расширению взаимодействовать с системой закладок браузера и изменять её. Вы можете использовать его для добавления закладок, получения существующих закладок, редактирования, удаления и организации закладок.
Для использования этого API расширение должно запросить разрешение «bookmarks» в файле manifest.json.
Расширения не могут создавать, изменять или удалять закладки в корневом узле дерева закладок. Это приведёт к ошибке с сообщением: «Корень закладок не может быть изменён»
Типы
bookmarks.BookmarkTreeNode-
Представляет закладку или папку в дереве закладок.
bookmarks.BookmarkTreeNodeType-
Перечисление
String, которое описывает, является ли узел в дереве закладкой, папкой или разделителем. bookmarks.BookmarkTreeNodeUnmodifiable-
Перечисление
String, которое указывает причину, по которой закладка или папка не может быть изменена. bookmarks.CreateDetails-
Содержит информацию, которая передаётся функции
bookmarks.create()при создании новой закладки.
Функции
bookmarks.create()-
Создаёт закладку или папку.
bookmarks.get()-
Получает одну или несколько
BookmarkTreeNode, задав ID закладки или массив идентификаторов закладок. bookmarks.getChildren()-
Получает дочерние элементы указанной
BookmarkTreeNode. bookmarks.getRecent()-
Получает заданное количество недавно добавленных закладок.
bookmarks.getSubTree()-
Получает часть дерева закладок, начиная с указанного узла.
bookmarks.getTree()-
Получает всё дерево закладок в виде массива объектов
BookmarkTreeNode. bookmarks.move()-
Перемещает указанную
BookmarkTreeNodeв новое место в дереве закладок. bookmarks.remove()-
Удаляет закладку или пустую папку закладок, указав ID узла.
bookmarks.removeTree()-
Рекурсивно удаляет папку закладок. То есть, по заданному ID узла папки, удаляет сам узел и все его потомки.
bookmarks.search()-
Ищет
BookmarkTreeNodeкоторые соответствуют заданным критериям. bookmarks.update()-
Обновляет заголовок и/или URL закладки или имя папки закладок, задав ID закладки.
События
bookmarks.onCreated-
Срабатывает, когда создаётся закладка или папка.
bookmarks.onRemoved-
Срабатывает, когда закладка или папка удаляются. Когда папка удаляется рекурсивно, одно уведомление генерируется для папки, а не для её содержимого.
bookmarks.onChanged-
Срабатывает, когда закладка или папка изменяется. В настоящее время это срабатывает только при изменениях
titleиurl. bookmarks.onMoved-
Срабатывает, когда закладка или папка перемещаются в другую родительскую папку или в новую позицию в своей папке.
bookmarks.onChildrenReordered-
Срабатывает, когда пользователь сортирует дочерние элементы папки в пользовательском интерфейсе браузера. Это не вызывается в результате выполнения
move(). bookmarks.onImportBegan-
Срабатывает, когда начинается импорт закладок. Расширения, которые производят дорогостоящие операции, должны игнорировать обновления
bookmarks.onCreatedдо срабатыванияbookmarks.onImportEnded. Расширения всё ещё должны обрабатывать другие уведомления немедленно. bookmarks.onImportEnded-
Срабатывает, когда завершается сессия импорта закладок.
Совместимость с браузерами
| Рабочий стол | Мобильный | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari на IOS | Samsung Internet | |
BookmarkTreeNode |
Да | 79 | 45 | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
BookmarkTreeNodeType |
Нет | Нет | 57 | ? | Нет | Нет | ? | ? | Нет | ? | Нет | ? |
BookmarkTreeNodeUnmodifiable |
Да | 79 | 45 | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
CreateDetails |
Да | 79 | 45 | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
create |
Да | 15 | 45 | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
get |
Да | 79 | 45 | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
getChildren |
Да | 79 | 45 | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
getRecent |
Да | 79 | 47 | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
getSubTree |
Да | 79 | 45 | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
getTree |
Да | 15 | 45 | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
move |
Да | 15 | 45 | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
onChanged |
Да | 79 | 52 | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
onChildrenReordered |
Да | 79 | Нет | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
onCreated |
Да | 79 | 52 | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
onImportBegan |
Да | 79 | Нет | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
onImportEnded |
Да | 79 | Нет | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
onMoved |
Да | 79 | 52 | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
onRemoved |
Да | 79 | 52 | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
remove |
Да | 15 | 45 | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
removeTree |
Да | 15 | 47 | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
search |
Да | 79 | 47 | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
update |
Да | 15 | 45 | ? | Да | Нет | ? | ? | Нет | ? | Нет | ? |
Примеры расширений
Примечание: Этот API основан на API chrome.bookmarks Chromium. Данная документация получена из bookmarks.json кода Chromium.
© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/bookmarks