webNavigation.getFrame()

Syntax

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

Parameter

details

object. Informationen über den Frame, über den Informationen abgerufen werden sollen. Muss eine der Eigenschaften tabId, frameId oder documentId enthalten.

tabId Optional

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

processId Optional Veraltet

integer. Dieser Wert wird in modernen Browsern nicht gesetzt. Wenn er gesetzt war, stellte er die ID des Prozesses dar, der das Renderer für diesen Tab ausführte.

frameId Optional

integer. Die ID des Frames im angegebenen Tab.

documentId Optional

string. Die UUID des Dokuments des Frames.

Muss eine der folgenden Eigenschaften enthalten

Rückgabewert

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

errorOccurred

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

url

string. Die URL, die mit diesem Frame verbunden ist, falls der durch frameId identifizierte Frame zu einem Zeitpunkt im durch tabId identifizierten Tab existiert hat. Die Tatsache, dass eine URL mit einer bestimmten frameId verknüpft ist, impliziert nicht, dass der entsprechende Frame noch existiert.

frameType

string. Der Typ des Frames. Gibt die Werte "outermost_frame", "fenced_frame" oder "sub_frame" zurück.

parentFrameId

integer. ID des übergeordneten Frames. Dies ist -1, wenn kein übergeordneter Frame existiert: das heißt, wenn dieser Frame der oberste Browsing-Kontext im Tab ist.

documentId

string. Eine UUID des Dokuments des Frames.

parentDocumentId

string. Eine UUID des übergeordneten Dokuments, dem der Frame gehört. Nicht gesetzt, wenn kein übergeordnetes Dokument existiert.

documentLifecycle

string. Der Lebenszyklus des Dokuments. Gibt die Werte "prerender", "active", "cached" oder "pending_deletion" zurück.

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

Beispiele

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);

Browser-Kompatibilität