webNavigation.getFrame()

Récupère des informations sur un cadre particulier. Un cadre peut être l'image de niveau supérieur dans un onglet ou un iframe imbriqué, et est identifié de manière unique par un ID de tabulation et un ID de cadre.

C'est une fonction asynchrone qui renvoie une Promise.

Syntaxe

var gettingFrame = browser.webNavigation.getFrame(
  details                // object
)

Paramètres

details

object. Informations sur le cadre pour récupérer des informations sur :

tabId: integer. L'ID de l'onglet dans lequel se trouve le cadre.
processId Facultatif: integer. L'ID du processus exécutant le moteur de rendu pour cet onglet.
frameId: integer. L'ID du cadre dans l'onglet donné.

Valeur retournée

Une Promise qui sera rempli avec un objet contenant 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é.
url: string. L'URL actuellement associée à cette trame, si la trame identifiée par frameId existait à un point de l'onglet identifié par tabId. Le fait qu'une URL soit associée à un frameId donné n'implique pas que la trame correspondante existe toujours.
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.

Si l'onglet ou l'ID de trame 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é du navigateur

BCD tables only load in the browser

Exemples

function onGot(frameInfo) {
  console.log(frameInfo);
}

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

var gettingFrame = browser.webNavigation.getFrame({
  tabId: 19,
  frameId: 1537
});

// Edge specific - processId is required not optional, must be integer not null
//var gettingFrame = browser.webNavigation.getFrame({ tabId: 19, processId: 0, frameId: 1537 });

gettingFrame.then(onGot, onError);

Remerciements :

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.