bookmarks.onImportBegan

Fired when the browser has started importing a set of bookmarks.

While a set of bookmarks is being imported, onCreated may fire a lot of times. If your extension is listening to onCreated, and the listener is expensive, you should also listen for onImportBegan and onImportEnded. When you receive onImportBegan, ignore onCreated until you receive onImportEnded. You can handle all other notifications as usual.

Syntax

browser.bookmarks.onImportBegan.addListener(listener)
browser.bookmarks.onImportBegan.removeListener(listener)
browser.bookmarks.onImportBegan.hasListener(listener)

Events have three functions:

addListener(callback): Adds a listener to this event.
removeListener(listener): Stop listening to this event. The listener argument is the listener to remove.
hasListener(listener): Check whether listener is registered for this event. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

callback: Function that will be called when this event occurs. It's passed no parameters.

Browser compatibility

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	WebView Android	Chrome Android	Firefox for Android	Opera Android	Safari on IOS	Samsung Internet
`onImportBegan`	Yes	79	No	?	Yes	No	?	?	No	?	No	?

Examples

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

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

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

browser.browserAction.onClicked.addListener(handleClick);

Note: This API is based on Chromium's chrome.bookmarks API. This documentation is derived from bookmarks.json in the Chromium code.

© 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/onImportBegan