chrome.downloads

Diese Berechtigung löst eine Warnung aus

Beschreibung

Mit der chrome.downloads API können Sie Downloads programmatisch starten, überwachen, bearbeiten und suchen.

Berechtigungen

downloads

Manifest

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 beim Ansehen des Quellcodes finden Sie unter Beispiele.

Typen

BooleanDelta

Attribute

  • aktuell

    boolean optional

  • Zurück

    boolean optional

DangerType

Datei

Der Dateiname des Downloads ist verdächtig.

URL

Die URL des Downloads ist als schädlich bekannt.

Inhalt

Die heruntergeladene Datei ist bekanntermaßen schädlich.

ungewöhnlich

Die URL des Downloads wird normalerweise nicht heruntergeladen und könnte gefährlich sein.

Host

Der Download stammt von einem Host, der bekanntermaßen schädliche Binärdateien verbreitet, und ist wahrscheinlich gefährlich.

unerwünscht

Der Download ist möglicherweise unerwünscht oder unsicher. Beispielsweise können Änderungen an Browser- oder Computereinstellungen vorgenommen werden.

sorgen

Der Download stellt keine bekannte Gefahr für den Computer des Nutzers dar.

Akzeptiert

Der Nutzer hat den gefährlichen Download akzeptiert.

Enum

"file"

"url"

"content"

„ungewöhnlich“

„host“

„unerwünscht“

"safe"

„accepted“

"allowlistedByPolicy"

"asyncScanning"

"asyncLocalPasswordScanning"

"passwordProtected"

"blockedTooLarge"

"sensitiveContentWarning"

"sensitiveContentBlock"

"deepScannedFailed"

"deepScannedSafe"

"deepScannedOpenedDangerous"

„promptForScanning“

"promptForLocalPasswordScanning"

"accountCompromise"

"blockedScanFailed"

DoubleDelta

Attribute

  • aktuell

    number optional

  • Zurück

    number optional

DownloadDelta

