bookmarks
WebExtensions bookmarks API を利用すると、拡張機能からブラウザーのブックマークシステムにアクセスしたり、操作することができます。ページをブックマークしたり、既存のブックマークを取得したり、ブックマークを編集・削除・整理することが可能です。
この API を使用する際は、拡張機能の manifest.json ファイルで "bookmarks" パーミッション を指定する必要があります。
拡張機能ではブックマークツリーのルートノードではブックマークを作成・編集・削除できません。それをしようとすると次のエラーになります: "The bookmark root cannot be modified"
関連する値の型
bookmarks.BookmarkTreeNode-
ブックマークツリー上のブックマークやフォルダーを表します。
bookmarks.BookmarkTreeNodeType-
ツリー内のノードがブックマークかフォルダーかセパレーターかを表す
stringの列挙型です。 bookmarks.BookmarkTreeNodeUnmodifiable-
ブックマークやフォルダーが変更不可である理由を表す
stringの列挙型です。 bookmarks.CreateDetails-
新しいブックマークを作成する際、
bookmarks.create()メソッドに渡す情報を含みます。
関数
bookmarks.create()-
ブックマークやフォルダーを作成します。
bookmarks.get()-
ブックマークの ID や ID の配列を指定し、1 つ以上の
BookmarkTreeNode(s)を取得します。 bookmarks.getChildren()-
指定した
BookmarkTreeNodeの子要素を取得します。 bookmarks.getRecent()-
最近追加されたブックマークを取得します。
bookmarks.getSubTree()-
指定したノードを起点とする、ブックマークツリーの部分木を取得します。
bookmarks.getTree()-
ブックマークのツリー全体を
BookmarkTreeNodeオブジェクトの配列として取得します。 bookmarks.move()-
指定した
BookmarkTreeNodeを所望の場所に移します。 bookmarks.remove()-
ノードの ID を指定し、ブックマークや空のブックマークフォルダーを削除します。
bookmarks.removeTree()-
ブックマークのフォルダーを再帰的に削除します。すなわち、フォルダーノードの ID を指定し、そのノードと子要素すべてを削除します。
bookmarks.search()-
与えた条件に一致する
BookmarkTreeNodesを検索します。 bookmarks.update()-
ブックマークの ID を指定し、ブックマークの URL やタイトル、またはフォルダーの名前を更新します。
Events
bookmarks.onCreated-
ブックマークやフォルダーが作成された際に発火します。
bookmarks.onRemoved-
ブックマークやフォルダーが削除された際に発火します。フォルダーが再帰的に削除された場合は、そのフォルダーに対して一回だけ発火し、フォルダーの中身については発火しません。
bookmarks.onChanged-
ブックマークやフォルダーが変更された際に発火します。現在は
titleと url の変更に対してのみ発火します。 bookmarks.onMoved-
異なる親フォルダーへ、または同じフォルダー内の異なる場所へブックマークやフォルダーが移された際に発火します。
bookmarks.onChildrenReordered-
UI で表示されている順序に伴って子フォルダーの順序も変更された際に発火します。
move()の実行後には発火しません。 bookmarks.onImportBegan-
ブックマークのインポートが開始した際に発火します。パフォーマンスが重要である場合、イベントのオブザーバは
bookmarks.onImportEndedが発火するまでbookmarks.onCreatedを無視すべきでしょう。その場合であっても、オブザーバは他のイベントについては即座に処理すべきでしょう。 bookmarks.onImportEnded-
ブックマークのインポートが終了した際に発火します。
ブラウザーの互換性
BCD tables only load in the browser
Example extensions
メモ: この API は Chromium の chrome.bookmarks API に基づいています。また、このドキュメントは bookmarks.json における Chromium のコードに基づいています。Microsoft Edge での実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License に従っています。