webNavigation.onBeforeNavigate

Ausgelöst, wenn der Browser dabei ist, ein Navigationsereignis zu starten.

Syntax

js
browser.webNavigation.onBeforeNavigate.addListener(
  listener,                   // function
  filter                      // optional object
)
browser.webNavigation.onBeforeNavigate.removeListener(listener)
browser.webNavigation.onBeforeNavigate.hasListener(listener)

Ereignisse haben drei Funktionen:

addListener(listener)

Fügt einen Listener zu diesem Ereignis hinzu.

removeListener(listener)

Beendet das Lauschen auf dieses Ereignis. Das Argument listener ist der zu entfernende Listener.

hasListener(listener)

Überprüft, ob listener für dieses Ereignis registriert ist. Gibt true zurück, wenn es zuhört, ansonsten false.

addListener-Syntax

Parameter

listener

Die Funktion, die aufgerufen wird, wenn dieses Ereignis eintritt. Der Funktion wird dieses Argument übergeben:

details

object. Details über das Navigationsereignis. Siehe den Abschnitt details für weitere Informationen.

filter Optional

object. Ein Objekt, das eine einzige Eigenschaft url enthält, welche ein Array von events.UrlFilter-Objekten ist. Wenn Sie diesen Parameter einschließen, wird das Ereignis nur für Übergänge zu URLs ausgelöst, die mindestens einem UrlFilter im Array entsprechen. Wenn Sie diesen Parameter weglassen, wird das Ereignis für alle Übergänge ausgelöst.

Zusätzliche Objekte

details

tabId

integer. Die ID des Tabs, in dem die Navigation stattfinden wird.

url

string. Die URL, zu der der gegebene Frame navigieren wird.

processId Optional Veraltet

integer. Dieser Wert wird in modernen Browsern nicht gesetzt. Als er gesetzt wurde, repräsentierte er die ID des Prozesses, der das Renderer für diesen Tab ausführte.

frameId

integer. Frame, in dem die Navigation stattfinden wird. 0 zeigt an, dass die Navigation im obersten Browserkontext des Tabs und nicht in einem verschachtelten <iframe> erfolgt. Ein positiver Wert zeigt an, dass die Navigation in einem verschachtelten iframe erfolgt. Frame-IDs sind für einen gegebenen Tab und Prozess eindeutig.

parentFrameId

integer. ID des Eltern-Frames dieses Frames. Auf -1 gesetzt, wenn es sich um einen Top-Level-Frame handelt.

timeStamp

number. Der Zeitpunkt, an dem der Browser die Navigation starten soll, in Millisekunden seit der Epoche.

Browser-Kompatibilität

Beispiele

Protokolliert die Ziel-URLs für onBeforeNavigate, wenn der Hostname des Ziels "example.com" enthält oder mit "developer" beginnt.

js
const filter = {
  url: [{ hostContains: "example.com" }, { hostPrefix: "developer" }],
};

function logOnBefore(details) {
  console.log(`onBeforeNavigate to: ${details.url}`);
}

browser.webNavigation.onBeforeNavigate.addListener(logOnBefore, filter);

Hinweis: Diese API basiert auf Chromiums chrome.webNavigation API. Diese Dokumentation ist abgeleitet von web_navigation.json im Chromium-Code.