Attribute

  • canResume

    BooleanDelta optional

    Die Änderung von canResume, falls vorhanden.

  • Gefahr

    StringDelta optional

    Die Änderung von danger, falls vorhanden.

  • endTime

    StringDelta optional

    Die Änderung von endTime, falls vorhanden.

  • Fehler

    StringDelta optional

    Die Änderung von error, falls vorhanden.

  • vorhanden

    BooleanDelta optional

    Die Änderung von exists, falls vorhanden.

  • fileSize

    DoubleDelta optional

    Die Änderung von fileSize, falls vorhanden.

  • filename

    StringDelta optional

    Die Änderung von filename, falls vorhanden.

  • finalUrl

    StringDelta optional

    Chrome 54 und höher

    Die Änderung von finalUrl, falls vorhanden.

  • id

    Zahl

    Die id der DownloadItem, die sich geändert hat.

  • Pantomime

    StringDelta optional

    Die Änderung von mime, falls vorhanden.

  • pausiert

    BooleanDelta optional

    Die Änderung von paused, falls vorhanden.

  • startTime

    StringDelta optional

    Die Änderung von startTime, falls vorhanden.

  • Bundesstaat

    StringDelta optional

    Die Änderung von state, falls vorhanden.

  • totalBytes

    DoubleDelta optional

    Die Änderung von totalBytes, falls vorhanden.

  • URL

    StringDelta optional

    Die Änderung von 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 nicht, sobald sie festgelegt ist.

  • byExtensionName

    String optional

    Der lokalisierte Name der Erweiterung, die diesen Download initiiert hat, falls der Download von einer Erweiterung initiiert wurde. Kann sich ändern, wenn die Erweiterung ihren Namen ändert oder der Nutzer seine Sprache ändert.

  • bytesReceived

    Zahl

    Anzahl der bisher vom Host empfangenen Bytes ohne Berücksichtigung der Dateikomprimierung.

  • canResume

    boolean

    „True“, wenn der Download pausiert wird, während er läuft, oder wenn er unterbrochen wird und an der Stelle fortgesetzt werden kann, an der er unterbrochen wurde.

  • Gefahr

    DangerType

    Gibt an, ob dieser Download als sicher oder als verdächtig eingestuft wird.

  • endTime

    String optional

    Die Uhrzeit, zu der 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

    Warum der Download unterbrochen wurde. Mehrere Arten von HTTP-Fehlern können unter einem der Fehler zusammengefasst werden, die mit SERVER_ beginnen. Fehler im Zusammenhang mit dem Netzwerk beginnen mit NETWORK_, Fehler im Zusammenhang mit dem Schreiben der Datei in das Dateisystem beginnen mit FILE_ und vom Nutzer initiierte Unterbrechungen beginnen mit USER_.

  • 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

    Gibt an, ob die heruntergeladene Datei noch vorhanden ist. Diese Informationen sind möglicherweise nicht mehr aktuell, da Chrome nicht automatisch nach dem Entfernen von Dateien sucht. Rufen Sie search() auf, um die Prüfung auf das Vorhandensein der Datei auszulösen. Wenn die Existenzprüfung abgeschlossen ist und die Datei gelöscht wurde, wird ein onChanged-Ereignis ausgelöst. Beachten Sie, dass search() nicht darauf wartet, dass die Existenzprüfung abgeschlossen ist, bevor es zurückgegeben wird. Die Ergebnisse von search() spiegeln das Dateisystem daher möglicherweise nicht genau wider. Außerdem kann search() so oft wie nötig aufgerufen werden, aber es wird nicht häufiger als einmal alle 10 Sekunden geprüft, ob die Datei vorhanden ist.

  • fileSize

    Zahl

    Anzahl der Byte in der gesamten Datei nach der Dekomprimierung oder -1, falls unbekannt.

  • filename

    String

    Absoluter lokaler Pfad.

  • finalUrl

    String

    Chrome 54 und höher

    Die absolute URL, von der dieser Download nach allen Weiterleitungen erfolgt.

  • id

    Zahl

    Eine Kennung, die über Browsersitzungen hinweg bestehen bleibt.

  • Inkognito

    boolean

    „False“, wenn dieser Download im Verlauf aufgezeichnet wird, „True“, wenn er nicht aufgezeichnet wird.

  • Pantomime

    String

    Der MIME-Typ der Datei.

  • pausiert

    boolean

    „True“, wenn der Download keine Daten mehr vom Host liest, die Verbindung aber offen gehalten wird.

  • referrer

    String

    Absolute URL

  • startTime

    String

    Die Uhrzeit, zu der der Download im ISO 8601-Format begonnen hat. Kann direkt an den Date-Konstruktor übergeben werden: chrome.downloads.search({}, function(items){items.forEach(function(item){console.log(new Date(item.startTime))})})

  • Bundesstaat

    Bundesland

    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, falls unbekannt.

  • URL

    String

    Die absolute URL, von der dieser Download initiiert wurde, vor Weiterleitungen.

DownloadOptions

Attribute

  • body

    String optional

    Post-Text

  • conflictAction

    FilenameConflictAction optional

    Die auszuführende Aktion, wenn filename bereits vorhanden ist.

  • filename

    String optional

    Ein Dateipfad relativ zum Downloadverzeichnis, in dem die heruntergeladene Datei gespeichert werden soll. Er kann Unterverzeichnisse enthalten. Absolute Pfade, leere Pfade und Pfade, die Rückverweise „..“ enthalten, führen zu einem Fehler. Mit onDeterminingFilename kann 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 für die URL das HTTP[s]-Protokoll verwendet wird. Jeder Header wird als Dictionary mit den Schlüsseln name und entweder value oder binaryValue dargestellt, wobei nur die von XMLHttpRequest zulässigen Header verwendet werden.

  • method

    HttpMethod optional

    Die HTTP-Methode, die verwendet werden soll, wenn die URL das HTTP[S]-Protokoll verwendet.

  • saveAs

    boolean optional

    Verwenden Sie eine Dateiauswahl, damit der Nutzer einen Dateinamen auswählen kann, unabhängig davon, ob filename festgelegt ist oder bereits vorhanden ist.

  • URL

    String

    Die URL zum Herunterladen.

DownloadQuery

