webNavigation.getAllFrames()

Étant donné un ID d'onglet, récupère des informations sur toutes les images qu'il contient.

C'est une fonction asynchrone qui renvoie une Promise.

Syntaxe

js
var gettingFrames = browser.webNavigation.getAllFrames(
  details, // object
);

Paramètres

details

object. Informations sur l'onglet pour récupérer toutes les images.

tabId

integer. L'identifiant de l'onglet

Valeur retournée

Une Promise sera accompli avec un tableau d'objets, dont chacun a les propriétés suivantes :

errorOccurred

boolean. Vrai si la dernière navigation dans cette trame a été interrompue par une erreur, c'est-à-dire l'événement onErrorOccurred déclenché.

processId

integer. L'ID du processus exécutant le moteur de rendu pour cet onglet.

frameId

integer. L'identifiant de l'image Si c'est l'image principale, alors frameId est nul.

parentFrameId

integer. ID du parent de cette image. C'est -1 s'il n'y a pas de cadre parent: c'est-à-dire si ce cadre est le contexte de navigation de niveau supérieur dans l'onglet.

url

string. L'URL actuellement associée à ce cadre.

Si l'onglet spécifié n'a pas pu être trouvé ou qu'une autre erreur se produit, la promesse sera rejetée avec un message d'erreur.

Compatibilité des navigateurs

BCD tables only load in the browser

Exemples

Ce code enregistre les URL de toutes les images dans l'onglet actif, lorsque l'utilisateur clique sur une action du navigateur :

js
function logFrameInfo(framesInfo) {
  for (frameInfo of framesInfo) {
    console.log(frameInfo);
  }
}

function onError(error) {
  console.log(`Error: ${error}`);
}

function logAllFrames(tabs) {
  var gettingAllFrames = browser.webNavigation.getAllFrames({
    tabId: tabs[0].id,
  });
  gettingAllFrames.then(logFrameInfo, onError);
}

browser.browserAction.onClicked.addListener(function () {
  var querying = browser.tabs.query({
    currentWindow: true,
    active: true,
  });

  querying.then(logAllFrames, onError);
});

Note :

Cette API est basée sur l'API Chromium chrome.webNavigation. Cette documentation est dérivée de web_navigation.json dans le code de Chromium code.

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.