chrome.downloads

Deze toestemming activeert een waarschuwing.

Beschrijving

Gebruik de chrome.downloads API om programmatisch downloads te starten, te volgen, te beheren en te zoeken.

Toestemmingen

downloads

Manifest

Om deze API te kunnen gebruiken, moet u de machtiging "downloads" in het extensiemanifest declareren.

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

Voorbeelden

Eenvoudige voorbeelden van het gebruik van de chrome.downloads API vindt u in de map examples/api/downloads . Voor andere voorbeelden en hulp bij het bekijken van de broncode, zie Voorbeelden .

Soorten

BooleanDelta

Eigenschappen

  • huidig

    boolean optioneel

  • vorig

    boolean optioneel

DangerType

Enum

"bestand"
De bestandsnaam van de download is verdacht.

"url"
Het is bekend dat de URL van de download schadelijk is.

"inhoud"
Het gedownloade bestand is aantoonbaar schadelijk.

"ongewoon"
De download-URL wordt niet vaak gedownload en kan gevaarlijk zijn.

"gastheer"
De download is afkomstig van een host die bekendstaat om het verspreiden van schadelijke binaire bestanden en is waarschijnlijk gevaarlijk.

"ongewenst"
De download is mogelijk ongewenst of onveilig. Deze kan bijvoorbeeld wijzigingen aanbrengen in de instellingen van uw browser of computer.

"veilig"
Het downloaden vormt geen bekend gevaar voor de computer van de gebruiker.

"geaccepteerd"
De gebruiker heeft de gevaarlijke download geaccepteerd.

"allowlistedByPolicy"
Bedrijfsgerelateerde waarden.

"asyncScanning"

"asyncLocalPasswordScanning"

"met wachtwoord beveiligd"

"blockedTooLarge"

"sensitiveContentWarning"

"sensitiveContentBlock"

"Deepscan mislukt"

"deepScannedSafe"

"diep gescand geopend gevaarlijk"

"promptForScanning"

"promptForLocalPasswordScanning"

"accountCompromise"

"blockedScanFailed"

"forceSaveToGdrive"
Te gebruiken met de Secure Enterprise Browser-extensie. Indien nodig blokkeert Chrome de download naar de harde schijf en downloadt het bestand direct naar Google Drive.

DoubleDelta

Eigenschappen

  • huidig

    nummer optioneel

  • vorig

    nummer optioneel

DownloadDelta

Eigenschappen

  • kanHervatten

    BooleanDelta optioneel

    De wijziging in canResume , indien van toepassing.

  • Gevaar

    StringDelta optioneel

    De verandering in danger , indien aanwezig.

  • eindtijd

    StringDelta optioneel

    De wijziging in endTime , indien van toepassing.

  • fout

    StringDelta optioneel

    De wijziging in error , indien aanwezig.

  • bestaat

    BooleanDelta optioneel

    De wijziging exists , indien aanwezig.

  • bestandsgrootte

    DoubleDelta optioneel

    De wijziging in fileSize , indien van toepassing.

  • bestandsnaam

    StringDelta optioneel

    De wijziging in filename , indien van toepassing.

  • finalUrl

    StringDelta optioneel

    Chrome 54+

    De wijziging in finalUrl , indien van toepassing.

  • id

    nummer

    De id van het DownloadItem dat is gewijzigd.

  • mime

    StringDelta optioneel

    De wijziging in mime , indien van toepassing.

  • pauzeerde

    BooleanDelta optioneel

    De wijziging is paused , indien van toepassing.

  • starttijd

    StringDelta optioneel

    De wijziging in startTime , indien van toepassing.

  • staat

    StringDelta optioneel

    De verandering van state , indien van toepassing.

  • totaal aantal bytes

    DoubleDelta optioneel

    De wijziging in totalBytes , indien aanwezig.

  • URL

    StringDelta optioneel

    De wijziging in url , indien van toepassing.

DownloadItem