Attribute

  • bytesReceived

    number optional

    Anzahl der bisher vom Host empfangenen Bytes ohne Berücksichtigung der Dateikomprimierung.

  • Gefahr

    DangerType optional

    Gibt an, ob dieser Download als sicher oder als verdächtig eingestuft wird.

  • endTime

    String optional

    Die Uhrzeit, zu der der Download beendet wurde, im ISO 8601-Format.

  • endedAfter

    String optional

    Beschränkt die Ergebnisse auf DownloadItem, die nach dem angegebenen Millisekundenwert im ISO 8601-Format endeten.

  • endedBefore

    String optional

    Beschränkt die Ergebnisse auf DownloadItem, die vor dem angegebenen Millisekundenwert im ISO 8601-Format endeten.

  • Fehler

    InterruptReason optional

    Gründe für die Unterbrechung eines Downloads

  • vorhanden

    boolean optional

    ob die heruntergeladene Datei vorhanden ist;

  • fileSize

    number optional

    Anzahl der Byte in der gesamten Datei nach der Dekomprimierung oder -1, falls unbekannt.

  • filename

    String optional

    Absoluter lokaler Pfad.

  • filenameRegex

    String optional

    Beschränkt die Ergebnisse auf DownloadItem, deren filename dem angegebenen regulären Ausdruck entspricht.

  • finalUrl

    String optional

    Chrome 54 und höher

    Die absolute URL, von der dieser Download nach allen Weiterleitungen erfolgt.

  • finalUrlRegex

    String optional

    Chrome 54 und höher

    Beschränkt die Ergebnisse auf DownloadItem, deren finalUrl dem angegebenen regulären Ausdruck entspricht.

  • id

    number optional

    Die id der DownloadItem, die abgefragt werden soll.

  • Limit

    number optional

    Die maximale Anzahl der zurückgegebenen übereinstimmenden DownloadItem. Der Standardwert ist 1.000. Legen Sie den Wert auf 0 fest, um alle übereinstimmenden DownloadItem zurückzugeben. Informationen zum Durchblättern der Ergebnisse finden Sie unter search.

  • 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 beispielsweise orderBy=['startTime'] festlegen, werden die DownloadItem nach ihrer Startzeit in aufsteigender Reihenfolge sortiert. Wenn Sie eine absteigende Reihenfolge angeben möchten, stellen Sie ein Minuszeichen voran: „-startTime“.

  • pausiert

    boolean optional

    „True“, wenn der Download keine Daten mehr vom Host liest, die Verbindung aber offen gehalten wird.

  • Abfrage

    string[] optional

    Dieses Array von Suchbegriffen beschränkt die Ergebnisse auf DownloadItem, deren filename, url oder finalUrl alle Suchbegriffe enthalten, die nicht mit einem Bindestrich beginnen, und keine der Suchbegriffe, die mit einem Bindestrich beginnen.

  • startTime

    String optional

    Die Uhrzeit, zu der der Download im ISO 8601-Format begonnen hat.

  • startedAfter

    String optional

    Beschränkt die Ergebnisse auf DownloadItem, die nach dem angegebenen Millisekundenwert im ISO 8601-Format begonnen haben.

  • startedBefore

    String optional

    Beschränkt die Ergebnisse auf DownloadItem, die vor dem angegebenen Millisekundenwert im ISO 8601-Format begonnen haben.

  • Bundesstaat

    Bundesland 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, falls unbekannt.

  • totalBytesGreater

    number optional

    Beschränkt die Ergebnisse auf DownloadItem, deren totalBytes größer als die angegebene Ganzzahl ist.

  • totalBytesLess

    number optional

    Beschränkt die Ergebnisse auf DownloadItem, deren totalBytes kleiner als die angegebene Ganzzahl ist.

  • URL

    String optional

    Die absolute URL, von der dieser Download initiiert wurde, vor Weiterleitungen.

  • urlRegex

    String optional

    Beschränkt die Ergebnisse auf DownloadItem, deren url dem angegebenen regulären Ausdruck entspricht.

FilenameConflictAction

uniquify

Um Duplikate zu vermeiden, wird 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

Dem Nutzer wird ein Dialogfeld zur Dateiauswahl angezeigt.

Enum

„uniquify“

"overwrite"

"prompt"

FilenameSuggestion

Attribute

  • conflictAction

    FilenameConflictAction optional

    Die auszuführende Aktion, wenn filename bereits vorhanden ist.

  • filename

    String

    Das neue Ziel DownloadItem.filename des DownloadItem als Pfad relativ zum Standard-Downloadverzeichnis des Nutzers, das möglicherweise Unterverzeichnisse enthält. Absolute Pfade, leere Pfade und Pfade mit Rückverweisen „..“ werden ignoriert. filename wird ignoriert, wenn von Erweiterungen onDeterminingFilename-Listener registriert wurden.

