chrome.downloads

Beschreibung

Mit der chrome.downloads API kannst du Downloads programmatisch starten, überwachen, manipulieren und suchen.

Berechtigungen

downloads

Sie müssen die Berechtigung "downloads" im Erweiterungsmanifest deklarieren, um diese API verwenden zu können.

{
  "name": "My extension",
  ...
  "permissions": [
    "downloads"
  ],
}

Beispiele

Einfache Beispiele für die Verwendung der chrome.downloads API findest du unter examples/api/downloads. -Verzeichnis. Weitere Beispiele und Hilfe zum Aufrufen des Quellcodes finden Sie unter Beispiele.

Typen

BooleanDelta

Attribute

  • aktuell

    Boolescher Wert optional

  • Zurück

    Boolescher Wert optional

DangerType

Datei

Der Dateiname des Downloads ist verdächtig.

URL

Die Download-URL ist bekanntermaßen schädlich.

Inhalt

Die heruntergeladene Datei ist bekanntermaßen schädlich.

ungewöhnlich

Die Download-URL ist ein ungewöhnlicher Download und könnte gefährlich sein.

Host

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

Unerwünscht

Der Download ist potenziell unerwünscht oder nicht sicher. Beispiel: kann es Änderungen an Browser- oder Computereinstellungen vornehmen.

sicher

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

Akzeptiert

Der Nutzer hat den gefährlichen Download akzeptiert.

Enum

"asyncScanning"

"asyncLocalPasswordScanning"

DoubleDelta

Attribute

  • aktuell

    Zahl optional

  • Zurück

    Zahl optional

DownloadDelta

Attribute

  • canResume

    BooleanDelta optional

    Die Änderung in canResume, falls vorhanden.

  • Gefahr

    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 (ab Version 54)

    Die Änderung in finalUrl, falls vorhanden.

  • id

    Zahl

    Die id von DownloadItem, die sich geändert haben.

  • 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 gestartet hat, wenn dieser Download von einer Erweiterung initiiert wurde. Sie ändert sich nicht, nachdem sie festgelegt wurde.

  • byExtensionName

    String optional

    Der lokalisierte Name der Erweiterung, die diesen Download gestartet hat, wenn dieser Download durch eine Erweiterung gestartet wurde. Kann sich ändern, wenn der Name der Erweiterung oder der Nutzer die Sprache ändert.

  • bytesReceived

    Zahl

    Anzahl der Byte, die bisher vom Host ohne Berücksichtigung der Dateikomprimierung empfangen wurden.

  • canResume

    boolean

    Dieser Wert ist "True", wenn der Download läuft und pausiert wird oder wenn er unterbrochen wird und an der Stelle fortgesetzt werden kann, an der er unterbrochen wurde.

  • Gefahr

    DangerType

    Hinweise darauf, ob dieser Download als sicher oder verdächtig eingestuft wird.

  • endTime

    String optional

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

  • Fehler

    InterruptReason optional

    Warum wurde der Download unterbrochen? Verschiedene Arten von HTTP-Fehlern können unter einem Fehler gruppiert werden, der mit SERVER_ beginnt. 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 mit USER_.

  • estimatedEndTime

    String optional

    Geschätzte Zeit bis zum Abschluss des Downloads im ISO-8601-Format. Kann direkt an den Datumskonstruktor ü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 veraltet, da Chrome nicht automatisch prüft, ob Dateien entfernt werden. Rufen Sie search() auf, um die Prüfung auf das Vorhandensein von Dateien auszulösen. Wenn die Existenzprüfung abgeschlossen ist und die Datei gelöscht wurde, wird ein onChanged-Ereignis ausgelöst. search() wartet mit der Rückgabe nicht darauf, dass die Existenzprüfung abgeschlossen ist. Daher spiegeln die Ergebnisse von search() möglicherweise das Dateisystem nicht genau wider. Außerdem kann search() so oft wie nötig aufgerufen werden, überprüft jedoch das Vorhandensein von Dateien nicht häufiger als einmal alle 10 Sekunden.

  • fileSize

    Zahl

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

  • filename

    String

    Absoluter lokaler Pfad.

  • finalUrl

    String

    Chrome (ab Version 54)

    Die absolute URL, über die dieser Download erfolgt, nach allen Weiterleitungen.

  • id

    Zahl

    Eine ID, die über alle Browsersitzungen hinweg dauerhaft ist.

  • 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 vom Host mehr liest, aber die Verbindung offen gelassen wurde.

  • referrer

    String

    Absolute URL.

  • startTime

    String

    Die Uhrzeit, zu der der Download begann, im ISO-8601-Format. Kann direkt an den Datumskonstruktor ü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 wird.

  • totalBytes

    Zahl

    Anzahl der Byte in der gesamten Datei ohne Berücksichtigung der Dateikomprimierung oder -1, falls unbekannt.

  • URL

    String

    Die absolute URL, über die der Download gestartet wurde, vor etwaigen Weiterleitungen.

