chrome.downloads

Beschreibung

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

Berechtigungen

downloads

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

{
  "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 Anzeigen 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.

Inhalte herausgestellt werden

Die heruntergeladene Datei ist bekanntermaßen schädlich.

ungewöhnlich

Die Download-URL wird normalerweise nicht heruntergeladen und könnte schädlich sein.

Gastgeber

Der Download stammt von einem Host, der schädliche Binärprogramme verbreitet. Er ist wahrscheinlich gefährlich.

unerwünschte

Der Download ist möglicherweise nicht erwünscht oder nicht sicher. z.B. Änderungen an den Browser- oder Computereinstellungen.

sicher

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

Akzeptiert

Der Nutzer hat den gefährlichen Download akzeptiert.

Enum

"url"

"asyncScanning"

"asyncLocalPasswordScanning"

"passwordProtected"

"blockedTooLarge"

"sensitiveContentBlock"

"promptForScanning"

"promptForLocalPasswordScanning"

"blockedScanFailed"

DoubleDelta

Attribute

  • aktuell

    Nummer optional

  • Zurück

    Nummer optional

DownloadDelta

Attribute

  • canResume

    BooleanDelta optional

    Gegebenenfalls die Änderung an canResume.

  • Gefahr

    StringDelta optional

    Gegebenenfalls die Änderung an danger.

  • endTime

    StringDelta optional

    Gegebenenfalls die Änderung an endTime.

  • error

    StringDelta optional

    Gegebenenfalls die Änderung an error.

  • vorhanden

    BooleanDelta optional

    Gegebenenfalls die Änderung an exists.

  • fileSize

    DoubleDelta optional

    Gegebenenfalls die Änderung an fileSize.

  • filename

    StringDelta optional

    Gegebenenfalls die Änderung an filename.

  • finalUrl

    StringDelta optional

    Chrome 54 und höher

    Gegebenenfalls die Änderung an finalUrl.

  • id

    Zahl

    Der id des geänderten DownloadItem.

  • Pantomime

    StringDelta optional

    Gegebenenfalls die Änderung an mime.

  • pausiert

    BooleanDelta optional

    Gegebenenfalls die Änderung an paused.

  • startTime

    StringDelta optional

    Gegebenenfalls die Änderung an startTime.

  • state

    StringDelta optional

    Gegebenenfalls die Änderung an state.

  • totalBytes

    DoubleDelta optional

    Gegebenenfalls die Änderung an totalBytes.

  • url

    StringDelta optional

    Gegebenenfalls die Änderung an url.

DownloadItem

Attribute

  • byExtensionId

    String optional

    Die ID für die Erweiterung, die den Download gestartet hat, falls er von einer Erweiterung initiiert wurde. Sie ändert sich nach dem Festlegen nicht mehr.

  • byExtensionName

    String optional

    Der lokalisierte Name der Erweiterung, die diesen Download initiiert hat, wenn er von einer Erweiterung initiiert wurde. Kann geändert werden, wenn die Erweiterung ihren Namen ändert oder wenn der Nutzer die Sprache ändert.

  • bytesReceived

    Zahl

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

  • canResume

    boolean

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

  • Gefahr

    DangerType

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

  • endTime

    String optional

    Zeitpunkt des Downloads. Die Angabe erfolgt 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))})})

  • error

    InterruptReason optional

    Warum der Download unterbrochen wurde Verschiedene Arten von HTTP-Fehlern können unter einem der Fehler gruppiert werden, die mit SERVER_ beginnen. Netzwerkfehler beginnen mit NETWORK_, Fehler beim Schreiben der Datei in das Dateisystem beginnen mit FILE_ und vom Nutzer initiierte Unterbrechungen beginnen mit USER_.

  • estimatedEndTime

    String optional

    Die geschätzte Zeit bis zum Abschluss des Downloads. Die Angabe erfolgt 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 nach der Entfernung von Dateien sucht. Rufen Sie search() auf, um die Prüfung auf das Vorhandensein von Dateien auszulösen. Wenn die Prüfung auf das Vorhandensein abgeschlossen ist und die Datei gelöscht wurde, wird das Ereignis onChanged ausgelöst. Beachten Sie, dass search() mit der Rückgabe nicht darauf wartet, dass die Existenzprüfung abgeschlossen ist. Daher spiegeln die Ergebnisse von search() das Dateisystem möglicherweise nicht genau wider. Außerdem kann search() so oft wie nötig aufgerufen werden, prüft jedoch nur einmal alle 10 Sekunden, ob eine 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, über die dieser Download nach allen Weiterleitungen erfolgt.

  • id

    Zahl

    Eine Kennung, die für alle Browsersitzungen dauerhaft gültig 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 beim Download keine Daten mehr vom Host gelesen, aber die Verbindung offen gehalten wurde.

  • referrer

    String

    Absolute URL.

  • startTime

    String

    Zeitpunkt, an dem der Download begann. Die Angabe erfolgt 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))})})

  • state

    Bundesland

    Gibt an, ob der Download gerade läuft, unterbrochen wird 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 aus dieser Download gestartet wurde, vor 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 Downloadverzeichnis, der die heruntergeladene Datei enthält und möglicherweise Unterverzeichnisse enthält. 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 und der vorläufige Dateiname der Datei ermittelt 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, die 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 die Funktion zur 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

    Nummer optional

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

  • Gefahr

    DangerType optional

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

  • endTime

    String optional

    Zeitpunkt des Downloads. Die Angabe erfolgt im ISO-8601-Format.

  • endedAfter

    String optional

    Beschränkt die Ergebnisse auf DownloadItem, die nach der angegebenen ms im ISO-8601-Format beendet wurden

  • endedBefore

    String optional

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

  • error

    InterruptReason optional

    Warum ein Download unterbrochen wurde

  • vorhanden

    Boolescher Wert optional

    Ob die heruntergeladene Datei vorhanden ist

  • fileSize

    Nummer 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 54 und höher

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

  • finalUrlRegex

    String optional

    Chrome 54 und höher

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

  • id

    Nummer optional

    Der id des abzufragenden DownloadItem.

  • Limit

    Nummer optional

    Die maximale Anzahl übereinstimmender DownloadItem-Ergebnisse. Die Standardeinstellung ist 1.000. Legen Sie „0“ fest, um alle übereinstimmenden DownloadItem zurückzugeben. Unter search erfahren Sie, wie Sie durch Ergebnisse blättern können.

  • Pantomime

    String optional

    Der MIME-Typ der Datei.

  • orderBy

    string[] optional

    Setze die Elemente dieses Arrays auf Attribute vom Typ DownloadItem, um die Suchergebnisse zu sortieren. Wenn Sie beispielsweise orderBy=['startTime'] festlegen, werden die DownloadItem nach ihrer Startzeit in aufsteigender Reihenfolge sortiert. Stellen Sie einen Bindestrich voran, um die absteigende Reihenfolge anzugeben: „-startTime“.

  • pausiert

    Boolescher Wert optional

    „True“, wenn beim Download keine Daten mehr vom Host gelesen, aber die Verbindung offen gehalten wurde.

  • Abfrage

    string[] optional

    Dieses Array von Suchbegriffen beschränkt die Ergebnisse auf DownloadItem, dessen filename oder url oder finalUrl alle Suchbegriffe enthalten, die nicht mit einem Bindestrich „-“ beginnen, und keinen, der mit einem Bindestrich beginnt.

  • startTime

    String optional

    Zeitpunkt, an dem der Download begann. Die Angabe erfolgt im ISO 8601-Format.

  • startedAfter

    String optional

    Beschränkt die Ergebnisse auf DownloadItem, die nach der 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.

  • state

    Bundesstaat/-land optional

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

  • totalBytes

    Nummer optional

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

  • totalBytesGreater

    Nummer optional

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

  • totalBytesLess

    Nummer optional

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

  • url

    String optional

    Die absolute URL, von der aus dieser Download gestartet wurde, vor Weiterleitungen

  • urlRegex

    String optional

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

