webRequest.onCompleted

Syntax

browser.webRequest.onCompleted.addListener(
  listener,             // function
  filter,               //  object
  extraInfoSpec         //  optional array of strings
)
browser.webRequest.onCompleted.removeListener(listener)
browser.webRequest.onCompleted.hasListener(listener)

Ereignisse haben drei Funktionen:

addListener(listener, filter, extraInfoSpec)

Fügt einen Listener zu diesem Ereignis hinzu.

removeListener(listener)

Hört auf, auf dieses Ereignis zu lauschen. 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 lauscht, andernfalls false.

addListener-Syntax

Parameter

listener

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

details

object. Details zur Anfrage. Weitere Informationen finden Sie im Abschnitt details.

filter

webRequest.RequestFilter. Ein Filter, der die Ereignisse einschränkt, die an diesen Listener gesendet werden.

extraInfoSpec Optional

array von string. Zusätzliche Optionen für das Ereignis. Sie können nur einen Wert übergeben:

• "responseHeaders": schließt responseHeaders in das details-Objekt ein, das an den Listener übergeben wird

Zusätzliche Objekte

details

documentId Optional

string. Die UUID des Dokuments, das die Anfrage stellt. Weitere Informationen finden Sie im Artikel Mit documentId arbeiten.

documentLifecycle

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

cookieStoreId

string. Wenn die Anfrage von einem Tab in einer kontextuellen Identität stammt, die Cookie-Store-ID der kontextuellen Identität. Weitere Informationen finden Sie im Artikel Mit kontextuellen Identitäten arbeiten.

documentUrl

string. URL des Dokuments, in dem die Ressource geladen wird. Wenn z. B. die Webseite unter "https://example.com" ein Bild oder ein iframe enthält, wird die documentUrl für das Bild oder iframe "https://example.com" sein. Für ein Dokument der obersten Ebene ist documentUrl undefiniert.

frameId

integer. Null, wenn die Anfrage im Hauptframe erfolgt; ein positiver Wert bezeichnet die ID eines Unterrahmens, in dem die Anfrage erfolgt. Wenn das Dokument eines (Teil-)Rahmens geladen wird (type ist main_frame oder sub_frame), zeigt frameId die ID dieses Rahmens an, nicht die ID des äußeren Rahmens. Rahmen-IDs sind einzigartig innerhalb eines Tabs.

frameType

string. Der Typ des Rahmens, in dem die Anfrage erfolgte. Gibt die Werte "outermost_frame", "fenced_frame" oder "sub_frame" zurück.

fromCache

boolean. Gibt an, ob diese Antwort aus dem Festplatten-Cache abgerufen wurde.

incognito

boolean. Ob die Anfrage aus einem privaten Browserfenster stammt.

ip

string. Die IP-Adresse des Servers, an den die Anfrage gesendet wurde. Es kann sich um eine wörtliche IPv6-Adresse handeln.

method

string. Standard-HTTP-Methode: zum Beispiel "GET" oder "POST".

originUrl

string. URL der Ressource, die die Anfrage ausgelöst hat. Beispielsweise, wenn "https://example.com" einen Link enthält und der Benutzer auf den Link klickt, dann ist die originUrl für die resultierende Anfrage "https://example.com".

Die originUrl ist oft, aber nicht immer, die gleiche wie die documentUrl. Wenn beispielsweise eine Seite ein iframe enthält und das iframe einen Link enthält, der ein neues Dokument in das iframe lädt, dann wird die documentUrl für die resultierende Anfrage das übergeordnete Dokument des iframes, aber die originUrl wird die URL des Dokuments im iframe sein, das den Link enthalten hat.

parentDocumentIdOptional

string. Eine UUID des übergeordneten Dokuments, das den Rahmen besitzt. Nicht gesetzt, wenn kein übergeordnetes Dokument existiert. Weitere Informationen finden Sie im Artikel Mit documentId arbeiten.

parentFrameId

integer. ID des Rahmens, der den Rahmen enthält, der die Anfrage gesendet hat. Auf -1 gesetzt, wenn kein übergeordneter Rahmen existiert.

proxyInfo

object. Diese Eigenschaft ist nur vorhanden, wenn die Anfrage über einen Proxy weitergeleitet wird. Sie enthält die folgenden Eigenschaften:

host

string. Der Hostname des Proxy-Servers.

port

integer. Die Portnummer des Proxy-Servers.

type

string. Der Typ des Proxy-Servers. Einer von:

• "http": HTTP-Proxy (oder SSL CONNECT für HTTPS)
• "https": HTTP-Proxying über TLS-Verbindung zum Proxy
• "socks": SOCKS v5 Proxy
• "socks4": SOCKS v4 Proxy
• "direct": kein Proxy
• "unknown": unbekannter Proxy

username

string. Benutzername für den Proxy-Dienst.

proxyDNS