DownloadOptions

Attribute

  • body

    String optional

    Text des Beitrags.

  • conflictAction

    FilenameConflictAction optional

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

  • filename

    String optional

    Ein Dateipfad relativ zum Download-Verzeichnis, in dem die heruntergeladene Datei gespeichert ist. Dabei kann es sich um Unterverzeichnisse handeln. Absolute Pfade, leere Pfade und Pfade, die Rückverweise ".." enthalten führt zu einem Fehler. Mit onDeterminingFilename kann ein Dateiname vorgeschlagen werden, nachdem der MIME-Typ der Datei und ein vorläufiger Dateiname bestimmt wurden.

  • headers

    HeaderNameValuePair[] optional

    Zusätzliche HTTP-Header, die mit der Anfrage gesendet werden, wenn die URL das HTTP[s]-Protokoll verwendet. Jeder Header wird als Wörterbuch dargestellt, das die Schlüssel name und entweder value oder binaryValue enthält, wobei die Schlüssel auf die von XMLHttpRequest zulässigen Schlüssel beschränkt sind.

  • method

    HttpMethod optional

    Die zu verwendende HTTP-Methode, wenn die URL das HTTP[S]-Protokoll verwendet.

  • saveAs

    Boolescher Wert optional

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

  • URL

    String

    Herunterzuladende URL

DownloadQuery

Attribute

  • bytesReceived

    Zahl optional

    Anzahl der Byte, die bisher vom Host ohne Berücksichtigung der Dateikomprimierung empfangen wurden.

  • Gefahr

    DangerType optional

    Hinweise darauf, ob dieser Download als sicher oder verdächtig eingestuft wird.

  • endTime

    String optional

    Die Zeit, zu der der Download endete, im ISO-8601-Format.

  • endedAfter

    String optional

    Beschränkt die Ergebnisse auf DownloadItem, die nach den angegebenen ms im ISO 8601-Format endeten

  • endedBefore

    String optional

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

  • Fehler

    InterruptReason optional

    Gründe für die Unterbrechung eines Downloads

  • vorhanden

    Boolescher Wert optional

    Gibt an, ob die heruntergeladene Datei vorhanden ist.

  • fileSize

    Zahl 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 mit dem angegebenen regulären Ausdruck übereinstimmt.

  • finalUrl

    String optional

    Chrome (ab Version 54)

    Die absolute URL, über die dieser Download erfolgt, nach allen Weiterleitungen.

  • finalUrlRegex

    String optional

    Chrome (ab Version 54)

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

  • id

    Zahl optional

    Die id des abzufragenden DownloadItem.

  • Limit

    Zahl optional

    Die maximale Anzahl zurückgegebener übereinstimmender DownloadItem. Die Standardeinstellung ist 1.000. Geben Sie 0 an, damit alle übereinstimmenden DownloadItem zurückgegeben werden. Informationen zum Blättern in den Ergebnissen finden Sie unter search.

  • Pantomime

    String optional

    Der MIME-Typ der Datei.

  • orderBy

    string[] optional

    Setze die Elemente dieses Arrays auf DownloadItem-Properties, um die Suchergebnisse zu sortieren. Wenn Sie beispielsweise orderBy=['startTime'] festlegen, werden DownloadItem nach ihrer Startzeit in aufsteigender Reihenfolge sortiert. Wenn Sie eine absteigende Reihenfolge angeben möchten, stellen Sie einen Bindestrich voran: „-startTime“.

  • pausiert

    Boolescher Wert optional

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

  • Abfrage

    string[] optional

    Dieses Array von Suchbegriffen begrenzt die Ergebnisse auf DownloadItem, deren filename oder url oder finalUrl alle Suchbegriffe enthalten, die nicht mit einem Bindestrich „-“ beginnen und keiner der Suchbegriffe, die mit einem Bindestrich beginnen.

  • startTime

    String optional

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

  • startedAfter

    String optional

    Beschränkt die Ergebnisse auf DownloadItem, die nach den angegebenen ms im ISO 8601-Format gestartet wurden.

  • startedBefore

    String optional

    Beschränkt die Ergebnisse auf DownloadItem, die vor den angegebenen ms im ISO 8601-Format gestartet wurden.

  • Bundesstaat

    Bundesland optional

    Gibt an, ob der Download läuft, unterbrochen oder abgeschlossen wird.

  • totalBytes

    Zahl optional

    Anzahl der Byte in der gesamten Datei ohne Berücksichtigung der Dateikomprimierung oder -1, falls unbekannt.

  • totalBytesGreater

    Zahl optional

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

  • totalBytesLess

    Zahl optional

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

  • URL

    String optional

    Die absolute URL, über die der Download gestartet wurde, vor etwaigen Weiterleitungen.

  • urlRegex

    String optional

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