FilenameConflictAction

Uneinheitlich

Um Duplikate zu vermeiden, wird filename so geändert, dass vor der Dateiendung ein Zähler eingefügt wird.

Überschreiben

Die vorhandene Datei wird 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 von DownloadItem als Pfad relativ zum standardmäßigen Downloadverzeichnis des Nutzers, der möglicherweise Unterverzeichnisse enthält. Absolute Pfade, leere Pfade und Pfade, die Backreferences „...“ enthalten, werden ignoriert. filename wird ignoriert, wenn durch eine Erweiterung onDeterminingFilename-Listener registriert sind.

GetFileIconOptions

Attribute

  • Größe

    16
    |32
     optional

    Die Größe des zurückgegebenen Symbols. Das Symbol ist quadratisch und hat die Abmessungen Größe × Größe Pixel. Die standardmäßige und größte Größe für das Symbol beträgt 32 x 32 Pixel. Es werden nur die Größen 16 und 32 unterstützt. Es ist ein Fehler, eine andere Größe anzugeben.

HeaderNameValuePair

Attribute

  • name

    String

    Name des HTTP-Headers.

  • value

    String

    Wert des HTTP-Headers.

HttpMethod

Enum

InterruptReason

Enum

"FILE_FAILED"

"FILE_ACCESS_DENIED"

