webNavigation.onCommitted

Syntax

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

Ereignisse haben drei Funktionen:

addListener(listener)

Fügt diesem Ereignis einen Listener hinzu.

removeListener(listener)

Stoppt das Zuhören 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, false andernfalls.

addListener-Syntax

Parameter

listener

Die Funktion, die aufgerufen wird, wenn dieses Ereignis eintritt. Die Funktion erhält dieses Argument:

details

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

filter Optional

object. Ein Objekt, das eine einzige Eigenschaft url enthält, die 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 mit mindestens einem UrlFilter im Array übereinstimmen. 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 Frame navigieren wird.

frameId

integer. Der Frame, in dem die Navigation stattfinden wird. 0 gibt an, dass die Navigation im obersten Browsing-Kontext des Tabs stattfindet, nicht in einem verschachtelten <iframe>. Ein positiver Wert gibt an, dass die Navigation in einem verschachtelten iframe stattfindet. Frame-IDs sind eindeutig für einen bestimmten Tab und Prozess.

frameType

string. Der Typ des Frames, in dem die Navigation stattgefunden hat. Gibt die Werte "outermost_frame", "fenced_frame" und "sub_frame" zurück.

parentFrameId

integer. ID des übergeordneten Frames dieses Frames. Auf -1 gesetzt, wenn es sich um einen obersten Frame handelt.

documentId

string. Eine UUID des geladenen Dokuments.

parentDocumentId

string. Eine UUID des übergeordneten Dokuments, das den Frame besitzt. Wird nicht gesetzt, wenn es keinen Eltern gibt.

documentLifecycle

string. Der Lebenszyklus, in dem sich das Dokument befindet. Gibt die Werte "prerender", "active", "cached" und "pending_deletion" zurück.

transitionType

transitionType. Der Grund für die Navigation. (Zum Beispiel "link", wenn der Benutzer auf einen Link geklickt hat, oder "reload", wenn der Benutzer die Seite neu geladen hat.)

transitionQualifiers

Array von transitionQualifier. Zusätzliche Informationen zur Navigation: zum Beispiel, ob es eine Server- oder Clientweiterleitung gab.

timeStamp

number. Der Zeitpunkt, zu dem die Navigation bestätigt wurde, in Millisekunden seit der Epoche.

processId Optional Veraltet

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

Beispiele

Protokolliert die Ziel-URLs und zusätzliche Übergangsinformationen für onCommitted, wenn der Hostname der Ziel-URL "example.com" enthält oder mit "developer" beginnt.

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

function logOnCommitted(details) {
  console.log(`target URL: ${details.url}`);
  console.log(`transition type: ${details.transitionType}`);
  console.log(`transition qualifiers: ${details.transitionQualifiers}`);
}

browser.webNavigation.onCommitted.addListener(logOnCommitted, filter);

Beispielerweiterungen

• navigation-stats

Browser-Kompatibilität