browser.downloads

Beschrijving

Gebruik de chrome.downloads API om downloads programmatisch te starten, te controleren, te manipuleren en te zoeken.

Rechten

downloads

Je moet het recht "downloads" definiëren in het extensiemanifest om deze API te gebruiken.

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

Voorbeelden

Je vindt eenvoudige voorbeelden van het gebruik van de browser.downloads API in de directory examples/api/downloads. Ga naar Samples voor andere voorbeelden en hulp bij het bekijken van de broncode.

Typen

BooleanDelta

Eigenschappen

• stroming

  booleaans optioneel

• vorige

  booleaans optioneel

DangerType

Enum

"file"
De bestandsnaam van de download is verdacht.

"url"
De URL van de download is schadelijk.

content
Het is bekend dat het gedownloade bestand schadelijk is.

"uncommon"
De URL van de download wordt niet vaak gedownload en kan gevaarlijk zijn.

"host"
De download is afkomstig van een host die bekendstaat om de distributie van schadelijke binaire bestanden en is waarschijnlijk gevaarlijk.

"unwanted"
De download is mogelijk ongewenst of onveilig. De software kan bijvoorbeeld wijzigingen aanbrengen in de browser- of computerinstellingen.

'safe'
De download vormt geen bekend gevaar voor de computer van de gebruiker.

"accepted"
De gebruiker heeft de gevaarlijke download geaccepteerd.

"allowlistedByPolicy"
Zakelijke waarden.

"asyncScanning"

"asyncLocalPasswordScanning"

"passwordProtected"

"blockedTooLarge"

"sensitiveContentWarning"

"sensitiveContentBlock"

"deepScannedFailed"

"deepScannedSafe"

"deepScannedOpenedDangerous"

"promptForScanning"

"promptForLocalPasswordScanning"

"accountCompromise"

"blockedScanFailed"

"forceSaveToGdrive"
Voor gebruik door de extensie Secure Enterprise Browser. Als dit is vereist, blokkeert Chrome de download naar de schijf en wordt het bestand rechtstreeks naar Google Drive gedownload.

"forceSaveToOnedrive"
Voor gebruik door de extensie Secure Enterprise Browser. Indien nodig blokkeert Chrome de download naar de schijf en wordt het bestand rechtstreeks naar OneDrive gedownload.

DoubleDelta

Eigenschappen

• stroming

  number optioneel

• vorige

  number optioneel

DownloadDelta

Eigenschappen

• canResume

  BooleanDelta optioneel

  De wijziging in canResume, indien van toepassing.

• gevaar

  StringDelta optioneel

  De wijziging in danger, indien van toepassing.

• endTime

  StringDelta optioneel

  De wijziging in endTime, indien van toepassing.

• fout

  StringDelta optioneel

  De wijziging in error, indien van toepassing.

• bestaat

  BooleanDelta optioneel

  De wijziging in exists, indien van toepassing.

• fileSize

  DoubleDelta optioneel

  De wijziging in fileSize, indien van toepassing.

• bestandsnaam

  StringDelta optioneel

  De wijziging in filename, indien van toepassing.

• finalUrl

  StringDelta optioneel

  Chrome 54+ browser.* sinds Chrome 148

  De wijziging in finalUrl, indien van toepassing.

• id

  getal

  De id van de DownloadItem die is gewijzigd.

• mime

  StringDelta optioneel

  De wijziging in mime, indien van toepassing.

• onderbroken

  BooleanDelta optioneel

  De wijziging in paused, indien van toepassing.

• startTime

  StringDelta optioneel

  De wijziging in startTime, indien van toepassing.

• status

  StringDelta optioneel

  De wijziging in state, indien van toepassing.

• totalBytes

  DoubleDelta optioneel

  De wijziging in totalBytes, indien van toepassing.

• url

  StringDelta optioneel

  De wijziging in url, indien van toepassing.

DownloadItem

Eigenschappen

