downloads.onChanged
Das onChanged()
-Ereignis der downloads
-API wird ausgelöst, wenn sich eine der Eigenschaften eines downloads.DownloadItem
ändert (außer bytesReceived
).
Dem Listener wird ein downloadDelta
als Parameter übergeben — ein Objekt, das die downloadId
des betreffenden downloads.DownloadItem
-Objekts sowie den Status aller geänderten Eigenschaften enthält.
Syntax
browser.downloads.onChanged.addListener(listener)
browser.downloads.onChanged.removeListener(listener)
browser.downloads.onChanged.hasListener(listener)
Ereignisse haben drei Funktionen:
addListener(listener)
-
Fügt diesem Ereignis einen Listener hinzu.
removeListener(listener)
-
Stoppt das Lauschen auf dieses Ereignis. Das
listener
-Argument ist der zu entfernende Listener. hasListener(listener)
-
Überprüft, ob ein bestimmter
listener
für dieses Ereignis registriert ist. Gibttrue
zurück, wenn es lauscht, andernfallsfalse
.
addListener Syntax
Parameter
listener
-
Die Funktion, die aufgerufen wird, wenn dieses Ereignis eintritt. Dieser Funktion wird folgendes Argument übergeben:
downloadDelta
-
Ein
object
, das das geändertedownloads.DownloadItem
-Objekt darstellt und den Status aller darin geänderten Eigenschaften enthält. Weitere Details finden Sie im Abschnitt downloadDelta.
Zusätzliche Objekte
downloadDelta
Das downloadDelta
-Objekt hat die folgenden verfügbaren Eigenschaften:
id
-
Ein
integer
, der dieid
des geändertendownloads.DownloadItem
darstellt. url
Optional-
Ein
downloads.StringDelta
-Objekt, das eine Änderung derurl
einesdownloads.DownloadItem
beschreibt. filename
Optional-
Ein
downloads.StringDelta
-Objekt, das eine Änderung desfilename
einesdownloads.DownloadItem
beschreibt. danger
Optional-
Ein
downloads.StringDelta
-Objekt, das eine Änderung derdanger
-Eigenschaft einesdownloads.DownloadItem
beschreibt. mime
Optional-
Ein
downloads.StringDelta
-Objekt, das eine Änderung desmime
einesdownloads.DownloadItem
beschreibt. startTime
Optional-
Ein
downloads.StringDelta
-Objekt, das eine Änderung derstartTime
einesdownloads.DownloadItem
beschreibt. endTime
Optional-
Ein
downloads.StringDelta
-Objekt, das eine Änderung derendTime
einesdownloads.DownloadItem
beschreibt. state
Optional-
Ein
downloads.StringDelta
-Objekt, das eine Änderung desstate
einesdownloads.DownloadItem
beschreibt. canResume
Optional-
Ein
downloads.BooleanDelta
-Objekt, das eine Änderung descanResume
-Status einesdownloads.DownloadItem
beschreibt. paused
Optional-
Ein
downloads.BooleanDelta
-Objekt, das eine Änderung despaused
-Status einesdownloads.DownloadItem
beschreibt. error
Optional-
Ein
downloads.StringDelta
-Objekt, das eine Änderung deserror
-Status einesdownloads.DownloadItem
beschreibt. totalBytes
Optional-
Ein
downloads.DoubleDelta
-Objekt, das eine Änderung dertotalBytes
einesdownloads.DownloadItem
beschreibt. fileSize
Optional-
Ein
downloads.DoubleDelta
-Objekt, das eine Änderung derfileSize
einesdownloads.DownloadItem
beschreibt. exists
Optional-
Ein
downloads.BooleanDelta
-Objekt, das eine Änderung desexists
-Status einesdownloads.DownloadItem
beschreibt.
Browser-Kompatibilität
BCD tables only load in the browser
Beispiele
Protokollieren Sie eine Nachricht, wenn Downloads abgeschlossen sind:
function handleChanged(delta) {
if (delta.state && delta.state.current === "complete") {
console.log(`Download ${delta.id} has completed.`);
}
}
browser.downloads.onChanged.addListener(handleChanged);
Hinweis: Diese API basiert auf der chrome.downloads
-API von Chromium.