refresh date: 2026-09-25 robots: noindex
Diese Berechtigung löst eine Warnung aus.
Beschreibung
Mit der chrome.downloads API können Sie Downloads programmatisch initiieren, überwachen, bearbeiten und suchen.
Berechtigungen
downloadsManifest
Sie müssen die Berechtigung "downloads" im Erweiterungsmanifest deklarieren, um diese API zu verwenden.
{
"name": "My extension",
...
"permissions": [
"downloads"
],
...
}
Beispiele
Einfache Beispiele für die Verwendung der chrome.downloads API finden Sie im Verzeichnis examples/api/downloads. Weitere Beispiele und Hilfe zum Aufrufen des Quellcodes finden Sie unter Beispiele.
Typen
BooleanDelta
Attribute
-
aktuell
Boolesch optional
-
Zurück
Boolesch optional
DangerType
Enum
"file"
Der Dateiname des Downloads ist verdächtig.
"url"
Die Download-URL ist als schädlich bekannt.
"content"
Die heruntergeladene Datei ist bekanntermaßen schädlich.
„uncommon“
Die URL des Downloads wird nicht häufig heruntergeladen und könnte gefährlich sein.
„host“
Der Download stammt von einem Host, der dafür bekannt ist, schädliche Binärdateien zu verbreiten, und ist wahrscheinlich gefährlich.
„unwanted“
Der Download ist potenziell unerwünscht oder unsicher. Beispielsweise könnte sie Änderungen an Browser- oder Computereinstellungen vornehmen.
„safe“
Der Download stellt keine bekannte Gefahr für den Computer des Nutzers dar.
"accepted"
Der Nutzer hat den gefährlichen Download akzeptiert.
"allowlistedByPolicy"
Unternehmensbezogene Werte.
"asyncScanning"
"asyncLocalPasswordScanning"
"passwordProtected"
"blockedTooLarge"
"sensitiveContentWarning"
"sensitiveContentBlock"
"deepScannedFailed"
"deepScannedSafe"
"deepScannedOpenedDangerous"
"promptForScanning"
"promptForLocalPasswordScanning"
"accountCompromise"
"blockedScanFailed"
"forceSaveToGdrive"
Zur Verwendung durch die Secure Enterprise Browser-Erweiterung. Bei Bedarf blockiert Chrome den Download auf die Festplatte und lädt die Datei direkt in Google Drive herunter.
"forceSaveToOnedrive"
Zur Verwendung durch die Secure Enterprise Browser-Erweiterung. Bei Bedarf blockiert Chrome den Download auf die Festplatte und lädt die Datei direkt in OneDrive herunter.
DoubleDelta
Attribute
-
aktuell
number optional
-
Zurück
number optional
DownloadDelta
Attribute
-
canResume
BooleanDelta optional
Die Änderung in
canResume, falls vorhanden. -
danger
StringDelta optional
Die Änderung in
danger, falls vorhanden. -
endTime
StringDelta optional
Die Änderung in
endTime, falls vorhanden. -
Fehler
StringDelta optional
Die Änderung in
error, falls vorhanden. -
vorhanden
BooleanDelta optional
Die Änderung in
exists, falls vorhanden. -
fileSize
DoubleDelta optional
Die Änderung in
fileSize, falls vorhanden. -
filename
StringDelta optional
Die Änderung in
filename, falls vorhanden. -
finalUrl
StringDelta optional
Chrome 54 oder höherDie Änderung in
finalUrl, falls vorhanden. -
id
Zahl
Der
iddesDownloadItem, der geändert wurde. -
Pantomime
StringDelta optional
Die Änderung in
mime, falls vorhanden. -
pausiert
BooleanDelta optional
Die Änderung in
paused, falls vorhanden. -
startTime
StringDelta optional
Die Änderung in
startTime, falls vorhanden. -
Bundesstaat
StringDelta optional
Die Änderung in
state, falls vorhanden. -
totalBytes
DoubleDelta optional
Die Änderung in
totalBytes, falls vorhanden. -
URL
StringDelta optional
Die Änderung in
url, falls vorhanden.
DownloadItem
Attribute
-
byExtensionId
String optional
Die Kennung der Erweiterung, die diesen Download initiiert hat, falls der Download von einer Erweiterung initiiert wurde. Ändert sich nach dem Festlegen nicht mehr.
-
byExtensionName
String optional
Der lokalisierte Name der Erweiterung, die diesen Download initiiert hat, falls dieser Download von einer Erweiterung initiiert wurde. Kann sich ändern, wenn die Erweiterung ihren Namen ändert oder der Nutzer seine Spracheinstellung ändert.
-
bytesReceived
Zahl
Anzahl der bisher vom Host empfangenen Byte, ohne Berücksichtigung der Dateikomprimierung.
-
canResume
boolean
„True“, wenn der Download gerade ausgeführt wird und pausiert ist oder wenn er unterbrochen wurde und an der Stelle fortgesetzt werden kann, an der er unterbrochen wurde.
-
danger
Angabe, ob dieser Download als sicher gilt oder als verdächtig bekannt ist.
-
endTime
String optional
Der Zeitpunkt, zu dem der Download beendet wurde, im ISO 8601-Format. Kann direkt an den Date-Konstruktor übergeben werden:
chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.endTime) console.log(new Date(item.endTime))})}) -
Fehler
InterruptReason optional
Gründe für die Unterbrechung des Downloads Mehrere Arten von HTTP-Fehlern können unter einem der Fehler zusammengefasst werden, die mit
SERVER_beginnen. Fehler im Zusammenhang mit dem Netzwerk beginnen mitNETWORK_, Fehler im Zusammenhang mit dem Schreiben der Datei in das Dateisystem beginnen mitFILE_und vom Nutzer initiierte Unterbrechungen beginnen mitUSER_. -
estimatedEndTime
String optional
Geschätzte Zeit, zu der der Download abgeschlossen sein wird, im ISO 8601-Format. Kann direkt an den Date-Konstruktor übergeben werden:
chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.estimatedEndTime) console.log(new Date(item.estimatedEndTime))})}) -
vorhanden
boolean
Ob die heruntergeladene Datei noch vorhanden ist. Diese Informationen sind möglicherweise veraltet, da Chrome nicht automatisch nach entfernten Dateien sucht. Rufen Sie
search() auf, um die Prüfung auf das Vorhandensein der Datei auszulösen. Wenn die Prüfung abgeschlossen ist und die Datei gelöscht wurde, wird einonChanged-Ereignis ausgelöst. Beachten Sie, dasssearch() nicht wartet, bis die Existenzprüfung abgeschlossen ist, bevor es zurückgegeben wird. Daher spiegeln die Ergebnisse vonsearch() das Dateisystem möglicherweise nicht genau wider. Außerdem kannsearch() so oft wie nötig aufgerufen werden, aber die Existenz der Datei wird nicht häufiger als einmal alle 10 Sekunden geprüft. -
fileSize
Zahl
Anzahl der Byte in der gesamten Datei nach der Dekomprimierung oder -1, wenn unbekannt.
-
filename
String
Absoluter lokaler Pfad.
-
finalUrl
String
Chrome 54 oder höherDie absolute URL, von der dieser Download nach allen Weiterleitungen erfolgt.
-
id
Zahl
Eine Kennung, die über Browsersitzungen hinweg erhalten bleibt.
-
inkognito
boolean
„False“, wenn dieser Download im Verlauf aufgezeichnet wird, andernfalls „True“.
-
Pantomime
String
Der MIME-Typ der Datei.
-
pausiert
boolean
„True“, wenn der Download keine Daten mehr vom Host liest, die Verbindung aber offen bleibt.
-
referrer
String
Absolute URL.
-
startTime
String
Der Zeitpunkt, zu dem der Download begonnen hat, im ISO 8601-Format. Kann direkt an den Date-Konstruktor übergeben werden:
chrome.downloads.search({}, function(items){items.forEach(function(item){console.log(new Date(item.startTime))})}) -
Bundesstaat
Gibt an, ob der Download läuft, unterbrochen oder abgeschlossen ist.
-
totalBytes
Zahl
Anzahl der Byte in der gesamten Datei, ohne Berücksichtigung der Dateikomprimierung, oder -1, wenn unbekannt.
-
URL
String
Die absolute URL, von der dieser Download vor Weiterleitungen initiiert wurde.
DownloadOptions
Attribute
-
Text
String optional
Post-Text.
-
conflictAction
FilenameConflictAction optional
Die auszuführende Aktion, wenn
filenamebereits vorhanden ist. -
filename
String optional
Ein Dateipfad relativ zum Verzeichnis „Downloads“, der die heruntergeladene Datei enthält, möglicherweise mit Unterverzeichnissen. Absolute Pfade, leere Pfade und Pfade mit Rückverweisen „..“ verursachen einen Fehler. Mit
onDeterminingFilenamekann ein Dateiname vorgeschlagen werden, nachdem der MIME-Typ der Datei und ein vorläufiger Dateiname ermittelt wurden. -
headers
HeaderNameValuePair[] optional
Zusätzliche HTTP-Header, die mit der Anfrage gesendet werden sollen, wenn die URL das HTTP[s]-Protokoll verwendet. Jeder Header wird als Wörterbuch dargestellt, das die Schlüssel
nameund entwedervalueoderbinaryValueenthält, beschränkt auf die von XMLHttpRequest zugelassenen Schlüssel. -
method
HttpMethod optional
Die HTTP-Methode, die verwendet werden soll, wenn die URL das HTTP[S]-Protokoll verwendet.
-
saveAs
Boolesch optional
Verwenden Sie eine Dateiauswahl, damit der Nutzer einen Dateinamen auswählen kann, unabhängig davon, ob
filenamefestgelegt ist oder bereits existiert. -
URL
String
Die URL, die heruntergeladen werden soll.
DownloadQuery
Attribute
-
bytesReceived
number optional
Anzahl der bisher vom Host empfangenen Byte, ohne Berücksichtigung der Dateikomprimierung.
-
danger
DangerType optional
Angabe, ob dieser Download als sicher gilt oder als verdächtig bekannt ist.
-
endTime
String optional
Der Zeitpunkt, zu dem der Download beendet wurde, im ISO 8601-Format.
-
endedAfter
String optional
Beschränkt die Ergebnisse auf
DownloadItem, die nach den angegebenen Millisekunden im ISO 8601-Format endeten -
endedBefore
String optional
Beschränkt die Ergebnisse auf
DownloadItem, die vor der angegebenen Millisekunde im ISO 8601-Format endeten. -
Fehler
InterruptReason optional
Gründe für die Unterbrechung eines Downloads
-
vorhanden
Boolesch optional
Ob die heruntergeladene Datei vorhanden ist
-
fileSize
number optional
Anzahl der Byte in der gesamten Datei nach der Dekomprimierung oder -1, wenn unbekannt.
-
filename
String optional
Absoluter lokaler Pfad.
-
filenameRegex
String optional
Beschränkt die Ergebnisse auf
DownloadItem, derenfilenamemit dem angegebenen regulären Ausdruck übereinstimmt. -
finalUrl
String optional
Chrome 54 oder höherDie absolute URL, von der dieser Download nach allen Weiterleitungen erfolgt.
-
finalUrlRegex
String optional
Chrome 54 oder höherBeschränkt die Ergebnisse auf
DownloadItem, derenfinalUrlmit dem angegebenen regulären Ausdruck übereinstimmt. -
id
number optional
Die
idderDownloadItem, die abgefragt werden soll. -
Limit
number optional
Die maximale Anzahl der zurückgegebenen übereinstimmenden
DownloadItem. Standardwert ist 1.000. Legen Sie den Wert auf 0 fest, um alle übereinstimmendenDownloadItemzurückzugeben. Informationen zum Durchblättern der Ergebnisse finden Sie untersearch. -
Pantomime
String optional
Der MIME-Typ der Datei.
-
orderBy
string[] optional
Legen Sie Elemente dieses Arrays auf
DownloadItem-Attribute fest, um Suchergebnisse zu sortieren. Wenn Sie beispielsweiseorderBy=['startTime']festlegen, werden dieDownloadItemin aufsteigender Reihenfolge nach ihrem Beginn sortiert. Wenn Sie absteigend sortieren möchten, stellen Sie einen Bindestrich voran: „-startTime“. -
pausiert
Boolesch optional
„True“, wenn der Download keine Daten mehr vom Host liest, die Verbindung aber offen bleibt.
-
Abfrage
string[] optional
Dieses Array von Suchbegriffen beschränkt die Ergebnisse auf
DownloadItem, derenfilename,urloderfinalUrlalle Suchbegriffe enthalten, die nicht mit einem Bindestrich „-“ beginnen, und keine der Suchbegriffe, die mit einem Bindestrich beginnen. -
startTime
String optional
Der Zeitpunkt, zu dem der Download begonnen hat, im ISO 8601-Format.
-
startedAfter
String optional
Beschränkt die Ergebnisse auf
DownloadItem, die nach der angegebenen Millisekunde im ISO 8601-Format gestartet wurden. -
startedBefore
String optional
Beschränkt die Ergebnisse auf
DownloadItem, die vor der angegebenen Millisekunde im ISO 8601-Format begonnen haben. -
Bundesstaat
State optional
Gibt an, ob der Download läuft, unterbrochen oder abgeschlossen ist.
-
totalBytes
number optional
Anzahl der Byte in der gesamten Datei, ohne Berücksichtigung der Dateikomprimierung, oder -1, wenn unbekannt.
-
totalBytesGreater
number optional
Beschränkt die Ergebnisse auf
DownloadItem, derentotalBytesgrößer als die angegebene Ganzzahl ist. -
totalBytesLess
number optional
Beschränkt die Ergebnisse auf
DownloadItem, derentotalByteskleiner als die angegebene Ganzzahl ist. -
URL
String optional
Die absolute URL, von der dieser Download vor Weiterleitungen initiiert wurde.
-
urlRegex
String optional
Beschränkt die Ergebnisse auf
DownloadItem, derenurlmit dem angegebenen regulären Ausdruck übereinstimmt.
FilenameConflictAction
uniquify
Um Duplikate zu vermeiden, wird der filename so geändert, dass vor der Dateiendung ein Zähler eingefügt wird.
überschreiben
Die vorhandene Datei wird durch die neue Datei überschrieben.
Prompt
Der Nutzer wird aufgefordert, eine Datei auszuwählen.
Enum
"uniquify"
"overwrite"
"prompt"
FilenameSuggestion
Attribute
-
conflictAction
FilenameConflictAction optional
Die auszuführende Aktion, wenn
filenamebereits vorhanden ist. -
filename
String
Das neue Ziel
DownloadItem.filenamevonDownloadItemals Pfad relativ zum Standard-Downloadverzeichnis des Nutzers, das möglicherweise Unterverzeichnisse enthält. Absolute Pfade, leere Pfade und Pfade mit Rückverweisen „..“ werden ignoriert.filenamewird ignoriert, wenn von ErweiterungenonDeterminingFilename-Listener registriert wurden.
GetFileIconOptions
Attribute
-
Größe
number optional
Die Größe des zurückgegebenen Symbols in dichteunabhängigen Pixeln (DIPs). Muss entweder 16 oder 32 sein (Standardwert ist 32). Auf Displays mit hohem DPI-Wert wird das zurückgegebene Bild mit dem Skalierungsfaktor des Geräts skaliert (z.B. 64 × 64 Pixel für Größe 32 auf einem 2x-Display). Anrufe von Hintergrund-Service-Workern werden standardmäßig mit 1-facher Skalierung ausgeführt.
HeaderNameValuePair
Attribute
-
name
String
Name des HTTP-Headers.
-
Wert
String
Wert des HTTP-Headers.
HttpMethod
Enum
"GET"
"POST"
InterruptReason
Enum
"FILE_FAILED"
"FILE_ACCESS_DENIED"
"FILE_NO_SPACE"
"FILE_NAME_TOO_LONG"
"FILE_TOO_LARGE"
"FILE_VIRUS_INFECTED"
"FILE_TRANSIENT_ERROR"
"FILE_BLOCKED"
"FILE_SECURITY_CHECK_FAILED"
"FILE_TOO_SHORT"
"FILE_HASH_MISMATCH"
"FILE_SAME_AS_SOURCE"
"NETWORK_FAILED"
"NETWORK_TIMEOUT"
"NETWORK_DISCONNECTED"
"NETWORK_SERVER_DOWN"
"NETWORK_INVALID_REQUEST"
"SERVER_FAILED"
"SERVER_NO_RANGE"
"SERVER_BAD_CONTENT"
"SERVER_UNAUTHORIZED"
"SERVER_CERT_PROBLEM"
"SERVER_FORBIDDEN"
"SERVER_UNREACHABLE"
"SERVER_CONTENT_LENGTH_MISMATCH"
"SERVER_CROSS_ORIGIN_REDIRECT"
"USER_CANCELED"
"USER_SHUTDOWN"
"CRASH"
State
in_progress
Der Download empfängt derzeit Daten vom Server.
unterbrochen
Die Verbindung zum Datei-Host wurde aufgrund eines Fehlers unterbrochen.
abgeschlossen
Der Download wurde abgeschlossen.
Enum
"in_progress"
"interrupted"
"complete"
StringDelta
Attribute
-
aktuell
String optional
-
Zurück
String optional
UiOptions
Attribute
-
aktiviert
boolean
Download-Benutzeroberfläche aktivieren oder deaktivieren.
Methoden
acceptDanger()
chrome.downloads.acceptDanger(
downloadId: number,
callback?: function,
): Promise<void>
Nutzer auffordern, einen gefährlichen Download zu akzeptieren. Kann nur aus einem sichtbaren Kontext (Tab, Fenster oder Pop-up für Seiten-/Browseraktionen) aufgerufen werden. Gefährliche Downloads werden nicht automatisch akzeptiert. Wenn der Download akzeptiert wird, wird ein onChanged-Ereignis ausgelöst. Andernfalls passiert nichts. Wenn alle Daten in eine temporäre Datei abgerufen wurden und der Download entweder nicht gefährlich ist oder die Gefahr akzeptiert wurde, wird die temporäre Datei in den Zieldateinamen umbenannt, der state ändert sich in „complete“ und onChanged wird ausgelöst.
Parameter
-
downloadId
Zahl
Die Kennung für die
DownloadItem. -
callback
function optional
Der Parameter
callbacksieht so aus:() => void
Ausgabe
-
Promise<void>
Chrome 96 oder höherGibt ein Promise zurück, das aufgelöst wird, wenn das Dialogfeld mit der Gefahrenmeldung geschlossen wird.
Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.
cancel()
chrome.downloads.cancel(
downloadId: number,
callback?: function,
): Promise<void>
Download abbrechen Wenn callback ausgeführt wird, wird der Download abgebrochen, abgeschlossen, unterbrochen oder ist nicht mehr vorhanden.
Parameter
-
downloadId
Zahl
Die ID des Downloads, der abgebrochen werden soll.
-
callback
function optional
Der Parameter
callbacksieht so aus:() => void
Ausgabe
-
Promise<void>
Chrome 96 oder höherGibt ein Promise zurück, das aufgelöst wird, wenn die Abbruchanfrage abgeschlossen ist.
Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.
download()
chrome.downloads.download(
options: DownloadOptions,
callback?: function,
): Promise<number>
URL herunterladen Wenn die URL das HTTP[S]-Protokoll verwendet, enthält die Anfrage alle Cookies, die derzeit für den Hostnamen festgelegt sind. Wenn sowohl filename als auch saveAs angegeben sind, wird das Dialogfeld „Speichern unter“ angezeigt, das mit dem angegebenen filename vorab ausgefüllt ist. Wenn der Download erfolgreich gestartet wurde, wird callback mit der downloadId des neuen DownloadItem aufgerufen. Wenn beim Starten des Downloads ein Fehler aufgetreten ist, wird callback mit downloadId=undefined aufgerufen und runtime.lastError enthält einen beschreibenden String. Es kann nicht garantiert werden, dass die Fehlerstrings zwischen den Releases abwärtskompatibel bleiben. Erweiterungen dürfen sie nicht parsen.
Parameter
-
Optionen
Was du herunterladen kannst und wie das geht.
-
callback
function optional
Der Parameter
callbacksieht so aus:(downloadId: number) => void
-
downloadId
Zahl
-
Ausgabe
-
Promise<number>
Chrome 96 oder höherGibt ein Promise zurück, das mit der ID des neuen
DownloadItemaufgelöst wird.Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.
erase()
chrome.downloads.erase(
query: DownloadQuery,
callback?: function,
): Promise<number[]>
Übereinstimmende DownloadItem aus dem Verlauf löschen, ohne die heruntergeladene Datei zu löschen. Für jede DownloadItem, die mit query übereinstimmt, wird ein onErased-Ereignis ausgelöst. Anschließend wird callback aufgerufen.
Parameter
-
Abfrage
-
callback
function optional
Der Parameter
callbacksieht so aus:(erasedIds: number[]) => void
-
erasedIds
number[]
-
Ausgabe
-
Promise<number[]>
Chrome 96 oder höherPromises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.
getFileIcon()
chrome.downloads.getFileIcon(
downloadId: number,
options?: GetFileIconOptions,
callback?: function,
): Promise<string | undefined>
Ruft ein Symbol für den angegebenen Download ab. Bei neuen Downloads sind Dateisymbole verfügbar, nachdem der Zieldateiname des Downloads ermittelt wurde, z. B. wenn onChanged mit einer filename-Änderung ausgelöst wird. Wenn Sie versuchen, das Symbol abzurufen, bevor der Dateiname festgelegt wurde, wird ein Fehler über runtime.lastError ausgegeben. Das von dieser Funktion zurückgegebene Bild kann sich während eines Downloads von dem Bild unterscheiden, das nach Abschluss des Downloads zurückgegeben wird. Das Abrufen von Symbolen erfolgt je nach Plattform durch Abfragen des zugrunde liegenden Betriebssystems oder Toolkits. Das zurückgegebene Symbol hängt daher von einer Reihe von Faktoren ab, darunter dem Status des Downloads, der Plattform, den registrierten Dateitypen und dem visuellen Design. Wenn kein Dateisymbol ermittelt werden kann, enthält runtime.lastError eine Fehlermeldung.
Parameter
-
downloadId
Zahl
Die ID für den Download.
-
Optionen
GetFileIconOptions optional
-
callback
function optional
Der Parameter
callbacksieht so aus:(iconURL?: string) => void
-
iconURL
String optional
-
Ausgabe
-
Promise<string | undefined>
Chrome 96 oder höherGibt ein Promise zurück, das mit einer URL zu einem Bild aufgelöst wird, das den Download darstellt.
Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.
open()
chrome.downloads.open(
downloadId: number,
callback?: function,
): Promise<void>
Öffnet die heruntergeladene Datei, wenn der DownloadItem abgeschlossen ist. Andernfalls wird ein Fehler über runtime.lastError zurückgegeben. Für diese Methode ist zusätzlich zur Berechtigung "downloads" die Berechtigung "downloads.open" erforderlich. Ein onChanged-Ereignis wird ausgelöst, wenn das Element zum ersten Mal geöffnet wird. Diese Methode kann nur als Reaktion auf eine Nutzergeste aufgerufen werden.
Parameter
-
downloadId
Zahl
Die Kennung für die heruntergeladene Datei.
-
callback
function optional
Chrome 123 und höherDer Parameter
callbacksieht so aus:() => void
Ausgabe
-
Promise<void>
Chrome 123 und höherPromises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.
pause()
chrome.downloads.pause(
downloadId: number,
callback?: function,
): Promise<void>
Pausiere den Download. Wenn die Anfrage erfolgreich war, befindet sich der Download im Status „Pausiert“. Andernfalls enthält runtime.lastError eine Fehlermeldung. Die Anfrage schlägt fehl, wenn der Download nicht aktiv ist.
Parameter
-
downloadId
Zahl
Die ID des Downloads, der pausiert werden soll.
-
callback
function optional
Der Parameter
callbacksieht so aus:() => void
Ausgabe
-
Promise<void>
Chrome 96 oder höherGibt ein Promise zurück, das aufgelöst wird, wenn die Pausenanfrage abgeschlossen ist.
Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.
removeFile()
chrome.downloads.removeFile(
downloadId: number,
callback?: function,
): Promise<void>
Entfernen Sie die heruntergeladene Datei, falls sie vorhanden ist und der DownloadItem abgeschlossen ist. Andernfalls geben Sie einen Fehler über runtime.lastError zurück.
Parameter
-
downloadId
Zahl
-
callback
function optional
Der Parameter
callbacksieht so aus:() => void
Ausgabe
-
Promise<void>
Chrome 96 oder höherPromises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.
resume()
chrome.downloads.resume(
downloadId: number,
callback?: function,
): Promise<void>
Pausierten Download fortsetzen Wenn die Anfrage erfolgreich war, wird der Download ausgeführt und die Pausierung aufgehoben. Andernfalls enthält runtime.lastError eine Fehlermeldung. Die Anfrage schlägt fehl, wenn der Download nicht aktiv ist.
Parameter
-
downloadId
Zahl
Die ID des Downloads, der fortgesetzt werden soll.
-
callback
function optional
Der Parameter
callbacksieht so aus:() => void
Ausgabe
-
Promise<void>
Chrome 96 oder höherGibt ein Promise zurück, das aufgelöst wird, wenn die Fortsetzungsanfrage abgeschlossen ist.
Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.
search()
chrome.downloads.search(
query: DownloadQuery,
callback?: function,
): Promise<DownloadItem[]>
Suchen Sie nach DownloadItem. Setzen Sie query auf das leere Objekt, um alle DownloadItem abzurufen. Wenn Sie eine bestimmte DownloadItem abrufen möchten, legen Sie nur das Feld id fest. Wenn Sie eine große Anzahl von Elementen durchblättern möchten, legen Sie orderBy: ['-startTime'] fest, setzen Sie limit auf die Anzahl der Elemente pro Seite und legen Sie startedAfter auf die startTime des letzten Elements der letzten Seite fest.
Parameter
-
Abfrage
-
callback
function optional
Der Parameter
callbacksieht so aus:(results: DownloadItem[]) => void
-
Ergebnisse
-
Ausgabe
-
Promise<DownloadItem[]>
Chrome 96 oder höherPromises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.
setShelfEnabled()
chrome.downloads.setShelfEnabled(
enabled: boolean,
): void
Verwenden Sie stattdessen setUiOptions.
Aktivieren oder deaktivieren Sie die graue Ablage am unteren Rand jedes Fensters, das mit dem aktuellen Browserprofil verknüpft ist. Die Ablage wird deaktiviert, solange mindestens eine Erweiterung sie deaktiviert hat. Wenn Sie die Ablage aktivieren, während mindestens eine andere Erweiterung sie deaktiviert hat, wird über runtime.lastError ein Fehler zurückgegeben. Erfordert zusätzlich zur Berechtigung "downloads" die Berechtigung "downloads.shelf".
Parameter
-
aktiviert
boolean
setUiOptions()
chrome.downloads.setUiOptions(
options: UiOptions,
callback?: function,
): Promise<void>
Ändert die Download-Benutzeroberfläche aller Fenster, die mit dem aktuellen Browserprofil verknüpft sind. Solange mindestens eine Erweiterung UiOptions.enabled auf „false“ gesetzt hat, wird die Download-Benutzeroberfläche ausgeblendet. Wenn Sie UiOptions.enabled auf „true“ setzen, während mindestens eine andere Erweiterung die Einstellung deaktiviert hat, wird über runtime.lastError ein Fehler zurückgegeben. Erfordert zusätzlich zur Berechtigung "downloads" die Berechtigung "downloads.ui".
Parameter
-
Optionen
Änderung an der Download-Benutzeroberfläche kapseln.
-
callback
function optional
Der Parameter
callbacksieht so aus:() => void
Ausgabe
-
Promise<void>
Gibt ein Promise zurück, das aufgelöst wird, wenn die Aktualisierung der Benutzeroberfläche abgeschlossen ist.
Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.
show()
chrome.downloads.show(
downloadId: number,
): void
Die heruntergeladene Datei wird in ihrem Ordner in einem Dateimanager angezeigt.
Parameter
-
downloadId
Zahl
Die Kennung für die heruntergeladene Datei.
showDefaultFolder()
chrome.downloads.showDefaultFolder(): void
Standardordner „Downloads“ in einem Dateimanager anzeigen.
Ereignisse
onChanged
chrome.downloads.onChanged.addListener(
callback: function,
)
Wenn sich eine der Eigenschaften eines DownloadItem-Objekts mit Ausnahme von bytesReceived und estimatedEndTime ändert, wird dieses Ereignis mit dem downloadId und einem Objekt ausgelöst, das die geänderten Eigenschaften enthält.
Parameter
-
callback
Funktion
Der Parameter
callbacksieht so aus:(downloadDelta: DownloadDelta) => void
-
downloadDelta
-
onCreated
chrome.downloads.onCreated.addListener(
callback: function,
)
Dieses Ereignis wird mit dem DownloadItem-Objekt ausgelöst, wenn ein Download beginnt.
Parameter
-
callback
Funktion
Der Parameter
callbacksieht so aus:(downloadItem: DownloadItem) => void
-
downloadItem
-
onDeterminingFilename
chrome.downloads.onDeterminingFilename.addListener(
callback: function,
)
Während der Dateinamensbestimmung haben Erweiterungen die Möglichkeit, das Ziel-DownloadItem.filename zu überschreiben. Für jede Erweiterung darf maximal ein Listener für dieses Ereignis registriert werden. Jeder Listener muss suggest genau einmal aufrufen, entweder synchron oder asynchron. Wenn der Listener suggest asynchron aufruft, muss er true zurückgeben. Wenn der Listener weder suggest synchron aufruft noch true zurückgibt, wird suggest automatisch aufgerufen. Der DownloadItem wird erst abgeschlossen, wenn alle Listener suggest aufgerufen haben. Listener können suggest ohne Argumente aufrufen, damit der Download downloadItem.filename als Dateinamen verwenden kann, oder ein suggestion-Objekt an suggest übergeben, um den Zieldateinamen zu überschreiben. Wenn mehr als eine Erweiterung den Dateinamen überschreibt, wird die zuletzt installierte Erweiterung verwendet, deren Listener ein suggestion-Objekt an suggest übergibt. Um Verwirrung darüber zu vermeiden, welche Erweiterung Vorrang hat, sollten Nutzer keine Erweiterungen installieren, die miteinander in Konflikt stehen könnten. Wenn der Download von download initiiert wird und der Zieldateiname bekannt ist, bevor der MIME-Typ und der vorläufige Dateiname bestimmt wurden, übergeben Sie stattdessen filename an download.
Parameter
-
callback
Funktion
Der Parameter
callbacksieht so aus:(downloadItem: DownloadItem, suggest: function) => void
-
downloadItem
-
suggest
Funktion
Der Parameter
suggestsieht so aus:(suggestion?: FilenameSuggestion) => void
-
Vorschlag
FilenameSuggestion optional
-
-
onErased
chrome.downloads.onErased.addListener(
callback: function,
)
Wird mit der downloadId ausgelöst, wenn ein Download aus dem Verlauf gelöscht wird.
Parameter
-
callback
Funktion
Der Parameter
callbacksieht so aus:(downloadId: number) => void
-
downloadId
Zahl
-