• byExtensionId

  tekenreeks optioneel

  De ID voor de extensie die deze download heeft gestart, als deze download is gestart door een extensie. Verandert niet nadat deze is ingesteld.

• byExtensionName

  tekenreeks optioneel

  De gelokaliseerde naam van de extensie die deze download heeft gestart, als deze download is gestart door een extensie. Kan veranderen als de extensie de naam wijzigt of als de gebruiker de landinstelling wijzigt.

• bytesReceived

  getal

  Het aantal bytes dat tot nu toe is ontvangen van de host, zonder rekening te houden met bestandscompressie.

• canResume

  booleaans

  Waar als de download bezig is en is onderbroken, of als deze is onderbroken en kan worden hervat vanaf het punt waar deze is onderbroken.

• gevaar

  DangerType

  Een indicatie of deze download als veilig wordt beschouwd of als verdacht bekendstaat.

• endTime

  tekenreeks optioneel

  De tijd waarop de download is beëindigd, in de ISO 8601-indeling. Kan rechtstreeks worden doorgegeven aan de Date-constructor: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.endTime) console.log(new Date(item.endTime))})})

• fout

  InterruptReason optioneel

  Waarom de download is onderbroken. Verschillende soorten HTTP-fouten kunnen worden gegroepeerd onder een van de fouten die beginnen met SERVER_. Fouten met betrekking tot het netwerk beginnen met NETWORK_, fouten met betrekking tot het proces van het schrijven van het bestand naar het bestandssysteem beginnen met FILE_ en onderbrekingen die door de gebruiker zijn gestart, beginnen met USER_.

• estimatedEndTime

  tekenreeks optioneel

  Geschatte tijd waarop de download is afgerond in de ISO 8601-indeling. Kan rechtstreeks worden doorgegeven aan de Date-constructor: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.estimatedEndTime) console.log(new Date(item.estimatedEndTime))})})

• bestaat

  booleaans

  Of het gedownloade bestand nog bestaat. Deze informatie is misschien verouderd, omdat Chrome niet automatisch controleert of bestanden zijn verwijderd. Roep search() aan om de controle op het bestaan van het bestand te activeren. Als de controle is afgerond en het bestand is verwijderd, wordt de gebeurtenis onChanged geactiveerd. search() wacht niet tot de controle op bestaan is afgerond voordat deze wordt geretourneerd. De resultaten van search() weerspiegelen het bestandssysteem dus misschien niet nauwkeurig. Ook kan search() zo vaak als nodig worden aangeroepen, maar wordt niet vaker dan eens per 10 seconden gecontroleerd of het bestand bestaat.

• fileSize

  getal

  Het aantal bytes in het hele bestand na decompressie, of -1 als dit onbekend is.

• bestandsnaam

  tekenreeks

  Absoluut lokaal pad.

• finalUrl

  tekenreeks

  Chrome 54+ browser.* sinds Chrome 148

  De absolute URL van waaruit deze download wordt uitgevoerd, na alle omleidingen.

• id

  getal

  Een ID die blijft bestaan tijdens browsersessies.

• incognito

  booleaans

  Onwaar als deze download is opgenomen in de geschiedenis, waar als deze niet is opgenomen.

• mime

  tekenreeks

  Het MIME-type van het bestand.

• onderbroken

  booleaans

  Waar als de download geen gegevens meer leest van de host, maar de verbinding open heeft gehouden.

• verwijzende URL

  tekenreeks

  Absolute URL.

• startTime

  tekenreeks

  De tijd waarop de download is gestart, in de ISO 8601-indeling. Kan rechtstreeks worden doorgegeven aan de Date-constructor: chrome.downloads.search({}, function(items){items.forEach(function(item){console.log(new Date(item.startTime))})})

• status

  Staat

  Geeft aan of de download bezig, onderbroken of voltooid is.

• totalBytes

  getal

  Het aantal bytes in het hele bestand, zonder rekening te houden met bestandscompressie, of -1 als dit onbekend is.

• url

  tekenreeks

  De absolute URL van waaruit deze download is gestart, vóór omleidingen.