FilenameConflictAction

vereinheitlichen

Um eine Duplizierung zu vermeiden, wird filename so geändert, dass vor der Dateiendung ein Zähler steht.

überschreiben

Die vorhandene Datei wird dann mit der neuen Datei überschrieben.

prompt

Dem Nutzer wird ein Dialogfeld zur Dateiauswahl angezeigt.

Enum

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, der Unterverzeichnisse enthalten kann. Absolute Pfade, leere Pfade und Pfade, die Rückverweise „..“ enthalten werden ignoriert. filename wird ignoriert, wenn onDeterminingFilename-Listener von Erweiterungen registriert sind.

GetFileIconOptions

Attribute

  • Größe

    Zahl optional

    Die Größe des zurückgegebenen Symbols. Das Symbol ist quadratisch und hat die Abmessungen „Größe × Größe Pixel“. Die Standardgröße und die größte Größe für das Symbol beträgt 32 x 32 Pixel. Die einzigen unterstützten Größen sind 16 und 32. Die Angabe einer anderen Größe ist ein Fehler.

HeaderNameValuePair

Attribute

  • Name

    String

    Name des HTTP-Headers.

  • Wert

    String

    Wert des HTTP-Headers.

HttpMethod

Enum

InterruptReason

Enum

State

in_progress

Beim Download werden derzeit Daten vom Server empfangen.

unterbrochen

Die Verbindung zum Dateihost wurde aufgrund eines Fehlers unterbrochen.

abgeschlossen

Der Download wurde erfolgreich abgeschlossen.

Enum

StringDelta

Attribute

  • aktuell

    String optional

  • Zurück

    String optional

UiOptions

Chrome 105 oder höher

Attribute

  • aktiviert

    boolean

    Download-UI aktivieren oder deaktivieren

Methoden

acceptDanger()

Versprechen 
chrome.downloads.acceptDanger(
  downloadId: number,
  callback?: function,
)

Nutzer auffordern, einen gefährlichen Download zu akzeptieren Kann nur aus einem sichtbaren Kontext aufgerufen werden (Tab, Fenster oder Pop-up mit Seiten-/Browseraktion). 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 einer temporären Datei abgerufen wurden und entweder der Download nicht gefährlich ist oder die Gefahr akzeptiert wurde, wird die temporäre Datei in den Zieldateinamen umbenannt, state ändert sich in „abgeschlossen“ und onChanged wird ausgelöst.

Parameter

  • downloadId

    Zahl

    Die Kennung für den DownloadItem.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Gibt Folgendes zurück:

  • Promise<void>

    Chrome 96 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

