webNavigation.onCompleted

Syntax

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

Ereignisse haben drei Funktionen:

addListener(listener)

Fügt diesem Ereignis einen Listener hinzu.

removeListener(listener)

Hört auf, diesem Ereignis zuzuhören. 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, andernfalls false.

addListener-Syntax

Parameter

listener

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

details

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

filter Optional

object. Ein Objekt, das eine einzelne 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 mindestens einen UrlFilter im Array erfüllen. 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 stattgefunden hat.

url

string. Die URL, zu der der gegebene Frame navigiert hat.

frameId

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

frameType

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

parentFrameId

integer. ID des übergeordneten Frames dieses Frames. Wird auf -1 gesetzt, wenn es sich um ein oberstes Frame handelt.

documentId

string. Eine UUID des geladenen Dokuments.

parentDocumentId

string. Eine UUID des übergeordneten Dokuments, das den Frame besitzt. Nicht gesetzt, wenn kein übergeordnetes Dokument vorhanden ist.

documentLifecycle

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

timeStamp

number. Die Zeit, zu der die Seite fertig geladen hat, in Millisekunden seit der Epoche.

processId Optional Veraltet

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

Beispiele

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

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

function logOnCompleted(details) {
  console.log(`onCompleted: ${details.url}`);
}

browser.webNavigation.onCompleted.addListener(logOnCompleted, filter);

Beispielerweiterungen

• navigation-stats

Browser-Kompatibilität