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

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

Events have three functions:

addListener(listener)

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

listener

The function called when this event occurs. It's passed no parameters.

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
onImportBegan

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support

Examples

js
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.