webRequest.onCompleted
Utilisé lorsqu'une demande est complétée.
Cet événement est à titre d'information seulement.
Syntaxe
browser.webRequest.onCompleted.addListener(
listener, // function
filter, // object
extraInfoSpec, // optional array of strings
);
browser.webRequest.onCompleted.removeListener(listener);
browser.webRequest.onCompleted.hasListener(listener);
Les événements ont trois fonctions :
addListener(callback, filter, extraInfoSpec)
-
Ajouter un auditeur à cet événement.
removeListener(listener)
-
Arrêtez d'écouter cet événement. L'argument
listener
est l'auditeur à supprimer. hasListener(listener)
-
Vérifiez si
listener
est enregistré à cet événement. Retournetrue
s'il est écouté, sinonfalse
.
Syntaxe addListener
Paramètres
callback
-
Une fonction qui sera appelée lorsque cet événement se produira. La fonction sera passée les arguments suivants :
filter
-
webRequest.RequestFilter
. Un filtre qui restreint les événements qui seront envoyés à cet auditeur. extraInfoSpec
Facultatif-
array
ofstring
. Options supplémentaires pour l'événement. Vous ne pouvez passer qu'une seule valeur :"responseHeaders"
: inclureresponseHeaders
dans l'objetdetails
transmis à l'auditeur
Objets supplémentaires
Détails
documentUrl
-
string
. URL du document dans lequel la ressource sera chargée. Par exemple, si la page web "https://example.com" contient une image ou un iframe, alors ledocumentUrl
pour l'image ou l'iframe sera "https://example.com". Pour un document de niveau supérieur,documentUrl
n'est pas défini. frameId
-
integer
. Zéro si la requête se produit dans le cadre principal ; une valeur positive est l'ID d'une sous-trame dans laquelle la requête se produit. Si le document d'un (sous-)cadre est chargé (type
ismain_frame
orsub_frame
),frameId
indique l'ID de ce cadre et non l'ID du cadre extérieur. Les ID de trame sont uniques dans un onglet. fromCache
-
boolean
. Indique si cette réponse a été récupérée dans le cache du disque. ip
Facultatif-
string
. L'adresse IP du serveur à laquelle la requête a été envoyée. Notez qu'il peut s'agir d'une adresse IPv6 littérale. method
-
string
. Méthode HTTP standard : par exemple, "GET" ou "POST". originUrl
-
string
. URL de la ressource qui a déclenché la requête. Par exemple, si "https://example.com" contient un lien, et que l'utilisateur clique sur le lien, alorsoriginUrl
de la requête résultante est "https://example.com".L'
originUrl
est souvent mais pas toujours la même chose quedocumentUrl
.Par exemple, si une page contient une iframe, et que l'iframe contient un lien qui charge un nouveau document dans l'iframe, alors ledocumentUrl
pour la requête résultante sera le document parent de l'iframe, mais l'originUrl
sera l'URL du document dans l'iframe qui contenait le lien. parentFrameId
-
integer
. de la trame qui contient la trame qui a envoyé la requête. Réglé à -1 s'il n'existe pas de l'iframe parent. proxyInfo
-
object
. Cette propriété n'est présente que si la demande est proxied. Il contient les propriétés suivantes :host
-
string
. Le nom d'hôte du serveur proxy. port
-
integer
. Le numéro de port du serveur proxy. type
-
string
. Le type de serveur proxy. L'un des :- "http": proxy HTTP (ou SSL CONNECT pour HTTPS)
- "https": proxy HTTP sur connexion TLS vers proxy
- "socks": SOCKS v5 proxy
- "socks4": SOCKS v4 proxy
- "direct": pas de proxy
- "unknown": proxy inconnu
username
-
string
. Nom d'utilisateur pour le service proxy. proxyDNS
-
boolean
. Vrai si le proxy exécutera une résolution de nom de domaine basée sur le nom d'hôte fourni, ce qui signifie que le client ne doit pas faire sa propre recherche DNS. failoverTimeout
-
integer
. Délai d'attente de basculement en secondes. Si la connexion par proxy échoue, le proxy ne sera pas utilisé à nouveau pendant cette période.
requestId
-
string
. L'ID de la demande. Les ID de requête sont uniques au sein d'une session de navigateur, de sorte que vous pouvez les utiliser pour relier différents événements associés à la même requête. responseHeaders
Facultatif-
webRequest.HttpHeaders
. Les en-têtes de réponse HTTP qui ont été reçus avec cette réponse. statusCode
-
integer
. Code d'état HTTP standard renvoyé par le serveur. statusLine
-
string
. Status d'état HTTP de la réponse ou la chaîne 'HTTP/0.9 200 OK' pour les réponses HTTP/0.9 (c'est-à-dire les réponses qui n'ont pas de ligne d'état) ou une chaîne vide s'il n'y a pas d'en-têtes tabId
-
integer
. ID de l'onglet dans lequel la demande a lieu. Définir à -1 si la requête n'est pas liée à un onglet. timeStamp
-
number
. L'heure à laquelle cet événement s'est déclenché, en millisecondes depuis l'époque. type
-
webRequest.ResourceType
. Le type de ressource demandée : par exemple, "image", "script", "stylesheet". url
-
string
. Cible de la demande.
Compatibilité des navigateurs
BCD tables only load in the browser
Exemples
var 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] });
Example extensions
Note :
Cette API est basée sur l'API Chromium chrome.webRequest
. Cette documentation est dérivée de web_request.json
dans le code Chromium.
Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.