DownloadOptions

Eigenschappen

• lichaam

  tekenreeks optioneel

  Hoofdtekst van de post.

• conflictAction

  FilenameConflictAction optioneel

  De actie die moet worden uitgevoerd als filename al bestaat.

• bestandsnaam

  tekenreeks optioneel

  Een bestandspad relatief aan de map Downloads dat het gedownloade bestand bevat, mogelijk met subdirectory's. Absolute paden, lege paden en paden met terugverwijzingen '..' veroorzaken een fout. onDeterminingFilename maakt het mogelijk een bestandsnaam voor te stellen nadat het MIME-type van het bestand en een voorlopige bestandsnaam zijn bepaald.

• headers

  HeaderNameValuePair[] optioneel

  Extra HTTP-headers die met het verzoek moeten worden meegestuurd als de URL het HTTP[s]-protocol gebruikt. Elke kop wordt weergegeven als een woordenboek met de sleutels name en value of binaryValue, beperkt tot de sleutels die zijn toegestaan door XMLHttpRequest.

• method

  HttpMethod optioneel

  De HTTP-methode die moet worden gebruikt als de URL het HTTP[S]-protocol gebruikt.

• saveAs

  booleaans optioneel

  Een bestandskiezer gebruiken zodat de gebruiker een bestandsnaam kan selecteren, ongeacht of filename is ingesteld of al bestaat.

• url

  tekenreeks

  De URL die moet worden gedownload.

DownloadQuery

Eigenschappen

• bytesReceived

  number optioneel

  Het aantal bytes dat tot nu toe is ontvangen van de host, zonder rekening te houden met bestandscompressie.

• gevaar

  DangerType optioneel

  Een indicatie of deze download als veilig wordt beschouwd of als verdacht bekendstaat.

• endTime

  tekenreeks optioneel

  De tijd waarop de download is beëindigd, in de ISO 8601-indeling.

• endedAfter

  tekenreeks optioneel

  Beperkt de resultaten tot DownloadItem die zijn geëindigd na de opgegeven ms in de ISO 8601-indeling

• endedBefore

  tekenreeks optioneel

  Beperkt de resultaten tot DownloadItem die zijn geëindigd vóór de aangegeven ms in de ISO 8601-indeling.

• fout

  InterruptReason optioneel

  Waarom een download is onderbroken.

• bestaat

  booleaans optioneel

  Of het gedownloade bestand bestaat.

• fileSize

  number optioneel

  Het aantal bytes in het hele bestand na decompressie, of -1 als dit onbekend is.

• bestandsnaam

  tekenreeks optioneel

  Absoluut lokaal pad.

• filenameRegex

  tekenreeks optioneel

  Beperkt de resultaten tot DownloadItem waarvan de filename overeenkomt met de ingevoerde reguliere expressie.

• finalUrl

  tekenreeks optioneel

  Chrome 54+ browser.* sinds Chrome 148

  De absolute URL van waaruit deze download wordt uitgevoerd, na alle omleidingen.

• finalUrlRegex

  tekenreeks optioneel

  Chrome 54+ browser.* sinds Chrome 148

  Beperkt de resultaten tot DownloadItem waarvan de finalUrl overeenkomt met de ingevoerde reguliere expressie.

• id

  number optioneel

  De id van de DownloadItem om een query op uit te voeren.

• limiet

  number optioneel

  Het maximumaantal overeenkomende DownloadItem is geretourneerd. De standaardwaarde is 1000. Stel deze waarde in op 0 om alle overeenkomende DownloadItem te retourneren. Ga naar search voor meer informatie over hoe je door de resultaten bladert.

• mime

  tekenreeks optioneel

  Het MIME-type van het bestand.

• orderBy

  string[] optioneel

  Stel elementen van deze matrix in op DownloadItem-property's om zoekresultaten te sorteren. Als je bijvoorbeeld orderBy=['startTime'] instelt, worden de DownloadItem gesorteerd op begintijd in oplopende volgorde. Als je een aflopende volgorde wilt opgeven, voeg je een koppelteken toe: -startTime.