GetFileIconOptions

Attribute

  • Größe

    number optional

    Die Größe des zurückgegebenen Symbols. Das Symbol ist quadratisch und hat die Abmessungen „Größe × Größe“ Pixel. Die Standard- und größte Größe für das Symbol ist 32 × 32 Pixel. Die einzigen unterstützten Größen sind 16 und 32. Die Angabe einer anderen Größe führt zu einem Fehler.

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

Ein Fehler hat die Verbindung zum Dateihost unterbrochen.

abgeschlossen

Der Download wurde abgeschlossen.

Enum

"in_progress"

„interrupted“

„complete“

StringDelta

Attribute

  • aktuell

    String optional

  • Zurück

    String optional

UiOptions

Chrome 105 und höher

Attribute

  • aktiviert

    boolean

    Aktivieren oder deaktivieren Sie die Download-Benutzeroberfläche.

Methoden

acceptDanger()

Promise 
chrome.downloads.acceptDanger(
  downloadId: number,
  callback?: function,
): Promise<void>

Nutzer auffordern, einen gefährlichen Download zu akzeptieren Kann nur aus einem sichtbaren Kontext aufgerufen werden (Tab, Fenster oder Pop-up für Seiten-/Browseraktionen). 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, state ändert sich in „complete“ und onChanged wird ausgelöst.

Parameter

  • downloadId

    Zahl

    Die Kennung für die DownloadItem.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    Chrome 96 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

cancel()

Promise 
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

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    Chrome 96 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

download()

Promise 
chrome.downloads.download(
  options: DownloadOptions,
  callback?: function,
): Promise<number>

URL herunterladen Wenn für die URL das HTTP[S]-Protokoll verwendet wird, 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“ mit dem angegebenen filename angezeigt. Wenn der Download erfolgreich gestartet wurde, wird callback mit der downloadId der 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 Versionen abwärtskompatibel bleiben. Erweiterungen dürfen sie nicht parsen.

Parameter

  • Optionen

    DownloadOptions

    Was und wie Sie herunterladen können.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (downloadId: number) => void

    • downloadId

      Zahl

Ausgabe

  • Promise<number>

    Chrome 96 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

erase()

Promise 
chrome.downloads.erase(
  query: DownloadQuery,
  callback?: function,
): Promise<number[]>

Löschen Sie übereinstimmende DownloadItem aus dem Verlauf, ohne die heruntergeladene Datei zu löschen. Für jedes DownloadItem, das mit query übereinstimmt, wird ein onErased-Ereignis ausgelöst. Anschließend wird callback aufgerufen.

Parameter

  • Abfrage

    DownloadQuery

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (erasedIds: number[]) => void

    • erasedIds

      number[]

Ausgabe

  • Promise<number[]>

    Chrome 96 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

getFileIcon()

Promise 
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 das Ereignis onCreated empfangen wurde. 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 durch Abfragen des zugrunde liegenden Betriebssystems oder Toolkits, je nach Plattform. Das zurückgegebene Symbol hängt daher von einer Reihe von Faktoren ab, z. B. vom Downloadstatus, 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 Kennung für den Download.

  • Optionen

    GetFileIconOptions optional

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (iconURL?: string) => void

    • iconURL

      String optional

Ausgabe

  • Promise<string | undefined>

    Chrome 96 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

open()

Promise 
chrome.downloads.open(
  downloadId: number,
  callback?: function,
): Promise<void>

Öffnet die heruntergeladene Datei, wenn DownloadItem abgeschlossen ist. Andernfalls wird über runtime.lastError ein Fehler 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 Nutzeraktion aufgerufen werden.

Parameter

  • downloadId

    Zahl

    Die Kennung der heruntergeladenen Datei.

  • callback

    Funktion optional

    Chrome 123 und höher

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    Chrome 123 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

pause()

Promise 
chrome.downloads.pause(
  downloadId: number,
  callback?: function,
): Promise<void>

Pausieren Sie den Download. Wenn die Anfrage erfolgreich war, wird der Download 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

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    Chrome 96 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

removeFile()

Promise 
chrome.downloads.removeFile(
  downloadId: number,
  callback?: function,
): Promise<void>

