webNavigation.getFrame()

Syntax

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

Parameter

details

object. Informationen über den abzurufenden Frame. Muss entweder documentId oder tabId und frameId enthalten.

tabId Optional

integer. Die ID des Tabs, in dem sich der Frame befindet. Erforderlich, wenn documentId nicht angegeben ist.

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 Optional

integer. Die ID des Frames im angegebenen Tab. Erforderlich, wenn documentId nicht angegeben ist.

documentId Optional

string. Die UUID des Dokuments des Frames. Wenn tabId und frameId ebenfalls angegeben sind, wird der Frame nur zurückgegeben, wenn alle Eigenschaften übereinstimmen. Siehe den Artikel mit documentId arbeiten für weitere Informationen.

Rückgabewert

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

errorOccurred

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

url

string. Die URL, die mit diesem Frame verbunden ist, wenn der durch frameId identifizierte Frame zu einem Zeitpunkt im durch tabId identifizierten Tab existierte. 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 es keinen übergeordneten Frame gibt, d.h. wenn dieser Frame der oberste Browsing-Kontext im Tab ist.

documentId

string. Eine UUID des Dokuments des Frames. Siehe den Artikel mit documentId arbeiten für weitere Informationen.

parentDocumentId

string. Eine UUID des übergeordneten Dokuments, dem der Frame gehört. Nicht gesetzt, wenn es keinen übergeordneten gibt. Siehe den Artikel mit documentId arbeiten für weitere Informationen.

documentLifecycle

string. Der Lebenszyklus, in dem sich das Dokument befindet. Gibt die Werte "prerender", "active", "cached" oder "pending_deletion" zurück.

Wenn der Tab verworfen wird, wird das Promise stattdessen mit einem null-Wert 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