webRequest.onHeadersReceived

Syntaxe

browser.webRequest.onHeadersReceived.addListener(
  listener, // function
  filter, //  object
  extraInfoSpec, //  optional array of strings
);
browser.webRequest.onHeadersReceived.removeListener(listener);
browser.webRequest.onHeadersReceived.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. Retourne true s'il est écouté, sinon false.

Syntaxe addListener

Paramètres

callback

Fonction qui sera appelée lorsque cet événement se produira. La fonction sera passée les arguments suivants :

details

object. Détails de la demande. Ceci inclura les en-têtes de réponse si vous avez inclus "responseHeaders" dans extraInfoSpec.

Retourne : webRequest.BlockingResponse. Si "blocking" est spécifié dans le paramètre extraInfoSpec, l'auditeur d'événement doit retourner un objet BlockingResponse, et peut définir sa propriété responseHeaders.

filter

webRequest.RequestFilter. Un ensemble de filtres qui restreint les événements qui seront envoyés à cet auditeur.

extraInfoSpecFacultatif

array de string. Options supplémentaires pour l'événement. Vous pouvez passer n'importe laquelle des valeurs suivantes :

• "blocking" pour rendre la requête synchrone, de sorte que vous pouvez modifier les en-têtes de requête et réponse.
• "responseHeaders" pour inclure les en-têtes de réponse dans l'objet détails 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 le documentUrl 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 is main_frame or sub_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.

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, alors originUrl de la requête résultante est "https://example.com".

L'originUrl est souvent mais pas toujours la même chose que documentUrl.Par exemple, si une page contient une iframe, et que l'iframe contient un lien qui charge un nouveau document dans l'iframe, alors le documentUrl 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.

responseHeadersFacultatif

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

Exemples

Ce code définit un cookie supplémentaire lors de la demande d'une ressource à partir de l'URL cible :

var targetPage =
  "https://big.rakal.top/en-US/Firefox/Developer_Edition";

// Add the new header to the original array,
// and return it.
function setCookie(e) {
  var setMyCookie = {
    name: "Set-Cookie",
    value: "my-cookie1=my-cookie-value1",
  };
  e.responseHeaders.push(setMyCookie);
  return { responseHeaders: e.responseHeaders };
}

// Listen for onHeaderReceived for the target page.
// Set "blocking" and "responseHeaders".
browser.webRequest.onHeadersReceived.addListener(
  setCookie,
  { urls: [targetPage] },
  ["blocking", "responseHeaders"],
);

Ce code fait la même chose que l'exemple précédent, sauf que l'auditeur est asynchrone, retournant une Promise qui est résolue avec les nouveaux en-têtes :

var targetPage =
  "https://big.rakal.top/en-US/Firefox/Developer_Edition";

// Return a Promise that sets a timer.
// When the timer fires, resolve the promise with
// modified set of response headers.
function setCookieAsync(e) {
  var asyncSetCookie = new Promise((resolve, reject) => {
    window.setTimeout(() => {
      var setMyCookie = {
        name: "Set-Cookie",
        value: "my-cookie1=my-cookie-value1",
      };
      e.responseHeaders.push(setMyCookie);
      resolve({ responseHeaders: e.responseHeaders });
    }, 2000);
  });

  return asyncSetCookie;
}

// Listen for onHeaderReceived for the target page.
// Set "blocking" and "responseHeaders".
browser.webRequest.onHeadersReceived.addListener(
  setCookieAsync,
  { urls: [targetPage] },
  ["blocking", "responseHeaders"],
);