Eigenschappen

  • doorExtensionId

    string optioneel

    De identificatiecode van de extensie die deze download heeft gestart, indien deze door een extensie is geïnitieerd. Deze code blijft ongewijzigd nadat deze is ingesteld.

  • doorExtensionName

    string optioneel

    De gelokaliseerde naam van de extensie die deze download heeft gestart, indien deze download door een extensie is geïnitieerd. Deze naam kan veranderen als de extensie van naam verandert of als de gebruiker zijn taalinstellingen wijzigt.

  • bytesReceived

    nummer

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

  • kanHervatten

    booleaans

    Dit is waar als de download bezig is en gepauzeerd, of anders als deze is onderbroken en kan worden hervat vanaf het punt waar deze werd onderbroken.

  • Gevaar

    Gevaartype

    Geeft aan of deze download als veilig wordt beschouwd of juist verdacht is.

  • eindtijd

    string optioneel

    Het tijdstip waarop de download eindigde, in ISO 8601-formaat. Kan direct 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 werd 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 schrijven van het bestand naar het bestandssysteem beginnen met FILE_ , en onderbrekingen die door de gebruiker zijn veroorzaakt, beginnen met USER_ .

  • geschatteEindtijd

    string optioneel

    Geschatte tijd waarop de download voltooid zal zijn, in ISO 8601-formaat. Kan direct 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 kan verouderd zijn, omdat Chrome niet automatisch controleert of bestanden verwijderd zijn. Roep ` search ()` aan om te controleren of het bestand nog bestaat. Als de controle is voltooid en het bestand is verwijderd, wordt een onChanged gebeurtenis geactiveerd. Houd er rekening mee dat search ()` niet wacht tot de controle is voltooid voordat de resultaten worden geretourneerd, waardoor de resultaten van search ()` mogelijk niet nauwkeurig de status van het bestandssysteem weergeven. search ()` kan zo vaak als nodig worden aangeroepen, maar controleert niet vaker dan eens per 10 seconden of een bestand nog bestaat.

  • bestandsgrootte

    nummer

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

  • bestandsnaam

    snaar

    Het absolute lokale pad.

  • finalUrl

    snaar

    Chrome 54+

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

  • id

    nummer

    Een identificatiecode die behouden blijft gedurende meerdere browsersessies.

  • incognito

    booleaans

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

  • mime

    snaar

    Het MIME-type van het bestand.

  • pauzeerde

    booleaans

    Dit is waar als het downloaden is gestopt met het lezen van gegevens van de host, maar de verbinding open is gebleven.

  • verwijzer

    snaar

    Absolute URL.

  • starttijd

    snaar

    Het tijdstip waarop de download begon, in ISO 8601-formaat. Kan direct worden doorgegeven aan de Date-constructor: chrome.downloads.search({}, function(items){items.forEach(function(item){console.log(new Date(item.startTime))})})

  • staat

    Staat

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

  • totaal aantal bytes

    nummer

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

  • URL

    snaar

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

DownloadOptions

Eigenschappen

  • lichaam

    string optioneel

    Berichtinhoud.

  • conflictActie

    FilenameConflictAction (optioneel)

    De actie die moet worden uitgevoerd als filename al bestaat.

  • bestandsnaam

    string optioneel

    Een bestandspad relatief ten opzichte van de map Downloads, dat het gedownloade bestand moet bevatten, eventueel inclusief submappen. Absolute paden, lege paden en paden met terugverwijzingen ".." veroorzaken een fout. onDeterminingFilename kan een bestandsnaam worden voorgesteld nadat het MIME-type en een voorlopige bestandsnaam zijn bepaald.

  • kopteksten

    HeaderNameValuePair [] optioneel

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

  • methode

    HttpMethode optioneel

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

  • opslaanAls

    boolean optioneel

    Gebruik een bestandsselector waarmee de gebruiker een bestandsnaam kan kiezen, ongeacht of filename al is ingesteld of bestaat.

  • URL

    snaar

    De URL om te downloaden.

DownloadQuery

Eigenschappen

  • bytesReceived

    nummer optioneel

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

  • Gevaar

    Gevaartype optioneel

    Geeft aan of deze download als veilig wordt beschouwd of juist verdacht is.

  • eindtijd

    string optioneel

    Het tijdstip waarop de download in ISO 8601-formaat is voltooid.

  • eindigdeNa

    string optioneel

    Beperkt de resultaten tot DownloadItem dat na de opgegeven milliseconden is voltooid in ISO 8601-formaat.

  • eindigde ervoor

    string optioneel

    Beperkt de resultaten tot DownloadItem dat is voltooid vóór de opgegeven milliseconden in ISO 8601-formaat.

  • fout

    InterruptReason (optioneel )

    Waarom een ​​download werd onderbroken.

  • bestaat

    boolean optioneel

    Of het gedownloade bestand bestaat;

  • bestandsgrootte

    nummer optioneel

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

  • bestandsnaam

    string optioneel

    Het absolute lokale pad.

  • bestandsnaamRegex

    string optioneel

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

  • finalUrl

    string optioneel

    Chrome 54+

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

  • finalUrlRegex

    string optioneel

    Chrome 54+

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

  • id

    nummer optioneel

    De id van het DownloadItem dat moet worden opgevraagd.

  • beperken

    nummer optioneel

    Het maximale aantal overeenkomende DownloadItem dat wordt geretourneerd. Standaard is dit 1000. Stel dit in op 0 om alle overeenkomende DownloadItem te retourneren. Zie search voor meer informatie over het bladeren door de resultaten.

  • mime

    string optioneel

    Het MIME-type van het bestand.

  • orderBy

    string[] optioneel

    Stel de elementen van deze array in als eigenschappen DownloadItem om de zoekresultaten te sorteren. Als u bijvoorbeeld orderBy=['startTime'] instelt, worden de DownloadItem gesorteerd op hun starttijd in oplopende volgorde. Om aflopende volgorde te specificeren, voegt u een koppelteken toe: '-startTime'.

  • pauzeerde

    boolean optioneel

    Dit is waar als het downloaden is gestopt met het lezen van gegevens van de host, maar de verbinding open is gebleven.

  • vraag

    string[] optioneel

    Deze reeks zoektermen beperkt de resultaten tot DownloadItem waarvan filename , url of finalUrl alle zoektermen bevat die niet met een streepje (-) beginnen, en geen van de zoektermen die wel met een streepje beginnen.

  • starttijd

    string optioneel

    Het tijdstip waarop de download in ISO 8601-formaat begon.

  • begonNa

    string optioneel

    Beperkt de resultaten tot DownloadItem dat is gestart na de opgegeven milliseconden in ISO 8601-formaat.

  • begonVoor

    string optioneel

    Beperkt de resultaten tot DownloadItem dat is gestart vóór de opgegeven milliseconden in ISO 8601-formaat.

  • staat

    Staat optioneel

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

  • totaal aantal bytes

    nummer optioneel

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

  • totaal aantal bytes groter

    nummer optioneel

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

  • totaal aantal bytes minder

    nummer optioneel

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

  • URL

    string optioneel

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

  • urlRegex

    string optioneel

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

FilenameConflictAction

uniek maken

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

overschrijven

Het bestaande bestand wordt overschreven met het nieuwe bestand.

snel

De gebruiker krijgt een dialoogvenster te zien waarin hij of zij een bestand kan selecteren.

Enum

"uniek maken"

"overschrijven"

"snel"

FilenameSuggestion

Eigenschappen

  • conflictActie

    FilenameConflictAction (optioneel)

    De actie die moet worden uitgevoerd als filename al bestaat.

  • bestandsnaam

    snaar

    Het nieuwe doel van de DownloadItem DownloadItem.filename , een pad relatief ten opzichte van de standaard Downloads-map van de gebruiker, dat mogelijk submappen bevat. Absolute paden, lege paden en paden met terugverwijzingen ".." worden genegeerd. filename wordt genegeerd als er onDeterminingFilename listeners zijn geregistreerd door extensies.

GetFileIconOptions

Eigenschappen

  • maat

    nummer optioneel

    De grootte van het geretourneerde pictogram. Het pictogram is vierkant met afmetingen * grootte in pixels. De standaard en grootste afmeting voor het pictogram is 32x32 pixels. Alleen de afmetingen 16 en 32 worden ondersteund. Het opgeven van een andere afmeting is een fout.

HeaderNameValuePair

Eigenschappen

  • naam

    snaar

    Naam van de HTTP-header.

  • waarde

    snaar

    Waarde van de HTTP-header.

HttpMethod

Enum

"KRIJGEN"

"NA"

InterruptReason

Enum

"BESTAND MISLUKT"

"BESTANDSTOEGANG GEWEIGERD"

"BESTAND_GEEN_SPATIE"

"BESTANDSNAAM_TE_LANG"

"BESTAND TE GROOT"

"BESTAND_VIRUS_GEÏNFECTEERD"

"BESTANDSVERZENDINGFOUT"

"BESTAND_GEBLOKKEERD"

"BESTANDSBEVEILIGING_MISLUKT"

"BESTAND TE KORT"

"BESTANDSHASH_KOMT NIET OVEREEN"

"BESTAND_HETZELFDE_ALS_BRON"

"NETWERK_MISLUKT"

"NETWERK_TIMEOUT"

"NETWERKVERBINDING VERBROKEN"

"NETWERKSERVER_UIT"

"NETWERK_ONGELDIGE_VERZOEK"

"SERVER_FAILED"

"SERVER_NO_RANGE"

"SERVER_BAD_CONTENT"

"SERVER_UNAUTHORIZED"

"SERVER_CERT_PROBLEEM"

"SERVER_VERBODEN"

"SERVER_ONBEREIKBAAR"

"SERVER_CONTENT_LENGTH_MISMATCH"

"SERVER_CROSS_ORIGIN_REDIRECT"

"GEBRUIKER_GEANNULEERD"

"GEBRUIKER_AFGESLOTEN"

"CRASH"

State

bezig

De download ontvangt momenteel gegevens van de server.

onderbroken

Er is een fout opgetreden waardoor de verbinding met de bestandshost is verbroken.

compleet

De download is succesvol voltooid.

Enum

"in_progress"

"onderbroken"

"compleet"

StringDelta

Eigenschappen

  • huidig

    string optioneel

  • vorig

    string optioneel

UiOptions

Chrome 105+

Eigenschappen

  • ingeschakeld

    booleaans

    De downloadinterface in- of uitschakelen.

Methoden

acceptDanger()

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

Vraag de gebruiker om een ​​gevaarlijke download te accepteren. Deze functie kan alleen worden aangeroepen vanuit een zichtbare context (tabblad, venster of pop-upvenster van een pagina/browseractie). Gevaarlijke downloads worden niet automatisch geaccepteerd. Als de download wordt geaccepteerd, wordt een onChanged gebeurtenis geactiveerd; anders gebeurt er niets. Wanneer alle gegevens in een tijdelijk bestand zijn geladen en de download niet gevaarlijk is of het gevaar is geaccepteerd, wordt het tijdelijke bestand hernoemd naar de gewenste bestandsnaam, verandert de state naar 'complete' en wordt de ` onChanged gebeurtenis geactiveerd.

