browsingContext.close-Befehl

Syntax

/* With required parameters */
{
  "method": "browsingContext.close",
  "params": {
    "context": "93ee5bd6-d256-4608-a002-9a8995cc0e5f"
  }
}

/* With required and optional parameters */
{
  "method": "browsingContext.close",
  "params": {
    "context": "93ee5bd6-d256-4608-a002-9a8995cc0e5f",
    "promptUnload": true
  }
}

Parameter

Das Feld params enthält:

context

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

promptUnload Optional

Ein boolescher Wert, der angibt, ob der Browser vor dem Schließen des Kontexts beforeunload-Event-Handler ausführt.

• false: Der angegebene Kontext wird sofort geschlossen, ohne beforeunload-Event-Handler auszuführen. Dies ist der Standardwert.
• true: Der Browser führt beforeunload-Event-Handler aus, bevor er den angegebenen Kontext schließt. Eine dabei angezeigte Aufforderung wird gemäß der Capability unhandledPromptBehavior behandelt, die über den Befehl session.new festgelegt wurde.

Rückgabewert

Das Feld result 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

Es wurde kein Kontext mit der angegebenen Kontext-ID gefunden.

Beispiele

Einen Tab mit einer Bestätigungsaufforderung beim Verlassen der Seite schließen

Das folgende Beispiel zeigt, wie Sie einen Tab schließen und zuvor seine beforeunload-Event-Handler ausführen lassen.

Angenommen, über eine WebDriver-BiDi-Verbindung wurde mit session.new eine Sitzung erstellt, bei der das Feld default der Capability unhandledPromptBehavior auf "accept" gesetzt ist. Dadurch bestätigt der Browser jede Bestätigungsaufforderung automatisch. Ermitteln Sie zunächst die Kontext-ID mit browsingContext.getTree und senden Sie 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 den Wert true hat, führt der Browser vor dem Schließen alle beforeunload-Handler der Seite aus. Falls eine Bestätigungsaufforderung angezeigt wird, wird sie aufgrund der in session.new festgelegten Einstellung unhandledPromptBehavior automatisch bestätigt.

Spezifikationen

Browser-Kompatibilität

Siehe auch

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