cancel()

Versprechen 
chrome.downloads.cancel(
  downloadId: number,
  callback?: function,
)

Download abbrechen Bei der Ausführung von callback 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

Gibt Folgendes zurück:

  • Promise<void>

    Chrome 96 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

download()

Versprechen 
chrome.downloads.download(
  options: DownloadOptions,
  callback?: function,
)

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, in dem die angegebenen filename bereits eingetragen sind. Wenn der Download erfolgreich gestartet wurde, wird callback mit 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 Releases abwärtskompatibel bleiben. Erweiterungen dürfen ihn nicht parsen.

Parameter

  • Optionen

    DownloadOptions

    Was kann heruntergeladen werden und wie?

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (downloadId: number) => void

    • downloadId

      Zahl

Gibt Folgendes zurück:

  • Promise<number>

    Chrome 96 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

erase()

Versprechen 
chrome.downloads.erase(
  query: DownloadQuery,
  callback?: function,
)

Übereinstimmende DownloadItem aus dem Verlauf löschen, ohne die heruntergeladene Datei zu löschen. Ein onErased-Ereignis wird für jede DownloadItem ausgelöst, die query entspricht. Anschließend wird callback aufgerufen.

Parameter

  • Abfrage

    DownloadQuery

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (erasedIds: number[]) => void

    • erasedIds

      Zahl[]

Gibt Folgendes zurück:

  • Promise<number[]>

    Chrome 96 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

getFileIcon()

Versprechen 
chrome.downloads.getFileIcon(
  downloadId: number,
  options?: GetFileIconOptions,
  callback?: function,
)

Ruft ein Symbol für den angegebenen Download ab. Für neue Downloads sind Dateisymbole verfügbar, nachdem das Ereignis onCreated empfangen wurde. Das von dieser Funktion zurückgegebene Bild während eines laufenden Downloads kann sich von dem Bild unterscheiden, das nach Abschluss des Downloads zurückgegeben wird. Zum Abrufen von Symbolen wird je nach Plattform das zugrunde liegende Betriebssystem oder Toolkit abgefragt. Das zurückgegebene Symbol hängt daher von einer Reihe von Faktoren ab, darunter der Status des Downloads, die Plattform, die registrierten Dateitypen und das visuelle Design. Wenn ein Dateisymbol nicht ermittelt werden kann, enthält runtime.lastError eine Fehlermeldung.

Parameter

  • downloadId

    Zahl

    Die ID für den Download.

  • Optionen

    GetFileIconOptions optional

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (iconURL?: string) => void

    • iconURL

      String optional

Gibt Folgendes zurück:

  • Promise<string | nicht definiert>

    Chrome 96 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

open()

Versprechen 
chrome.downloads.open(
  downloadId: number,
  callback?: function,
)

Öffnet die heruntergeladene Datei jetzt, 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. Das Ereignis onChanged 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 ID für die heruntergeladene Datei.

  • callback

    Funktion optional

    Chrome 123 und höher

    Der Parameter callback sieht so aus: 

    () => void

Gibt Folgendes zurück:

  • Promise<void>

    Chrome 123 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

pause()

Versprechen 
chrome.downloads.pause(
  downloadId: number,
  callback?: function,
)

Halten Sie den Download an. Wenn die Anfrage erfolgreich war, hat der Download den 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 anzuhaltenden Downloads.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Gibt Folgendes zurück:

  • Promise<void>

    Chrome 96 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

removeFile()

Versprechen 
chrome.downloads.removeFile(
  downloadId: number,
  callback?: function,
)

Entfernen Sie die heruntergeladene Datei, falls sie vorhanden ist und der DownloadItem vollständig ist. Andernfalls wird über runtime.lastError ein Fehler zurückgegeben.

Parameter

  • downloadId

    Zahl

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Gibt Folgendes zurück:

  • Promise<void>

    Chrome 96 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

resume()

Versprechen 
chrome.downloads.resume(
  downloadId: number,
  callback?: function,
)