Parameters

  • downloadId

    nummer

    De identificatiecode voor het DownloadItem .

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 96+

    Retourneert een Promise die wordt opgelost wanneer het dialoogvenster met de waarschuwing voor gevaar sluit.

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

cancel()

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

Een download annuleren. Wanneer callback wordt uitgevoerd, wordt de download geannuleerd, voltooid, onderbroken of bestaat deze niet meer.

Parameters

  • downloadId

    nummer

    De ID van de download die geannuleerd moet worden.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 96+

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

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

download()

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

Download een URL. Als de URL het HTTP[S]-protocol gebruikt, bevat het verzoek alle cookies die momenteel voor de hostnaam zijn ingesteld. Als zowel filename als saveAs zijn opgegeven, wordt het dialoogvenster 'Opslaan als' weergegeven, vooraf ingevuld met de opgegeven filename . Als de download succesvol is gestart, wordt callback aangeroepen met de downloadId van het nieuwe DownloadItem . Als er een fout is opgetreden tijdens het starten van de download, wordt callback aangeroepen met downloadId=undefined en bevat runtime.lastError een beschrijvende tekenreeks. De foutmeldingen zijn niet gegarandeerd achterwaarts compatibel tussen releases. Extensies mogen deze niet parseren.

Parameters

  • Wat je moet downloaden en hoe.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (downloadId: number) => void

    • downloadId

      nummer

