Skip to content

Latest commit

 

History

History
92 lines (72 loc) · 4.05 KB

index.md

File metadata and controls

92 lines (72 loc) · 4.05 KB
title slug
bookmarks.onImportBegan
Mozilla/Add-ons/WebExtensions/API/bookmarks/onImportBegan

{{AddonSidebar}}

ブックマークのインポートが開始した際に発火します。

ブックマークをインポートしている間、{{WebExtAPIRef("bookmarks.onCreated", "onCreated")}} が何度も発火する場合があります。onCreated に紐づけるリスナ関数の処理が重い場合には、onImportBegan と {{WebExtAPIRef("bookmarks.onImportEnded", "onImportEnded")}} をリッスンし、onImportEnded が発火するまでは onCreated を無視してください。他のイベントは通常通り処理できます。

構文

browser.bookmarks.onImportBegan.addListener(function() {...})
browser.bookmarks.onImportBegan.removeListener(listener)
browser.bookmarks.onImportBegan.hasListener(listener)

このイベントには 3 つのメソッドが用意されています。

  • addListener(callback)
    • : イベントリスナを追加します。
  • removeListener(listener)
    • : イベントリスナを削除します。引数 listener には削除したいリスナを指定します。
  • hasListener(listener)
    • : listener がイベントリスナとして登録されているか確認します。登録されていれば true を、それ以外の場合は false を返します。

addListener の構文

引数

  • callback
    • : イベントが発火した際に呼び出される関数を指定します。この関数に渡される引数はありません。

ブラウザーの互換性

{{Compat}}

使用例

function handleImportBegan() {
  console.log("Importing...");
}

function handleImportEnded() {
  console.log("...finished.");
}

function handleClick() {
  chrome.bookmarks.onImportBegan.addListener(handleImportBegan);
  chrome.bookmarks.onImportEnded.addListener(handleImportEnded);
}

chrome.browserAction.onClicked.addListener(handleClick);

{{WebExtExamples}}

Note

この API は Chromium の chrome.bookmarks API に基づいています。また、このドキュメントは bookmarks.json における Chromium のコードから作成されています。Microsoft Edge の実装状況は Microsoft Corporation から提供されたものであり、ここでは Creative Commons Attribution 3.0 United States License. に従います。