• onderbroken

  booleaans optioneel

  Waar als de download geen gegevens meer leest van de host, maar de verbinding open heeft gehouden.

• query

  string[] optioneel

  Deze matrix van zoektermen beperkt de resultaten tot DownloadItem waarvan de filename, url of finalUrl alle zoektermen bevatten die niet beginnen met een streepje '-' en geen van de zoektermen die wel beginnen met een streepje.

• startTime

  tekenreeks optioneel

  De tijd waarop de download is gestart, in de ISO 8601-indeling.

• startedAfter

  tekenreeks optioneel

  Beperkt de resultaten tot DownloadItem die zijn gestart na de aangegeven ms in de ISO 8601-indeling.

• startedBefore

  tekenreeks optioneel

  Beperkt de resultaten tot DownloadItem die zijn gestart vóór de opgegeven ms in de ISO 8601-indeling.

• status

  State optioneel

  Geeft aan of de download bezig, onderbroken of voltooid is.

• totalBytes

  number optioneel

  Het aantal bytes in het hele bestand, zonder rekening te houden met bestandscompressie, of -1 als dit onbekend is.

• totalBytesGreater

  number optioneel

  Beperkt de resultaten tot DownloadItem waarvan de totalBytes groter is dan het opgegeven gehele getal.

• totalBytesLess

  number optioneel

  Beperkt de resultaten tot DownloadItem waarvan de totalBytes kleiner is dan het opgegeven gehele getal.

• url

  tekenreeks optioneel

  De absolute URL van waaruit deze download is gestart, vóór omleidingen.

• urlRegex

  tekenreeks optioneel

  Beperkt de resultaten tot DownloadItem waarvan de url overeenkomt met de ingevoerde reguliere expressie.

FilenameConflictAction

uniek maken

Om duplicatie te voorkomen, wordt de filename gewijzigd door een teller toe te voegen vóór de bestandsextensie.

overschrijven

Het bestaande bestand wordt overschreven door het nieuwe bestand.

prompt

De gebruiker krijgt een dialoogvenster voor bestandskiezer.

Enum

"uniquify"

"overwrite"

"prompt"

FilenameSuggestion

Eigenschappen

• conflictAction

  FilenameConflictAction optioneel

  De actie die moet worden uitgevoerd als filename al bestaat.

• bestandsnaam

  tekenreeks

  Het nieuwe doel DownloadItem.filename van de DownloadItem, als een pad ten opzichte van de standaard Downloads-directory van de gebruiker, mogelijk met subdirectory's. Absolute paden, lege paden en paden met terugverwijzingen '..' worden genegeerd. filename wordt genegeerd als er onDeterminingFilename-listeners zijn geregistreerd door extensies.

GetFileIconOptions

Eigenschappen