Retourneert

  • Belofte<nummer>

    Chrome 96+

    Retourneert een Promise die wordt opgelost met de id van het nieuwe DownloadItem .

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

erase()

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

Verwijder het overeenkomende DownloadItem uit de geschiedenis zonder het gedownloade bestand te verwijderen. Een onErased gebeurtenis wordt geactiveerd voor elk DownloadItem dat overeenkomt met query , waarna callback wordt aangeroepen.

Parameters

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (erasedIds: number[]) => void

    • verwijderdeID's

      nummer[]

Retourneert

  • Promise<nummer[]>

    Chrome 96+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

getFileIcon()

Belofte
chrome.downloads.getFileIcon(
  downloadId: number,
  options?: GetFileIconOptions,
  callback?: function,
): Promise<string | undefined>

Haal een pictogram op voor de opgegeven download. Voor nieuwe downloads zijn bestandspictogrammen beschikbaar nadat de onCreated -gebeurtenis is ontvangen. De afbeelding die deze functie retourneert terwijl een download bezig is, kan verschillen van de afbeelding die wordt geretourneerd nadat de download is voltooid. Het ophalen van het pictogram gebeurt door het onderliggende besturingssysteem of de toolkit te raadplegen, afhankelijk van het platform. Het geretourneerde pictogram is daarom afhankelijk van een aantal factoren, waaronder de status van de download, het platform, geregistreerde bestandstypen en het visuele thema. Als er geen bestandspictogram kan worden bepaald, bevat runtime.lastError een foutmelding.

