browsingContext.downloadEnd-Ereignis
Das Ereignis browsingContext.downloadEnd des Moduls browsingContext wird ausgelöst, wenn ein Dateidownload endet – entweder weil er abgeschlossen oder weil er abgebrochen wurde.
Ereignisdaten
Das Feld params in der Ereignisbenachrichtigung ist ein Objekt mit einem Feld status. Der Wert von status bestimmt, welche zusätzlichen Felder vorhanden sind.
context-
Ein String mit der ID des Kontexts, in dem der Download stattfand.
download-
Ein String mit der UUID, die diesen Download eindeutig identifiziert. Dieselbe ID ist im zugehörigen Ereignis
browsingContext.downloadWillBeginenthalten, sodass Sie die beiden Ereignisse einander zuordnen können. filepathOptional-
Ein String mit dem Pfad, unter dem der Browser die heruntergeladene Datei gespeichert hat, oder
null, wenn der Pfad nicht verfügbar ist. Dieses Feld ist nur vorhanden, wenn das Feldstatusden Wert"complete"hat. -
Ein String mit der UUID, die die zugehörige Navigation eindeutig identifiziert, oder
null, wenn der Download keiner Navigation zugeordnet ist. Wenn die Navigation mit dem BefehlbrowsingContext.navigateoderbrowsingContext.reloadgestartet wurde, entspricht diese ID dem Wert vonnavigationin der Antwort auf den Befehl. Dieselbe ID wird auch von anderen Ereignissen verwendet, die für diese Navigation ausgelöst werden, etwabrowsingContext.navigationStartedund Ereignissen des Modulsnetwork. status-
Ein String, der das Ergebnis des Downloads angibt. Er hat einen der folgenden Werte:
"canceled": Der Download wurde vor seinem Abschluss abgebrochen."complete": Der Download wurde erfolgreich abgeschlossen.
timestamp-
Eine nicht negative Ganzzahl, die den Zeitpunkt angibt, zu dem das Ereignis ausgelöst wurde, gemessen in Millisekunden seit der Epoche.
url-
Ein String mit der URL des Downloads.
Beispiele
>Ein Ereignis empfangen, wenn ein Download abgeschlossen wird
Angenommen, Sie verfügen über eine WebDriver-BiDi-Verbindung, eine aktive Sitzung und ein aktives Abonnement für browsingContext.downloadEnd.
Wenn ein Download abgeschlossen wird und der Browser die Datei auf dem Datenträger speichert, sendet der Browser die folgende Benachrichtigung:
{
"type": "event",
"method": "browsingContext.downloadEnd",
"params": {
"context": "93ee5bd6-d256-4608-a002-9a8995cc0e5f",
"download": "6bfa8781-e33c-4f2c-8e63-4d0f6dc5d1a1",
"filepath": "/home/user/Downloads/report.pdf",
"navigation": "0e2f4d20-8f0a-4de7-9749-1b12a0d6c8b0",
"status": "complete",
"timestamp": 1737033601500,
"url": "https://example.com/files/report.pdf"
}
}
Ein Ereignis empfangen, wenn ein Download abgebrochen wird
Nehmen Sie bei derselben Verbindung, Sitzung und demselben Abonnement wie im vorherigen Beispiel an, dass das Feld type des Objekts downloadBehavior, das an den Befehl browser.setDownloadBehavior übergeben wird, auf "denied" gesetzt ist.
Dadurch lehnt der Browser den Download ab, statt die Datei zu speichern.
In diesem Fall sendet der Browser die folgende Benachrichtigung:
{
"type": "event",
"method": "browsingContext.downloadEnd",
"params": {
"context": "93ee5bd6-d256-4608-a002-9a8995cc0e5f",
"download": "6bfa8781-e33c-4f2c-8e63-4d0f6dc5d1a1",
"navigation": "0e2f4d20-8f0a-4de7-9749-1b12a0d6c8b0",
"status": "canceled",
"timestamp": 1737033601500,
"url": "https://example.com/files/report.pdf"
}
}
Spezifikationen
| Spezifikation |
|---|
| WebDriver BiDi> # event-browsingContext-downloadEnd> |
Browser-Kompatibilität
Siehe auch
- Ereignis
browsingContext.downloadWillBegin - Befehl
browser.setDownloadBehavior - Befehl
session.subscribe