• maat

  number optioneel

  De grootte van het geretourneerde icoon in density-independent pixels (DIP's). Moet 16 of 32 zijn (standaard is 32). Op schermen met een hoge DPI wordt de geretourneerde afbeelding geschaald met de schaalfactor van het apparaat (bijvoorbeeld 64 x 64 pixels voor grootte 32 op een 2x-scherm). Gesprekken van achtergrondservices worden standaard op schaal 1x uitgevoerd.

HeaderNameValuePair

Eigenschappen

• name

  tekenreeks

  Naam van de HTTP-header.

• waarde

  tekenreeks

  Waarde van de HTTP-header.

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

De download ontvangt op dit moment gegevens van de server.

onderbroken

Door een fout is de verbinding met de bestandshost verbroken.

complete

De download is afgerond.

Enum

"in_progress"

"interrupted"

"complete"

StringDelta

Eigenschappen

• stroming

  tekenreeks optioneel

• vorige

  tekenreeks optioneel

UiOptions

Chrome 105 of hoger browser.* sinds Chrome 148

Eigenschappen

• aangezet

  booleaans

  De download-UI aan- of uitzetten.

Methoden

acceptDanger()

browser.downloads.acceptDanger(
  downloadId: number,
): Promise<void>

De gebruiker vragen een gevaarlijke download te accepteren. Kan alleen worden aangeroepen vanuit een zichtbare context (tabblad, venster of pop-up voor pagina-/browseractie). Accepteert gevaarlijke downloads niet automatisch. Als de download wordt geaccepteerd, wordt een onChanged-gebeurtenis geactiveerd. Anders gebeurt er niets. Als alle gegevens zijn opgehaald in een tijdelijk bestand en de download niet gevaarlijk is of het gevaar is geaccepteerd, wordt de naam van het tijdelijke bestand gewijzigd in de doelbestandsnaam, wordt de state gewijzigd in 'complete' en wordt onChanged geactiveerd.

Parameters

• downloadId

  getal

  De ID voor de DownloadItem.

Retourzendingen

• Promise<void>

  Chrome 96+ browser.* sinds Chrome 148

  Retourneert een Promise die wordt opgelost wanneer het dialoogvenster met de gevarenprompt wordt gesloten.

cancel()

browser.downloads.cancel(
  downloadId: number,
): Promise<void>

Een download annuleren. Als callback wordt uitgevoerd, is de download geannuleerd, afgerond, onderbroken of bestaat deze niet meer.

Parameters

• downloadId

  getal

  De ID van de download die je wilt annuleren.

Retourzendingen

• Promise<void>

  Chrome 96+ browser.* sinds Chrome 148

  Retourneert een Promise die wordt opgelost wanneer het annuleringsverzoek is afgerond.

download()

browser.downloads.download(
  options: DownloadOptions,
): Promise<number>

Een URL downloaden. Als de URL het HTTP[S]-protocol gebruikt, bevat het verzoek alle cookies die op dat moment zijn ingesteld voor de hostnaam. Als zowel filename als saveAs zijn ingevoerd, wordt het dialoogvenster Opslaan als getoond, vooraf ingevuld met de ingevoerde filename. Als de download is gestart, wordt callback aangeroepen met de downloadId van de nieuwe DownloadItem. Als er een fout is opgetreden bij het starten van de download, wordt callback aangeroepen met downloadId=undefined en bevat runtime.lastError een beschrijvende tekenreeks. We kunnen niet garanderen dat de fouttekenreeksen compatibel blijven met eerdere versies tussen releases. Extensies mogen deze niet parseren.

Parameters

• opties

  DownloadOptions

  Wat je kunt downloaden en hoe.

Retourzendingen

• Promise<number>

  Chrome 96+ browser.* sinds Chrome 148

  Retourneert een Promise die wordt omgezet met de ID van de nieuwe DownloadItem.

erase()

browser.downloads.erase(
  query: DownloadQuery,
): Promise<number[]>

Overeenkomende DownloadItem wissen uit de geschiedenis zonder het gedownloade bestand te verwijderen. Er wordt een onErased-gebeurtenis geactiveerd voor elke DownloadItem die overeenkomt met query. Daarna wordt callback aangeroepen.

Parameters

• query

  DownloadQuery

Retourzendingen

• Promise<number[]>

  Chrome 96+ browser.* sinds Chrome 148

getFileIcon()

browser.downloads.getFileIcon(
  downloadId: number,
  options?: GetFileIconOptions,
): Promise<string | undefined>

Een icoon ophalen voor de aangegeven download. Voor nieuwe downloads zijn bestandsiconen beschikbaar nadat de doelbestandsnaam van de download is bepaald (bijvoorbeeld als onChanged wordt geactiveerd met een filename-wijziging). Als je het icoon probeert op te halen voordat de bestandsnaam is bepaald, leidt dit tot een fout via runtime.lastError. De afbeelding die door deze functie wordt geretourneerd terwijl een download wordt uitgevoerd, kan verschillen van de afbeelding die wordt geretourneerd nadat de download is afgerond. Iconen worden opgehaald door het onderliggende besturingssysteem of de toolkit op te vragen, afhankelijk van het platform. Het icoon dat wordt geretourneerd, is daarom afhankelijk van een aantal factoren, waaronder de status van de download, het platform, de geregistreerde bestandstypen en het visuele thema. Als een bestandspictogram niet kan worden bepaald, bevat runtime.lastError een foutmelding.

Parameters

• downloadId

  getal

  De ID voor de download.

• opties

  GetFileIconOptions optioneel

Retourzendingen

• Promise<string | undefined>

  Chrome 96+ browser.* sinds Chrome 148

  Retourneert een Promise die wordt omgezet in een URL naar een afbeelding die de download vertegenwoordigt.

open()

browser.downloads.open(
  downloadId: number,
): Promise<void>

Opent het gedownloade bestand nu als de DownloadItem is afgerond. Anders wordt er een fout geretourneerd via runtime.lastError. Voor deze methode is het recht "downloads.open" vereist naast het recht "downloads". Er wordt een onChanged-gebeurtenis geactiveerd als het item voor het eerst wordt geopend. Deze methode kan alleen worden aangeroepen als reactie op een gebruikersactivatie.

Parameters

• downloadId

  getal

  De ID voor het gedownloade bestand.

Retourzendingen

• Promise<void>

  Chrome 123 of hoger browser.* sinds Chrome 148

pause()

browser.downloads.pause(
  downloadId: number,
): Promise<void>

Onderbreek de download. Als het verzoek is geslaagd, is de download onderbroken. Anders bevat runtime.lastError een foutmelding. Het verzoek mislukt als de download niet actief is.

Parameters

• downloadId

  getal

  De ID van de download die je wilt onderbreken.

Retourzendingen

• Promise<void>

  Chrome 96+ browser.* sinds Chrome 148

  Retourneert een Promise die wordt opgelost wanneer het pauzeverzoek is afgerond.

removeFile()

browser.downloads.removeFile(
  downloadId: number,
): Promise<void>

Verwijder het gedownloade bestand als het bestaat en de DownloadItem is afgerond. Retourneer anders een fout via runtime.lastError.

Parameters

• downloadId

  getal

Retourzendingen

• Promise<void>

  Chrome 96+ browser.* sinds Chrome 148

resume()

browser.downloads.resume(
  downloadId: number,
): Promise<void>

Een onderbroken download hervatten. Als het verzoek is geslaagd, wordt de download uitgevoerd en is deze niet onderbroken. Anders bevat runtime.lastError een foutmelding. Het verzoek mislukt als de download niet actief is.

Parameters

• downloadId

  getal

  De ID van de download die moet worden hervat.

Retourzendingen

• Promise<void>

  Chrome 96+ browser.* sinds Chrome 148

  Retourneert een Promise die wordt opgelost wanneer het hervattingsverzoek is afgerond.

search()

browser.downloads.search(
  query: DownloadQuery,
): Promise<DownloadItem[]>

Zoek DownloadItem. Stel query in op het lege object om alle DownloadItem te krijgen. Als u een specifieke DownloadItem wilt ophalen, stelt u alleen het veld id in. Als je door een groot aantal items wilt bladeren, stel je orderBy: ['-startTime'] in, stel je limit in op het aantal items per pagina en stel je startedAfter in op de startTime van het laatste item van de laatste pagina.

Parameters

• query

  DownloadQuery

Retourzendingen

• Promise<DownloadItem[]>

  Chrome 96+ browser.* sinds Chrome 148

setShelfEnabled()

Beëindigd sinds Chrome 117

browser.downloads.setShelfEnabled(
  enabled: boolean,
): void

Gebruik in plaats daarvan setUiOptions.

Zet de grijze plank aan of uit onderaan elk venster dat is gekoppeld aan het huidige browserprofiel. De plank wordt uitgezet zolang minstens één extensie deze heeft uitgezet. Als je de plank aanzet terwijl minstens één andere extensie deze heeft uitgezet, wordt er een fout geretourneerd via runtime.lastError. Vereist het recht "downloads.shelf" naast het recht "downloads".

Parameters

• aangezet

  booleaans

setUiOptions()

Chrome 105 of hoger browser.* sinds Chrome 148

browser.downloads.setUiOptions(
  options: UiOptions,
): Promise<void>

De download-UI wijzigen van elk venster dat aan het huidige browserprofiel is gekoppeld. Zolang minstens één extensie UiOptions.enabled heeft ingesteld op false, wordt de UI voor downloads verborgen. Als je UiOptions.enabled instelt op True terwijl minstens één andere extensie de instelling heeft uitgezet, wordt er een fout geretourneerd via runtime.lastError. Vereist het recht "downloads.ui" naast het recht "downloads".

Parameters

• opties

  UiOptions

  Een wijziging in de download-UI inkapselen.

Retourzendingen

• Promise<void>

  Retourneert een Promise die wordt opgelost wanneer de UI-update is afgerond.

show()

browser.downloads.show(
  downloadId: number,
): void

Het gedownloade bestand tonen in de map in een bestandsbeheerder.

Parameters

• downloadId

  getal

  De ID voor het gedownloade bestand.

showDefaultFolder()

browser.downloads.showDefaultFolder(): void

De standaardmap Downloads tonen in een bestandsbeheerder.

Evenementen

onChanged

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

Als een van de eigenschappen van een DownloadItem, behalve bytesReceived en estimatedEndTime, verandert, wordt deze gebeurtenis geactiveerd met de downloadId en een object met de eigenschappen die zijn gewijzigd.

Parameters

• callback

  functie

  De parameter callback ziet er zo uit:

  (downloadDelta: DownloadDelta) => void

  • downloadDelta

    DownloadDelta

onCreated

browser.downloads.onCreated.addListener(
  callback: function,
)

Deze gebeurtenis wordt geactiveerd met het object DownloadItem als een download begint.

Parameters

• callback

  functie

  De parameter callback ziet er zo uit:

  (downloadItem: DownloadItem) => void

  • downloadItem

    DownloadItem

onDeterminingFilename

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

Tijdens het proces om de bestandsnaam te bepalen, krijgen extensies de mogelijkheid om het doel DownloadItem.filename te overschrijven. Elke extensie mag niet meer dan één listener registreren voor deze gebeurtenis. Elke listener moet suggest precies één keer aanroepen, synchroon of asynchroon. Als de listener suggest asynchroon aanroept, moet deze true retourneren. Als de listener suggest niet synchroon aanroept en geen true retourneert, wordt suggest automatisch aangeroepen. De DownloadItem wordt pas afgerond als alle listeners suggest hebben aangeroepen. Listeners kunnen suggest aanroepen zonder argumenten om de download toe te staan downloadItem.filename te gebruiken voor de bestandsnaam, of een suggestion-object doorgeven aan suggest om de doelbestandsnaam te overschrijven. Als meer dan één extensie de bestandsnaam overschrijft, wint de laatst geïnstalleerde extensie waarvan de listener een suggestion-object doorgeeft aan suggest. Gebruikers moeten geen extensies installeren die met elkaar kunnen conflicteren, om verwarring te voorkomen over welke extensie wordt gebruikt. Als de download wordt gestart door download en de doelbestandsnaam bekend is voordat het MIME-type en de voorlopige bestandsnaam zijn bepaald, geef je in plaats daarvan filename door aan download.

Parameters

• callback

  functie

  De parameter callback ziet er zo uit:

  (downloadItem: DownloadItem, suggest: function) => void

  • downloadItem

    DownloadItem

  • suggest

    functie

    De parameter suggest ziet er zo uit:

    (suggestion?: FilenameSuggestion) => void

    • suggestie

      FilenameSuggestion optioneel

onErased

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

Wordt geactiveerd met de downloadId als een download uit de geschiedenis wordt gewist.

Parameters

• callback

  functie

  De parameter callback ziet er zo uit:

  (downloadId: number) => void

  • downloadId

    getal