Parameters

  • downloadId

    nummer

    De identificatiecode voor de download.

  • opties

    GetFileIconOptions optioneel

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    (iconURL?: string) => void

    • icoonURL

      string optioneel

Retourneert

  • Promise<string | undefined>

    Chrome 96+

    Retourneert een Promise die wordt opgelost met een URL naar een afbeelding die de download vertegenwoordigt.

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

open()

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

Opent het gedownloade bestand nu als het DownloadItem voltooid is; anders retourneert het een fout via runtime.lastError . Deze methode vereist de machtiging "downloads.open" naast de machtiging "downloads" . Een onChanged gebeurtenis wordt geactiveerd wanneer het item voor de eerste keer wordt geopend. Deze methode kan alleen worden aangeroepen als reactie op een gebruikersactie.

Parameters

  • downloadId

    nummer

    De identificatiecode van het gedownloade bestand.

  • terugbelverzoek

    functie optioneel

    Chrome 123+

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 123+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

pause()

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

Pauzeer de download. Als het verzoek succesvol was, bevindt de download zich in een gepauzeerde status. Anders bevat runtime.lastError een foutmelding. Het verzoek zal mislukken als de download niet actief is.

Parameters

  • downloadId

    nummer

    De ID van de download die gepauzeerd moet worden.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 96+

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

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

removeFile()

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

Verwijder het gedownloade bestand indien het bestaat en de DownloadItem is voltooid; retourneer anders een fout via runtime.lastError .

Parameters

  • downloadId

    nummer

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 96+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

resume()

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

Een gepauzeerde download hervatten. Als het verzoek succesvol was, is de download bezig en niet gepauzeerd. Anders bevat runtime.lastError een foutmelding. Het verzoek mislukt als de download niet actief is.

Parameters

  • downloadId

    nummer

    De ID van de download die moet worden hervat.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

    Chrome 96+

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

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

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