"FILE_NO_SPACE"

"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_INVALID_REQUEST"

"SERVER_FAILED"

"SERVER_NO_RANGE"

"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 Dateihost wurde aufgrund eines Fehlers unterbrochen.

(abgeschlossen)

Der Download wurde erfolgreich abgeschlossen.

Enum

"in_progress"

StringDelta

Attribute

  • aktuell

    String optional

  • Zurück

    String optional

UiOptions

Chrome 105 und höher

Attribute

  • aktiviert

    boolean

    Download-Benutzeroberfläche 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 Seiten-/Browseraktions-Pop-up). Gefährliche Downloads werden nicht automatisch akzeptiert. Wenn der Download akzeptiert wird, wird das Ereignis onChanged ausgelöst. Andernfalls passiert nichts. Wenn alle Daten in eine temporäre Datei abgerufen wurden und entweder der Download nicht gefährlich ist oder die Gefahr akzeptiert wurde, wird die temporäre Datei in den Namen der Zieldatei umbenannt, die state ändert sich in „Abgeschlossen“ und onChanged wird ausgelöst.

Parameter

  • downloadId

    Zahl

    Die Kennung für DownloadItem.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    ()=>void

Rückgaben

  • Promise<void>

    Chrome 96 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

cancel()

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

Brechen Sie einen Download ab. Wenn callback ausgeführt wird, wird der Download abgebrochen, abgeschlossen, unterbrochen oder existiert nicht mehr.

Parameter

  • downloadId

    Zahl

    Die ID des Downloads, der abgebrochen werden soll.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    ()=>void

Rückgaben

  • Promise<void>

    Chrome 96 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

download()

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

Laden Sie eine URL herunter. Wenn für die URL das HTTP[S]-Protokoll verwendet wird, schließt die Anfrage alle Cookies ein, die derzeit für ihren Hostnamen festgelegt sind. Wenn sowohl filename als auch saveAs angegeben sind, wird das Dialogfeld „Speichern unter“ angezeigt. Es enthält bereits die Daten für filename. Wenn der Download erfolgreich gestartet wurde, wird callback mit den 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 Releases abwärtskompatibel sind. Erweiterungen dürfen ihn nicht parsen.

Parameter

  • Optionen

    DownloadOptions

    Was du herunterladen kannst und wie

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (downloadId: number)=>void

    • downloadId

      Zahl

Rückgaben

  • Versprechen<Zahl>

    Chrome 96 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den 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 mit query übereinstimmt. Anschließend wird callback aufgerufen.

Parameter

  • Abfrage

    DownloadQuery

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    (erasedIds: number[])=>void

    • erasedIds

      Nummer[]

Rückgaben

  • Promise<Zahl[]>

    Chrome 96 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

getFileIcon()

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

Ruft ein Symbol für den angegebenen Download ab. Bei neuen Downloads sind Dateisymbole verfügbar, nachdem das Ereignis onCreated empfangen wurde. Das Bild, das von dieser Funktion während eines Downloads zurückgegeben wird, kann sich 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. Welches Symbol zurückgegeben wird, hängt von einer Reihe von Faktoren ab, darunter der Status des Downloads, die Plattform, die registrierten Dateitypen und das visuelle 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

    Funktion optional

    Der Parameter callback sieht so aus: 

    (iconURL?: string)=>void

    • iconURL

      String optional

Rückgaben

  • Versprechen<string|undefiniert>

    Chrome 96 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den 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 neben der 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 oder höher

    Der Parameter callback sieht so aus: 

    ()=>void

Rückgaben

  • Promise<void>

    Chrome 123 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

pause()

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

