browser.setDownloadBehavior-Befehl

Syntax

/* With required parameters */
{
  "method": "browser.setDownloadBehavior",
  "params": {
    "downloadBehavior": {
      "type": "allowed",
      "destinationFolder": "/tmp/downloads"
    }
  }
}

/* With required and optional parameters */
{
  "method": "browser.setDownloadBehavior",
  "params": {
    "downloadBehavior": {
      "type": "allowed",
      "destinationFolder": "/tmp/downloads"
    },
    "userContexts": ["4e4b1f6d-3f1a-4b2e-9f8c-1a2b3c4d5e6f"]
  }
}

Parameter

Das params-Feld enthält:

downloadBehavior

Ein Objekt mit den folgenden Feldern oder null, um das Standard-Downloadverhalten des Browsers wiederherzustellen:

type

Ein String, der angibt, ob Downloads erlaubt oder blockiert sind. Gültige Werte sind:

• "allowed": Zeigt an, dass Downloads erlaubt sind. Wenn dieser Wert gesetzt ist, ist das destinationFolder-Feld erforderlich.
• "denied": Zeigt an, dass Downloads blockiert sind.

destinationFolder

Ein String, der den Pfad zu dem Ordner angibt, in dem heruntergeladene Dateien gespeichert werden. Dieses Feld ist erforderlich, wenn type auf "allowed" gesetzt ist.

userContexts Optional

Ein Array von Strings, wobei jeder String die ID eines Benutzerkontexts ist, auf den das Downloadverhalten angewendet werden soll. Benutzerkontext-IDs werden von Befehlen wie browser.createUserContext oder browser.getUserContexts zurückgegeben.

• Wenn enthalten, wird das angegebene Downloadverhalten auf jeden aufgeführten Benutzerkontext angewendet. Wenn downloadBehavior null ist, wird die pro-Kontext-Überschreibung für jeden aufgelisteten Benutzerkontext zurückgesetzt.
• Wenn nicht enthalten, wird das angegebene Downloadverhalten als globaler Standard auf alle Benutzerkontexte angewendet.

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.

unsupported operation

Der Browser unterstützt das angegebene Downloadverhalten nicht.

no such user context

Kein Benutzerkontext mit der angegebenen Benutzerkontext-ID wird gefunden.

Beispiele

Downloads in einen bestimmten Ordner zulassen

Mit einer WebDriver BiDi-Verbindung und einer aktiven Sitzung senden Sie die folgende Nachricht, um das globale Downloadverhalten festzulegen und Downloads in einen bestimmten Ordner zu leiten:

{
  "id": 1,
  "method": "browser.setDownloadBehavior",
  "params": {
    "downloadBehavior": {
      "type": "allowed",
      "destinationFolder": "/home/user/downloads"
    }
  }
}

Der Browser antwortet wie folgt:

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

Downloads in mehreren Benutzerkontexten zulassen

Um Downloads in mehreren Benutzerkontexten zu erlauben, erhalten Sie die Benutzerkontext-IDs unter Verwendung von browser.createUserContext oder browser.getUserContexts, und senden Sie dann die folgende Nachricht, um Downloads in einen angegebenen Ordner zu leiten:

{
  "id": 2,
  "method": "browser.setDownloadBehavior",
  "params": {
    "downloadBehavior": {
      "type": "allowed",
      "destinationFolder": "/home/user/downloads/user-context"
    },
    "userContexts": [
      "4e4b1f6d-3f1a-4b2e-9f8c-1a2b3c4d5e6f",
      "9c2d8e45-fb12-4a67-bc34-567890abcdef"
    ]
  }
}

Der Browser antwortet wie folgt:

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

Downloads in einem bestimmten Benutzerkontext blockieren

Um Downloads in einem bestimmten Benutzerkontext zu blockieren, erhalten Sie zunächst die Benutzerkontext-ID mithilfe von browser.createUserContext oder browser.getUserContexts. Senden Sie dann die folgende Nachricht:

{
  "id": 3,
  "method": "browser.setDownloadBehavior",
  "params": {
    "downloadBehavior": {
      "type": "denied"
    },
    "userContexts": ["4e4b1f6d-3f1a-4b2e-9f8c-1a2b3c4d5e6f"]
  }
}

Der Browser antwortet wie folgt:

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

Downloadverhalten auf den Standard des Browsers zurücksetzen

Senden Sie die folgende Nachricht, um das globale Downloadverhalten auf den Standard des Browsers zurückzusetzen:

{
  "id": 4,
  "method": "browser.setDownloadBehavior",
  "params": {
    "downloadBehavior": null
  }
}

Der Browser antwortet wie folgt:

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

Spezifikationen

Browser-Kompatibilität

Siehe auch

• browser.createUserContext Befehl
• browser.getUserContexts Befehl