Zoek naar DownloadItem . Stel query in op het lege object om alle DownloadItem op te halen. Om een ​​specifiek DownloadItem op te halen, stelt u alleen het id veld in. Om door een groot aantal items te bladeren, stelt u orderBy: ['-startTime'] in, stelt u limit in voor het aantal items per pagina en stelt u startedAfter in op de startTime van het laatste item op de laatste pagina.

Parameters

Retourneert

  • Belofte< DownloadItem []>

    Chrome 96+

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

setShelfEnabled()

Niet meer bruikbaar sinds Chrome versie 117.
 
chrome.downloads.setShelfEnabled(
  enabled: boolean,
): void

Gebruik in plaats daarvan setUiOptions .

Schakel de grijze plank onderaan elk venster dat aan het huidige browserprofiel is gekoppeld in of uit. De plank blijft uitgeschakeld zolang ten minste één extensie deze heeft uitgeschakeld. Het inschakelen van de plank terwijl ten minste één andere extensie deze heeft uitgeschakeld, resulteert in een foutmelding via runtime.lastError . Vereist de machtiging "downloads.shelf" naast de machtiging "downloads" .

Parameters

  • ingeschakeld

    booleaans

setUiOptions()

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

Wijzig de downloadinterface van elk venster dat is gekoppeld aan het huidige browserprofiel. Zolang ten minste één extensie UiOptions.enabled op false heeft ingesteld, blijft de downloadinterface verborgen. Als u UiOptions.enabled op true instelt terwijl ten minste één andere extensie deze heeft uitgeschakeld, wordt er een foutmelding via runtime.lastError geretourneerd. Vereist de machtiging "downloads.ui" naast de machtiging "downloads" .

Parameters

  • opties

    UiOptions

    Verpak een wijziging in de downloadinterface.

  • terugbelverzoek

    functie optioneel

    De callback parameter ziet er als volgt uit: 

    () => void

Retourneert

  • Promise<void>

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

    Promises worden alleen ondersteund voor Manifest V3 en later; voor andere platforms moeten callbacks worden gebruikt.

show()

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

Toon het gedownloade bestand in de map waarin het is opgeslagen in een bestandsbeheerder.

Parameters

  • downloadId

    nummer

    De identificatiecode van het gedownloade bestand.

showDefaultFolder()

chrome.downloads.showDefaultFolder(): void

Toon de standaardmap Downloads in een bestandsbeheerder.

Evenementen

onChanged

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

Wanneer een van de eigenschappen van een DownloadItem , met uitzondering bytesReceived en estimatedEndTime verandert, wordt deze gebeurtenis geactiveerd met de downloadId en een object dat de gewijzigde eigenschappen bevat.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    (downloadDelta: DownloadDelta) => void

onCreated

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

Deze gebeurtenis wordt geactiveerd met het DownloadItem -object wanneer een download start.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    (downloadItem: DownloadItem) => void

onDeterminingFilename

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

Tijdens het bepalen van de bestandsnaam krijgen extensies de mogelijkheid om de doelbestandsnaam DownloadItem.filename te overschrijven. Elke extensie mag niet meer dan één listener voor deze gebeurtenis registreren. 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 noch synchroon aanroept, noch true retourneert, wordt suggest automatisch aangeroepen. De DownloadItem wordt pas voltooid als alle listeners suggest hebben aangeroepen. Listeners kunnen suggest zonder argumenten aanroepen om de download de bestandsnaam downloadItem.filename te laten gebruiken, of een suggestion object aan suggest doorgeven 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 aan suggest doorgeeft. Om verwarring over welke extensie wint te voorkomen, moeten gebruikers geen extensies installeren die mogelijk conflicteren. Als de download wordt gestart door download en de doelbestandsnaam bekend is voordat het MIME-type en de voorlopige bestandsnaam zijn bepaald, geef dan filename door aan download .

Parameters

onErased

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

Wordt geactiveerd met de downloadId wanneer een download uit de geschiedenis wordt verwijderd.

Parameters

  • terugbelverzoek

    functie

    De callback parameter ziet er als volgt uit: 

    (downloadId: number) => void

    • downloadId

      nummer