boolean. Wahr, wenn der Proxy die DNS-Auflösung basierend auf dem bereitgestellten Hostnamen durchführt, was bedeutet, dass der Client seine eigene DNS-Suche nicht durchführen sollte.

failoverTimeout

integer. Failover-Timeout in Sekunden. Wenn die Proxy-Verbindung fehlschlägt, wird der Proxy für diesen Zeitraum nicht erneut verwendet.

requestId

string. Die ID der Anfrage. Anfordern von IDs sind innerhalb einer Browser-Sitzung einzigartig, sodass Sie sie verwenden können, um verschiedene Ereignisse zuzuordnen, die mit derselben Anfrage verbunden sind.

responseHeaders Optional

webRequest.HttpHeaders. Die HTTP-Antwort-Header, die zusammen mit dieser Antwort erhalten wurden.

statusCode

integer. Standard-HTTP-Statuscode, der vom Server zurückgegeben wird.

statusLine

string. HTTP-Statuszeile der Antwort oder der 'HTTP/0.9 200 OK'-String für HTTP/0.9-Antworten (d.h. Antworten ohne Statuszeile) oder ein leerer String, wenn keine Header vorhanden sind.

tabId

integer. Die ID des Tabs, in dem die Anfrage stattfindet. Auf -1 gesetzt, wenn die Anfrage nicht mit einem Tab in Verbindung steht.

thirdParty

boolean. Gibt an, ob die Anfrage und ihre Inhaltsfensterhierarchie von Dritten stammt.

timeStamp

number. Die Zeit, zu der dieses Ereignis ausgelöst wurde, in Millisekunden seit der Epoche.

type

webRequest.ResourceType. Der Typ der angeforderten Ressource: zum Beispiel "image", "script", "stylesheet".

url

string. Ziel der Anfrage.

urlClassification

object. Die Art des Trackings, die mit der Anfrage verbunden ist, wenn die Anfrage durch den Firefox Tracking Protection klassifiziert wird. Dies ist ein Objekt mit folgenden Eigenschaften:

firstParty

array von string. Klassifikationsflags für die First Party der Anfrage.

thirdParty

array von string. Klassifikationsflags für die Anfrage oder die Third Parties ihrer Fensterhierarchie.

Die Klassifikationsflags umfassen:

• fingerprinting und fingerprinting_content: zeigt an, dass die Anfrage am Fingerprinting beteiligt ist ("eine Quelle, die Fingerprinting betreibt").
  • fingerprinting zeigt an, dass die Domäne in der Kategorie für Fingerprinting und Tracking ist. Beispiele für diese Art von Domänen sind Werbetreibende, die ein Profil mit dem besuchenden Benutzer verknüpfen möchten.
  • fingerprinting_content zeigt an, dass die Domäne in der Kategorie für Fingerprinting, aber nicht in der Tracking-Kategorie ist. Beispiele für diese Art von Domänen sind Zahlungsanbieter, die Fingerprinting-Techniken verwenden, um den besuchenden Benutzer zum Zweck der Betrugserkennung zu identifizieren.
• cryptomining und cryptomining_content: ähnlich wie die Fingerprinting-Kategorie, aber für Krypto-Mining-Ressourcen.
• tracking, tracking_ad, tracking_analytics, tracking_social und tracking_content: zeigt an, dass die Anfrage am Tracking beteiligt ist. tracking ist jede allgemeine Tracking-Anfrage, die Suffixe ad, analytics, social und content identifizieren die Art des Trackers.
• emailtracking und emailtracking_content: zeigt an, dass die Anfrage am E-Mail-Tracking beteiligt ist.
• any_basic_tracking: ein Meta-Flag, das Tracking- und Fingerprinting-Flags kombiniert, exklusive tracking_content und fingerprinting_content.
• any_strict_tracking: ein Meta-Flag, das alle Tracking- und Fingerprinting-Flags kombiniert.
• any_social_tracking: ein Meta-Flag, das alle sozialen Tracking-Flags kombiniert.

Weitere Informationen zu Tracker-Typen finden Sie auf der Website disconnect.me. Das content-Suffix zeigt Tracker an, die Inhalte verfolgen und bereitstellen. Das Blockieren dieser schützt Benutzer, kann jedoch dazu führen, dass Websites fehlerhaft funktionieren oder Elemente nicht angezeigt werden.

Beispiele

let target = "https://developer.mozilla.org/*";

/*
e.g.
"https://developer.mozilla.org/en-US/"
200

or:

"https://developer.mozilla.org/en-US/xfgkdkjdfhs"
404
*/
function logResponse(responseDetails) {
  console.log(responseDetails.url);
  console.log(responseDetails.statusCode);
}

browser.webRequest.onCompleted.addListener(logResponse, { urls: [target] });

Beispielerweiterungen

• stored-credentials

Browser-Kompatibilität