webNavigation.getFrame()

Ruft Informationen über einen bestimmten Frame ab. Ein Frame kann entweder der oberste Frame in einem Tab oder ein verschachteltes <iframe> sein und wird eindeutig durch eine Tab-ID und eine Frame-ID identifiziert.

Dies ist eine asynchrone Funktion, die ein Promise zurückgibt.

Syntax

js
let gettingFrame = browser.webNavigation.getFrame(
  details                // object
)

Parameter

details

object. Informationen über den Frame, für den Informationen abgerufen werden sollen.

tabId

integer. Die ID des Tabs, in dem sich der Frame befindet.

processId Optional

integer. Dieser Wert wird in modernen Browsern nicht gesetzt. Wenn er gesetzt war, repräsentierte er die ID des Prozesses, der den Renderer für diesen Tab ausführte.

frameId

integer. Die ID des Frames im angegebenen Tab.

Rückgabewert

Ein Promise, das mit einem Objekt erfüllt wird, das die folgenden Eigenschaften enthält:

errorOccurred

boolean. True, wenn die letzte Navigation in diesem Frame durch einen Fehler unterbrochen wurde, d.h. das onErrorOccurred-Ereignis wurde ausgelöst.

url

string. Die URL, die derzeit mit diesem Frame verknüpft ist, wenn der mit frameId identifizierte Frame zu einem bestimmten Zeitpunkt in dem mit tabId identifizierten Tab existierte. Die Tatsache, dass eine URL mit einer bestimmten frameId verknüpft ist, impliziert nicht, dass der entsprechende Frame noch existiert.

parentFrameId

integer. Die ID des übergeordneten Frames. Dies ist -1, wenn es keinen übergeordneten Frame gibt: das heißt, wenn dieser Frame der oberste Browsing-Kontext im Tab ist.

Wenn der Tab verworfen ist, wird das Promise stattdessen mit einem null-Wert aufgelöst. Wenn der angegebene Tab oder die Frame-ID nicht gefunden werden konnte oder ein anderer Fehler auftritt, wird das Promise mit einer Fehlermeldung abgelehnt.

Browser-Kompatibilität

Beispiele

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

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

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

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

gettingFrame.then(onGot, onError);

Hinweis: Diese API basiert auf Chromiums chrome.webNavigation API. Diese Dokumentation ist abgeleitet von web_navigation.json im Chromium-Code.