Halten Sie den Download an. 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 angehalten werden soll.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    ()=>void

Rückgaben

  • Promise<void>

    Chrome 96 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

removeFile()

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

Entfernen Sie die heruntergeladene Datei, falls sie vorhanden ist und der 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

Rückgaben

  • Promise<void>

    Chrome 96 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

resume()

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

Setzen Sie einen angehaltenen 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 Downloads, der fortgesetzt werden soll.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    ()=>void

Rückgaben

  • Promise<void>

    Chrome 96 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den 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. Um ein bestimmtes DownloadItem abzurufen, legen Sie nur das Feld id fest. Wenn Sie durch eine große Anzahl von Elementen blättern möchten, legen Sie orderBy: ['-startTime'] fest, limit auf die Anzahl der Elemente pro Seite und startedAfter auf startTime des letzten Elements auf der letzten Seite.

Parameter

Rückgaben

  • Promise<DownloadItem[]>

    Chrome 96 oder höher

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

setShelfEnabled()

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

Verwenden Sie stattdessen setUiOptions.

Sie können die graue Ablage am unteren Rand jedes Fensters, das mit dem aktuellen Browserprofil verknüpft ist, aktivieren oder deaktivieren. Die Ablage ist deaktiviert, solange mindestens eine Erweiterung sie deaktiviert hat. Wenn die Ablage aktiviert ist, wird eine Fehlermeldung über runtime.lastError zurückgegeben, wenn mindestens eine andere Erweiterung deaktiviert ist. Erfordert zusätzlich zur Berechtigung "downloads" die Berechtigung "downloads.shelf".

Parameter

  • aktiviert

    boolean

setUiOptions()

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

Sie können die Download-Benutzeroberfläche für jedes Fenster ändern, das dem aktuellen Browserprofil zugeordnet ist. Solange für mindestens eine Erweiterung UiOptions.enabled auf „false“ gesetzt ist, wird die Download-Benutzeroberfläche ausgeblendet. Wenn UiOptions.enabled auf „true“ gesetzt ist, obwohl mindestens eine andere Erweiterung deaktiviert ist, wird über runtime.lastError ein Fehler zurückgegeben. Erfordert zusätzlich zur Berechtigung "downloads" die Berechtigung "downloads.ui".

Parameter

  • Optionen

    UiOptions

    Kapseln Sie eine Änderung an der Download-Benutzeroberfläche.

  • callback

    Funktion optional

    Der Parameter callback sieht so aus: 

    ()=>void

Rückgaben

  • Promise<void>

    Promise-Objekte werden in Manifest V3 und höher unterstützt, Callbacks werden jedoch aus Gründen der Abwärtskompatibilität bereitgestellt. Sie können nicht beide in einem Funktionsaufruf verwenden. Das Promise wird mit demselben Typ aufgelöst, der an den Callback übergeben wird.

show()

chrome.downloads.show(
  downloadId: number,
)

Zeigt die heruntergeladene Datei in ihrem Ordner in einem Dateimanager an.

Parameter

  • downloadId

    Zahl

    Die ID für die heruntergeladene Datei.

showDefaultFolder()

chrome.downloads.showDefaultFolder()

Standardordner „Downloads“ in einem Dateimanager anzeigen

Veranstaltungen

onChanged

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

Wenn sich eine der Eigenschaften einer DownloadItem mit Ausnahme von bytesReceived und estimatedEndTime ändert, wird dieses Ereignis mit der 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 Objekt DownloadItem ausgelöst, wenn ein Download beginnt.

Parameter

onDeterminingFilename

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

Bei der Ermittlung des Dateinamens haben Erweiterungen die Möglichkeit, das Ziel-DownloadItem.filename-Element 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 er true zurückgeben. 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 beim Download downloadItem.filename als Dateiname verwendet werden kann, oder ein suggestion-Objekt an suggest übergeben, um den Namen der Zieldatei zu überschreiben. Wird der Dateiname von mehr als einer Erweiterung überschrieben, gewinnt die letzte installierte Erweiterung, deren Listener ein suggestion-Objekt an suggest übergibt. Um Unklarheiten darüber zu vermeiden, welche Erweiterung erfolgreich ist, sollten Nutzer keine Erweiterungen installieren, die möglicherweise in Konflikt stehen. Wenn der Download von download initiiert wird und der Name der Zieldatei 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