webNavigation.onBeforeNavigate

Syntaxe

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

Les événements ont trois fonctions :

addListener(callback)

Ajoute un écouteur à cet événement.

removeListener(listener)

Arrêtez d'écouter cet événement. L'argument listener est l'écouteur à supprimer.

hasListener(listener)

Vérifiez si listener est enregistré pour cet événement. Renvoie true s'il est écouté, sinon false.

Syntaxe addListener

Paramètres

callback

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

details

object. Détails sur l'événement de navigation.

filterFacultatif

object. Un objet contenant une seule propriété url, qui est un tableau d'objets events.UrlFilter objects.Un objet contenant une seule propriété qui correspondent à au moins un UrlFilter dans le tableau. Si vous omettez ce paramètre, l'événement se déclenchera pour toutes les transitions.

Objets supplémentaires

Détails

tabId

integer. L'ID de l'onglet dans lequel la navigation est sur le point de se produire.

url

string. L'URL à laquelle le cadre donné va naviguer.

processId

integer. L'ID du processus dans lequel cet onglet est rendu (Cette propriété n'est pas pris en charge sur Firefox et c'est déprécié sur Chrome).

frameId

integer. Cadre dans lequel la navigation est sur le point de se produire. 0 indique que la navigation se déroule dans le contexte de navigation de niveau supérieur de l'onglet, et non dans un iframe imbriqué. Une valeur positive indique que la navigation se déroule dans un iframe imbriqué. Les ID de cadre sont uniques pour un onglet et un processus donnés.

parentFrameId

integer. ID du parent de cette image. Défini à -1 s'il s'agit d'un cadre de niveau supérieur.

timeStamp

number. L'heure à laquelle le navigateur est sur le point de démarrer la navigation, en millisecondes depuis l'époque.

Compatibilité des navigateurs

Exemples

Logs les URL cibles de onBeforeNavigate, si le nom d'hôte de la cible contient "example.com" ou commence avec "developer".

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

function logOnBefore(details) {
  console.log("onBeforeNavigate to: " + details.url);
}

browser.webNavigation.onBeforeNavigate.addListener(logOnBefore, filter);