browsingContext.close Befehl

Syntax

{
  "method": "browsingContext.close",
  "params": {
    "context": "<contextId>"
  }
}

Parameter

Das params-Feld enthält:

context

Ein String, der die ID des zu schließenden Top-Level-Kontexts enthält. Kontext-IDs werden von Befehlen wie browsingContext.getTree zurückgegeben.

promptUnload Optional

Ein Boolean, der angibt, ob der Browser beforeunload Ereignishandler ausführt, bevor der Kontext geschlossen wird. Der Standardwert ist false.

• false: Der angegebene Kontext wird sofort geschlossen, ohne beforeunload-Ereignishandler auszuführen.
• true: Der Browser führt beforeunload-Ereignishandler aus, bevor der angegebene Kontext geschlossen wird. Jeder resultierende Prompt wird gemäß der durch den session.new Befehl angegebenen Fähigkeit unhandledPromptBehavior behandelt.

Rückgabewert

Das result-Feld in der Antwort ist ein leeres Objekt ({}).

Fehler

invalid argument

Ein erforderlicher Parameter fehlt oder hat einen ungültigen Typ. Dieser Fehler wird auch zurückgegeben, wenn der durch context angegebene Kontext kein Top-Level-Kontext ist.

no such frame

Kein Kontext mit der angegebenen Kontext-ID gefunden.

Beispiele

Schließen eines Tabs mit einem Page-Unload-Prompt

Das folgende Beispiel zeigt, wie Sie einen Tab schließen und dessen beforeunload Ereignishandler vor dem Schließen ausführen lassen können.

Angenommen, eine Sitzung wird über session.new mit unhandledPromptBehavior auf "accept" gesetzt durch eine WebDriver BiDi-Verbindung. Zuerst erhalten Sie die Kontext-ID mit browsingContext.getTree, und senden dann die folgende Nachricht:

{
  "id": 1,
  "method": "browsingContext.close",
  "params": {
    "context": "5e5e96e8-5247-4f22-9b35-a4a2d841cbaa",
    "promptUnload": true
  }
}

Der Browser schließt den Kontext und antwortet wie folgt:

{
  "id": 1,
  "type": "success",
  "result": {}
}

Da promptUnload true ist, führt der Browser alle beforeunload Handler auf der Seite aus, bevor er schließt. Der Bestätigungsprompt, falls angezeigt, wird basierend auf der unhandledPromptBehavior-Einstellung, die in session.new definiert ist, automatisch akzeptiert.

Spezifikationen

Browser-Kompatibilität

Siehe auch

• browsingContext.activate Befehl
• browsingContext.create Befehl
• browsingContext.getTree Befehl
• browsingContext.contextDestroyed Ereignis