Setze einen pausierten Download fort. Wenn die Anfrage erfolgreich war, wird der Download ausgeführt und die Pausierung wird 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 fortgesetzten Downloads.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Gibt Folgendes zurück:

  • Promise<void>

    Chrome 96 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

Versprechen 
chrome.downloads.search(
  query: DownloadQuery,
  callback?: function,
)

Suchen Sie nach DownloadItem. Legen Sie query auf das leere Objekt fest, um alle DownloadItem abzurufen. Wenn Sie ein bestimmtes DownloadItem abrufen möchten, legen Sie nur das Feld id fest. Wenn Sie durch eine große Anzahl von Elementen blättern möchten, legen Sie orderBy: ['-startTime'], limit auf die Anzahl der Elemente pro Seite und startedAfter auf die startTime des letzten Elements der letzten Seite fest.

Parameter

Gibt Folgendes zurück:

  • Promise<DownloadItem[]>

    Chrome 96 und höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

setShelfEnabled()

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

Verwenden Sie stattdessen setUiOptions.

Aktivieren oder deaktivieren Sie die graue Ablage unten in jedem Fenster, das mit dem aktuellen Browserprofil verknüpft ist. Die Ablage bleibt deaktiviert, solange sie von mindestens einer Erweiterung deaktiviert wurde. Wenn die Ablage aktiviert wird, während mindestens eine andere Erweiterung deaktiviert ist, wird eine Fehlermeldung über runtime.lastError zurückgegeben. Erfordert die Berechtigung "downloads.shelf" zusätzlich zur Berechtigung "downloads".

Parameter

  • aktiviert

    boolean

setUiOptions()

Versprechen Chrome 105 oder höher 
chrome.downloads.setUiOptions(
  options: UiOptions,
  callback?: function,
)

Ändern der Download-Benutzeroberfläche für jedes Fenster, das dem aktuellen Browserprofil zugeordnet ist Solange UiOptions.enabled bei mindestens einer Erweiterung auf „false“ gesetzt ist, wird die Benutzeroberfläche für den Download ausgeblendet. Wird UiOptions.enabled auf „true“ gesetzt, während mindestens eine andere Erweiterung deaktiviert ist, wird ein Fehler bis runtime.lastError zurückgegeben. Erfordert die Berechtigung "downloads.ui" zusätzlich zur Berechtigung "downloads".

Parameter

  • Optionen

    UiOptions

    Fassen Sie eine Änderung an der Download-UI zusammen.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    () => void

Gibt Folgendes zurück:

  • Promise<void>

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks sind jedoch für Abwärtskompatibilität. Sie können nicht beide in demselben Funktionsaufruf verwenden. Die Promise wird mit demselben Typ aufgelöst, der an das Callback übergeben wird.

show()

chrome.downloads.show(
  downloadId: number,
)

Die heruntergeladene Datei wird im zugehörigen Ordner in einem Dateimanager angezeigt.

Parameter

  • downloadId

    Zahl

    Die ID für die heruntergeladene Datei.

showDefaultFolder()

chrome.downloads.showDefaultFolder()

Standardordner „Downloads“ in einem Dateimanager anzeigen

Ereignisse

onChanged

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

Wenn sich eine der Eigenschaften eines 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,
)

Bei der Ermittlung des Dateinamens haben Erweiterungen die Möglichkeit, das Ziel-DownloadItem.filename zu überschreiben. Jede Erweiterung darf nicht mehr als einen Listener für dieses Ereignis registrieren. Jeder Listener muss suggest genau einmal aufrufen, entweder synchron oder asynchron. Wenn der Listener suggest asynchron aufruft, muss true zurückgegeben werden. Wenn der Listener suggest weder synchron aufruft noch true zurückgibt, wird suggest automatisch aufgerufen. 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 mehrere Erweiterungen den Dateinamen überschreiben, gewinnt die zuletzt installierte Erweiterung, deren Listener ein suggestion-Objekt an suggest übergibt. Um Unklarheiten darüber zu vermeiden, welche Erweiterung am besten ankommt, sollten Nutzer keine Erweiterungen installieren, die Konflikte verursachen können. 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 filename stattdessen an download.

Parameter

onErased

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

Wird mit 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