bookmarks.search()

Syntax

let searching = browser.bookmarks.search(
  query                  // string or object
)

Parameter

query

Ein String oder Object, das die durchzuführende Abfrage beschreibt.

Wenn query ein String ist, besteht es aus null oder mehr durch Leerzeichen getrennten Suchbegriffen. Jeder Suchbegriff passt, wenn er eine Unterzeichenfolge der URL oder des Titels des Lesezeichens ist. Die Übereinstimmung ist nicht case-sensitiv. Damit ein Lesezeichen der Abfrage entspricht, müssen alle Suchbegriffe der Abfrage übereinstimmen.

Wenn query ein Objekt ist, besteht es aus null oder mehr von 3 Eigenschaften: query, title und url, die im Folgenden beschrieben sind. Damit ein Lesezeichen der Abfrage entspricht, müssen alle Begriffe der Eigenschaften übereinstimmen.

query Optional

Ein String, das einen oder mehrere abzugleichende Begriffe angibt; das Format ist identisch mit der String-Form des query Parameters. Wenn dies kein String ist, wird eine Ausnahme ausgelöst.

url Optional

Ein String, das genau der URL des Lesezeichens entsprechen muss. Die Übereinstimmung ist nicht case-sensitiv und abschließende Schrägstriche werden ignoriert.

Wenn Sie eine ungültige URL übergeben, wird die Funktion eine Ausnahme auslösen.

title Optional

Ein String, das genau dem Titel des Lesezeichenbaumnoten entsprechen muss. Die Übereinstimmung ist case-sensitiv.

Rückgabewert

Ein Promise, das mit einem Array von bookmarks.BookmarkTreeNode-Objekten erfüllt wird, wobei jedes Objekt einen einzelnen übereinstimmenden Lesezeichenbaumnoten repräsentiert. Die Ergebnisse werden in der Reihenfolge zurückgegeben, in der die Knoten erstellt wurden. Das Array ist leer, wenn keine Ergebnisse gefunden wurden.

Die von bookmarks.search() zurückgegebenen BookmarkTreeNodes — selbst Knoten vom Typ "folder" — fehlen die children Eigenschaft. Um einen vollständigen BookmarkTreeNode zu erhalten, verwenden Sie bookmarks.getSubTree().

Beispiel

Dieses Beispiel protokolliert die IDs aller Lesezeichen:

function onFulfilled(bookmarkItems) {
  for (const item of bookmarkItems) {
    console.log(item.id);
  }
}

function onRejected(error) {
  console.log(`An error: ${error}`);
}

browser.bookmarks.search({}).then(onFulfilled, onRejected);

Dieses Beispiel überprüft, ob der derzeit aktive Tab ein Lesezeichen ist:

function onFulfilled(bookmarkItems) {
  if (bookmarkItems.length) {
    console.log("active tab is bookmarked");
  } else {
    console.log("active tab is not bookmarked");
  }
}

function onRejected(error) {
  console.log(`An error: ${error}`);
}

function checkActiveTab(tab) {
  browser.bookmarks.search({ url: tab.url }).then(onFulfilled, onRejected);
}

browser.browserAction.onClicked.addListener(checkActiveTab);

Beispielerweiterungen

• bookmark-it

Browser-Kompatibilität