Entfernen Sie die heruntergeladene Datei, falls sie vorhanden ist und die DownloadItem abgeschlossen ist. Andernfalls geben Sie über runtime.lastError einen Fehler zurück.

Parameter

  • downloadId

    Zahl

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    Chrome 96 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

resume()

Promise 
chrome.downloads.resume(
  downloadId: number,
  callback?: function,
): Promise<void>

Pausierten Download fortsetzen Wenn die Anfrage erfolgreich war, wird der Download fortgesetzt. 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

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    Chrome 96 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

Promise 
chrome.downloads.search(
  query: DownloadQuery,
  callback?: function,
): Promise<DownloadItem[]>

Suche 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, legen Sie limit auf die Anzahl der Elemente pro Seite fest und legen Sie startedAfter auf die startTime des letzten Elements der letzten Seite fest.

Parameter

Ausgabe

  • Promise<DownloadItem[]>

    Chrome 96 und höher

    Promises werden nur für Manifest V3 und höher unterstützt. Auf anderen Plattformen müssen Callbacks verwendet werden.

setShelfEnabled()

Seit Chrome 117 eingestellt
chrome.downloads.setShelfEnabled(
  enabled: boolean,
): void

Verwenden Sie stattdessen setUiOptions.

Aktivieren oder deaktivieren Sie das graue Ablagefach unten in jedem Fenster, das mit dem aktuellen Browserprofil verknüpft ist. Das Shelf wird deaktiviert, solange es von mindestens einer Erweiterung deaktiviert wurde. Wenn Sie das Regal aktivieren, während es von mindestens einer anderen Erweiterung deaktiviert wurde, wird über runtime.lastError ein Fehler zurückgegeben. Erfordert zusätzlich zur Berechtigung "downloads" die Berechtigung "downloads.shelf".

Parameter

  • aktiviert

    boolean

setUiOptions()

Promise Chrome 105+ 
chrome.downloads.setUiOptions(
  options: UiOptions,
  callback?: function,
): Promise<void>

Die Download-Benutzeroberfläche aller Fenster, die mit dem aktuellen Browserprofil verknüpft sind, wird geändert. Solange für mindestens eine Erweiterung UiOptions.enabled auf „false“ gesetzt ist, wird die Download-Benutzeroberfläche ausgeblendet. Wenn Sie UiOptions.enabled auf „true“ setzen, 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.ui".

Parameter

  • Optionen

    UiOptions

    Kapselt eine Änderung an der Download-Benutzeroberfläche.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Ausgabe

  • Promise<void>

    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 in ihrem Ordner in einem Dateimanager anzeigen

Parameter

  • downloadId

    Zahl

    Die Kennung der heruntergeladenen Datei.

showDefaultFolder()

chrome.downloads.showDefaultFolder(): void

Den Standardordner „Downloads“ in einem Dateimanager anzeigen

Ereignisse

onChanged

chrome.downloads.onChanged.addListener(
  callback: function,
)

Wenn sich eine der Eigenschaften von DownloadItem 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

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 callback sieht so aus: 

    (downloadItem: DownloadItem) => void

onDeterminingFilename

chrome.downloads.onDeterminingFilename.addListener(
  callback: function,
)

Während der Ermittlung des Dateinamens können Erweiterungen das Ziel DownloadItem.filename überschreiben. Für dieses Ereignis darf jede Erweiterung nur einen Listener registrieren. 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 für den Download downloadItem.filename als Dateiname verwendet wird. Alternativ können sie ein suggestion-Objekt an suggest übergeben, um den Zieldateinamen zu überschreiben. Wenn mehr als eine Erweiterung den Dateinamen überschreibt, gewinnt die zuletzt installierte Erweiterung, deren Listener ein suggestion-Objekt an suggest übergibt. Um Verwirrung darüber zu vermeiden, welche Erweiterung Vorrang hat, sollten Nutzer keine Erweiterungen installieren, die 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 ermittelt wurden, übergeben Sie stattdessen filename an download.

Parameter

onErased

chrome.downloads.onErased.addListener(
  callback: function,
)

Wird mit dem downloadId ausgelöst, wenn ein Download aus dem Verlauf gelöscht wird.

Parameter

  • callback

    Funktion

    Der Parameter callback sieht so aus: 

    (downloadId: number) => void

    • downloadId

      Zahl