Beschrijving
Gebruik de chrome.downloads
API om downloads programmatisch te initiëren, controleren, manipuleren en zoeken.
Machtigingen
downloads
U moet de machtiging "downloads"
in het extensiemanifest opgeven om deze API te kunnen gebruiken.
{
"name": "My extension",
...
"permissions": [
"downloads"
],
}
Voorbeelden
Eenvoudige voorbeelden van het gebruik van de chrome.downloads
API vindt u in de map example/api/downloads . Zie Voorbeelden voor andere voorbeelden en voor hulp bij het bekijken van de broncode.
Soorten
BooleanDelta
Eigenschappen
- huidig
Booleaans optioneel
- vorig
Booleaans optioneel
DangerType
bestand
De bestandsnaam van de download is verdacht.
URL
Het is bekend dat de download-URL schadelijk is.
inhoud
Het is bekend dat het gedownloade bestand schadelijk is.
ongewoon
De URL van de download wordt niet vaak gedownload en kan gevaarlijk zijn.
gastheer
De download kwam van een host waarvan bekend is dat hij kwaadaardige binaire bestanden verspreidt en is waarschijnlijk gevaarlijk.
ongewenst
De download is mogelijk ongewenst of onveilig. Het kan bijvoorbeeld wijzigingen aanbrengen in de browser- of computerinstellingen.
veilig
De download vormt geen bekend gevaar voor de computer van de gebruiker.
geaccepteerd
De gebruiker heeft de gevaarlijke download geaccepteerd.
Enum
"bestand" "url" "inhoud" "ongewoon" "gastheer" "ongewenst" "veilig" "geaccepteerd" "allowlistedbypolicy" "asynchronescannen" "asyncLocalPasswordScannen" "met wachtwoord beveiligd" "geblokkeerdTooLarge" "gevoeligeinhoudswaarschuwing" "gevoeligContentBlock" "deepScannedFailed" "deepScannedSafe" "diepGescandGeopendGevaarlijk" "promptForScannen" "promptForLocalPasswordScannen" "accountCompromis" "geblokkeerdScanmislukt"
DoubleDelta
Eigenschappen
- huidig
nummer optioneel
- vorig
nummer optioneel
DownloadDelta
Eigenschappen
- kan hervatten
Booleaanse Delta optioneel
De wijziging in
canResume
, indien aanwezig. - Gevaar
StringDelta optioneel
De eventuele verandering in
danger
. - eindTijd
StringDelta optioneel
De wijziging in
endTime
, indien aanwezig. - fout
StringDelta optioneel
De eventuele wijziging in
error
. - bestaat
Booleaanse Delta optioneel
De wijziging in
exists
, indien aanwezig. - bestandsgrootte
DoubleDelta optioneel
De wijziging in
fileSize
, indien aanwezig. - bestandsnaam
StringDelta optioneel
De eventuele wijziging in
filename
. - finaleUrl
StringDelta optioneel
Chroom 54+De wijziging in
finalUrl
, indien van toepassing. - Identiteitskaart
nummer
De
id
van hetDownloadItem
dat is gewijzigd. - mime
StringDelta optioneel
De eventuele verandering in
mime
. - gepauzeerd
Booleaanse Delta optioneel
De wijziging in
paused
, indien van toepassing. - startTijd
StringDelta optioneel
De wijziging in
startTime
, indien van toepassing. - staat
StringDelta optioneel
De eventuele
state
. - totaalBytes
DoubleDelta optioneel
De wijziging in
totalBytes
, indien aanwezig. - URL
StringDelta optioneel
De wijziging in
url
, indien van toepassing.
DownloadItem
Eigenschappen
- doorExtensionId
tekenreeks optioneel
De ID van de extensie die deze download heeft gestart als deze download is geïnitieerd door een extensie. Verandert niet als het eenmaal is ingesteld.
- doorExtensieNaam
tekenreeks optioneel
De gelokaliseerde naam van de extensie die deze download heeft gestart als deze download is geïnitieerd door een extensie. Kan veranderen als de extensie de naam verandert of als de gebruiker de landinstelling wijzigt.
- bytesOntvangen
nummer
Aantal bytes dat tot nu toe van de host is ontvangen, zonder rekening te houden met bestandscompressie.
- kan hervatten
Booleaans
Waar als de download bezig is en gepauzeerd is, of anders als deze wordt onderbroken en kan worden hervat vanaf het punt waarop deze werd onderbroken.
- Gevaar
Indicatie of deze download als veilig wordt beschouwd of als verdacht bekend staat.
- eindTijd
tekenreeks optioneel
Het tijdstip waarop de download eindigde in 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 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 metNETWORK_
, fouten met betrekking tot het proces van het schrijven van het bestand naar het bestandssysteem beginnen metFILE_
en onderbrekingen die door de gebruiker worden geïnitieerd, beginnen metUSER_
. - geschatteEndTime
tekenreeks optioneel
Geschatte tijd waarop de download voltooid zal zijn in 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 steeds bestaat. Deze informatie is mogelijk verouderd omdat Chrome niet automatisch let op het verwijderen van bestanden. Roep
search
() aan om de controle op het bestaan van bestanden te activeren. Wanneer de bestaanscontrole is voltooid en het bestand is verwijderd, wordt eenonChanged
gebeurtenis geactiveerd. Houd er rekening mee datsearch
() niet wacht tot de bestaanscontrole is voltooid voordat deze terugkeert, waardoor de resultaten vansearch
() mogelijk niet nauwkeurig het bestandssysteem weergeven. Ook kansearch
() zo vaak als nodig worden aangeroepen, maar zal niet vaker dan eens per 10 seconden controleren op het bestaan van bestanden. - bestandsgrootte
nummer
Aantal bytes in het gehele bestand na decompressie, of -1 indien onbekend.
- bestandsnaam
snaar
Absoluut lokaal pad.
- finaleUrl
snaar
Chroom 54+De absolute URL waarvandaan deze download wordt gemaakt, na alle omleidingen.
- Identiteitskaart
nummer
Een identificatie die persistent is in alle 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.
- gepauzeerd
Booleaans
Waar als de download is gestopt met het lezen van gegevens van de host, maar de verbinding open heeft gehouden.
- verwijzer
snaar
Absolute URL.
- startTijd
snaar
Het tijdstip waarop het downloaden begon in 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))})})
- staat
Geeft aan of de download vordert, wordt onderbroken of voltooid.
- totaalBytes
nummer
Aantal bytes in het hele bestand, zonder rekening te houden met bestandscompressie, of -1 indien onbekend.
- URL
snaar
De absolute URL waarvandaan deze download is gestart, vóór eventuele omleidingen.
DownloadOptions
Eigenschappen
- lichaam
tekenreeks optioneel
Postlichaam.
- conflictActie
BestandsnaamConflictAction optioneel
De actie die moet worden ondernomen als
filename
al bestaat. - bestandsnaam
tekenreeks optioneel
Een bestandspad relatief aan de map Downloads waarin het gedownloade bestand zich bevindt, mogelijk met submappen. Absolute paden, lege paden en paden die terugverwijzingen ".." bevatten, 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. - kopteksten
HeaderNameValuePair [] optioneel
Extra HTTP-headers om mee te sturen met het verzoek als de URL het HTTP[s]-protocol gebruikt. Elke header wordt weergegeven als een woordenboek met de
name
van de sleutel envalue
ofbinaryValue
, beperkt tot de waarden die zijn toegestaan door XMLHttpRequest. - methode
HttpMethode optioneel
De HTTP-methode die moet worden gebruikt als de URL het HTTP[S]-protocol gebruikt.
- opslaanAs
Booleaans optioneel
Gebruik een bestandskiezer zodat de gebruiker een bestandsnaam kan selecteren, ongeacht of
filename
is ingesteld of al bestaat. - URL
snaar
De URL die moet worden gedownload.
DownloadQuery
Eigenschappen
- bytesOntvangen
nummer optioneel
Aantal bytes dat tot nu toe van de host is ontvangen, zonder rekening te houden met bestandscompressie.
- Gevaar
DangerType optioneel
Indicatie of deze download als veilig wordt beschouwd of als verdacht bekend staat.
- eindTijd
tekenreeks optioneel
Het tijdstip waarop de download eindigde in ISO 8601-indeling.
- beëindigdNa
tekenreeks optioneel
Beperkt resultaten tot
DownloadItem
die zijn geëindigd na de opgegeven ms in ISO 8601-indeling - beëindigdVoor
tekenreeks optioneel
Beperkt resultaten tot
DownloadItem
die vóór de opgegeven ms zijn geëindigd in ISO 8601-indeling. - fout
InterruptReason optioneel
Waarom een download werd onderbroken.
- bestaat
Booleaans optioneel
Of het gedownloade bestand bestaat;
- bestandsgrootte
nummer optioneel
Aantal bytes in het gehele bestand na decompressie, of -1 indien onbekend.
- bestandsnaam
tekenreeks optioneel
Absoluut lokaal pad.
- bestandsnaamRegex
tekenreeks optioneel
Beperkt de resultaten tot
DownloadItem
waarvanfilename
overeenkomt met de opgegeven reguliere expressie. - finaleUrl
tekenreeks optioneel
Chroom 54+De absolute URL waarvandaan deze download wordt gemaakt, na alle omleidingen.
- finalUrlRegex
tekenreeks optioneel
Chroom 54+Beperkt de resultaten tot
DownloadItem
waarvan definalUrl
overeenkomt met de opgegeven reguliere expressie. - Identiteitskaart
nummer optioneel
De
id
van hetDownloadItem
dat moet worden opgevraagd. - beperken
nummer optioneel
Het maximale aantal overeenkomende
DownloadItem
dat is geretourneerd. Standaard ingesteld op 1000. Stel in op 0 om alle overeenkomendeDownloadItem
te retourneren. Ziesearch
voor informatie over het bladeren door resultaten. - mime
tekenreeks optioneel
Het MIME-type van het bestand.
- BestelDoor
tekenreeks[] optioneel
Stel elementen van deze array in op
DownloadItem
eigenschappen om de zoekresultaten te sorteren. Als u bijvoorbeeldorderBy=['startTime']
instelt, worden deDownloadItem
gesorteerd op starttijd in oplopende volgorde. Als u een aflopende volgorde wilt opgeven, plaatst u een koppelteken voor het voorvoegsel: '-startTime'. - gepauzeerd
Booleaans optioneel
Waar als de download is gestopt met het lezen van gegevens van de host, maar de verbinding open heeft gehouden.
- vraag
tekenreeks[] optioneel
Deze reeks zoektermen beperkt de resultaten tot
DownloadItem
waarvanfilename
ofurl
offinalUrl
alle zoektermen bevat die niet beginnen met een streepje '-' en geen van de zoektermen die wel beginnen met een streepje. - startTijd
tekenreeks optioneel
Het tijdstip waarop het downloaden begon in ISO 8601-indeling.
- begonna
tekenreeks optioneel
Beperkt de resultaten tot
DownloadItem
die zijn gestart na de opgegeven ms in ISO 8601-indeling. - begonVóór
tekenreeks optioneel
Beperkt resultaten tot
DownloadItem
die zijn gestart vóór de opgegeven ms in ISO 8601-indeling. - staat
Staat optioneel
Geeft aan of de download vordert, wordt onderbroken of voltooid.
- totaalBytes
nummer optioneel
Aantal bytes in het hele bestand, zonder rekening te houden met bestandscompressie, of -1 indien onbekend.
- totaalBytesGroter
nummer optioneel
Beperkt de resultaten tot
DownloadItem
waarvantotalBytes
groter is dan het opgegeven gehele getal. - totaalBytesLess
nummer optioneel
Beperkt de resultaten tot
DownloadItem
waarvantotalBytes
kleiner is dan het opgegeven gehele getal. - URL
tekenreeks optioneel
De absolute URL waarvandaan deze download is gestart, vóór eventuele omleidingen.
- urlRegex
tekenreeks optioneel
Beperkt de resultaten tot
DownloadItem
waarvanurl
overeenkomt met de opgegeven reguliere expressie.
FilenameConflictAction
verenigen
Om duplicatie te voorkomen, wordt de filename
gewijzigd door een teller vóór de bestandsnaamextensie op te nemen.
overschrijven
Het bestaande bestand wordt overschreven door het nieuwe bestand.
snel
De gebruiker krijgt een dialoogvenster met een bestandskiezer te zien.
Enum
"unificeren" "overschrijven" "snel"
FilenameSuggestion
Eigenschappen
- conflictActie
BestandsnaamConflictAction optioneel
De actie die moet worden ondernomen als
filename
al bestaat. - bestandsnaam
snaar
Het nieuwe doel
DownloadItem.filename
van hetDownloadItem
, als een pad relatief aan de standaard Downloads-map van de gebruiker, die mogelijk submappen bevat. Absolute paden, lege paden en paden die terugverwijzingen ".." bevatten, worden genegeerd.filename
wordt genegeerd als eronDeterminingFilename
listeners zijn geregistreerd door een extensie.
GetFileIconOptions
Eigenschappen
- maat
nummer optioneel
De grootte van het geretourneerde pictogram. Het pictogram is vierkant met de afmetingen maat * grootte pixels. Het standaard en grootste formaat voor het pictogram is 32x32 pixels. De enige ondersteunde maten zijn 16 en 32. Het is een fout om een andere maat op te geven.
HeaderNameValuePair
Eigenschappen
- naam
snaar
Naam van de HTTP-header.
- waarde
snaar
Waarde van de HTTP-header.
HttpMethod
Enum
"KRIJGEN" "NA"
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" "NETWERK_FAILED" "NETWORK_TIMEOUT" "NETWERK_DISCONNECTED" "NETWORK_SERVER_DOWN" "NETWORK_INVALID_REQUEST" "SERVER_FAILED" "SERVER_NO_RANGE" "SERVER_SLECHTE_CONTENT" "SERVER_UNAUHORIZED" "SERVER_CERT_PROBLEM" "SERVER_FORBIDDEN" "SERVER_UNBEREIKBAAR" "SERVER_CONTENT_LENGTH_MISMATCH" "SERVER_CROSS_ORIGIN_REDIRECT" "USER_CANCELED" "USER_SHUTDOWN" "CRASH"
State
in_voortgang
De download ontvangt momenteel gegevens van de server.
onderbroken
Door een fout is de verbinding met de bestandshost verbroken.
compleet
Het downloaden is succesvol voltooid.
Enum
"in_progress" "onderbroken" "compleet"
StringDelta
Eigenschappen
- huidig
tekenreeks optioneel
- vorig
tekenreeks optioneel
UiOptions
Eigenschappen
- ingeschakeld
Booleaans
Schakel de download-UI in of uit.
Methoden
acceptDanger()
chrome.downloads.acceptDanger(
downloadId: number,
callback?: function,
)
Vraag de gebruiker om een gevaarlijke download te accepteren. Kan alleen worden aangeroepen vanuit een zichtbare context (tabblad, venster of pop-up met pagina-/browseracties). Accepteert niet automatisch gevaarlijke downloads. Als de download wordt geaccepteerd, wordt een onChanged
gebeurtenis geactiveerd, anders gebeurt er niets. Wanneer alle gegevens in een tijdelijk bestand zijn opgehaald en de download niet gevaarlijk is of het gevaar is geaccepteerd, wordt het tijdelijke bestand hernoemd naar de doelbestandsnaam, verandert de state
in 'voltooid' en wordt onChanged
geactiveerd.
Parameters
- downloadID
nummer
De id voor het
DownloadItem
. - terugbellen
functie optioneel
De
callback
parameter ziet er als volgt uit:() => void
Retouren
Beloof <nietig>
Chroom 96+Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.
cancel()
chrome.downloads.cancel(
downloadId: number,
callback?: function,
)
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 moet worden geannuleerd.
- terugbellen
functie optioneel
De
callback
parameter ziet er als volgt uit:() => void
Retouren
Beloof <nietig>
Chroom 96+Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.
download()
chrome.downloads.download(
options: DownloadOptions,
callback?: function,
)
Download een URL. Als de URL het HTTP[S]-protocol gebruikt, bevat het verzoek alle cookies die momenteel zijn ingesteld voor de hostnaam. Als zowel filename
als saveAs
zijn opgegeven, wordt het dialoogvenster Opslaan als weergegeven, vooraf ingevuld met de opgegeven filename
. Als het downloaden succesvol is gestart, wordt callback
aangeroepen met de downloadId
van het 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. Het is niet gegarandeerd dat de foutreeksen achterwaarts compatibel blijven tussen releases. Extensies mogen het niet parseren.
Parameters
- opties
Wat te downloaden en hoe.
- terugbellen
functie optioneel
De
callback
parameter ziet er als volgt uit:(downloadId: number) => void
- downloadID
nummer
Retouren
Beloof<nummer>
Chroom 96+Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.
erase()
chrome.downloads.erase(
query: DownloadQuery,
callback?: function,
)
Wis overeenkomende DownloadItem
uit de geschiedenis zonder het gedownloade bestand te verwijderen. Er wordt een onErased
gebeurtenis geactiveerd voor elk DownloadItem
dat overeenkomt met query
, waarna er callback
wordt aangeroepen.
Parameters
- vraag
- terugbellen
functie optioneel
De
callback
parameter ziet er als volgt uit:(erasedIds: number[]) => void
- gewiste ID's
nummer[]
Retouren
Beloof<nummer[]>
Chroom 96+Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.
getFileIcon()
chrome.downloads.getFileIcon(
downloadId: number,
options?: GetFileIconOptions,
callback?: function,
)
Haal een pictogram op voor de opgegeven download. Voor nieuwe downloads zijn bestandspictogrammen beschikbaar nadat de onCreated
-gebeurtenis is ontvangen. De afbeelding die door deze functie wordt geretourneerd terwijl een download bezig is, kan afwijken van de afbeelding die wordt geretourneerd nadat de download is voltooid. Het ophalen van pictogrammen gebeurt door het onderliggende besturingssysteem of de toolkit te bevragen, afhankelijk van het platform. Het pictogram 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 er geen bestandspictogram kan worden bepaald, bevat runtime.lastError
een foutmelding.
Parameters
- downloadID
nummer
De ID voor de download.
- opties
GetFileIconOptions optioneel
- terugbellen
functie optioneel
De
callback
parameter ziet er als volgt uit:(iconURL?: string) => void
- iconURL
tekenreeks optioneel
Retouren
Belofte<tekenreeks | ongedefinieerd>
Chroom 96+Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.
open()
chrome.downloads.open(
downloadId: number,
callback?: function,
)
Opent nu het gedownloade bestand als het DownloadItem
voltooid is; retourneert anders een fout via runtime.lastError
. Deze methode vereist de toestemming "downloads.open"
naast de toestemming "downloads"
. Er wordt een onChanged
-gebeurtenis geactiveerd wanneer het item voor de eerste keer wordt geopend. Deze methode kan alleen worden aangeroepen als reactie op een gebruikersgebaar.
Parameters
- downloadID
nummer
De ID van het gedownloade bestand.
- terugbellen
functie optioneel
Chroom 123+De
callback
parameter ziet er als volgt uit:() => void
Retouren
Beloof <nietig>
Chroom 123+Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.
pause()
chrome.downloads.pause(
downloadId: number,
callback?: function,
)
Pauzeer het downloaden. Als het verzoek succesvol was, bevindt de download zich in een gepauzeerde status. 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 gepauzeerd.
- terugbellen
functie optioneel
De
callback
parameter ziet er als volgt uit:() => void
Retouren
Beloof <nietig>
Chroom 96+Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.
removeFile()
chrome.downloads.removeFile(
downloadId: number,
callback?: function,
)
Verwijder het gedownloade bestand als het bestaat en het DownloadItem
voltooid is; retourneer anders een fout via runtime.lastError
.
Parameters
- downloadID
nummer
- terugbellen
functie optioneel
De
callback
parameter ziet er als volgt uit:() => void
Retouren
Beloof <nietig>
Chroom 96+Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.
resume()
chrome.downloads.resume(
downloadId: number,
callback?: function,
)
Een onderbroken download hervatten. Als het verzoek succesvol was, wordt de download uitgevoerd en wordt deze niet meer onderbroken. 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.
- terugbellen
functie optioneel
De
callback
parameter ziet er als volgt uit:() => void
Retouren
Beloof <nietig>
Chroom 96+Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.
search()
chrome.downloads.search(
query: DownloadQuery,
callback?: function,
)
Zoek DownloadItem
. Stel query
in op het lege object om alle DownloadItem
op te halen. Om een specifiek DownloadItem
te krijgen, stelt u alleen het id
veld in. Als u door een groot aantal items wilt bladeren, stelt u orderBy: ['-startTime']
in, stelt u limit
in op het aantal items per pagina en stelt u startedAfter
in op de startTime
van het laatste item van de laatste pagina.
Parameters
- vraag
- terugbellen
functie optioneel
De
callback
parameter ziet er als volgt uit:(results: DownloadItem[]) => void
- resultaten
DownloadItem []
Retouren
Beloof < DownloadItem []>
Chroom 96+Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.
setShelfEnabled()
chrome.downloads.setShelfEnabled(
enabled: boolean,
)
Gebruik in plaats daarvan setUiOptions
.
Schakel de grijze plank onder aan elk venster dat aan het huidige browserprofiel is gekoppeld in of uit. De plank wordt uitgeschakeld zolang ten minste één extensie deze heeft uitgeschakeld. Als u de plank inschakelt terwijl ten minste één andere extensie deze heeft uitgeschakeld, wordt er een fout geretourneerd via runtime.lastError
. Vereist de toestemming "downloads.shelf"
naast de toestemming "downloads"
.
Parameters
- ingeschakeld
Booleaans
setUiOptions()
chrome.downloads.setUiOptions(
options: UiOptions,
callback?: function,
)
Wijzig de download-UI van elk venster dat aan het huidige browserprofiel is gekoppeld. Zolang ten minste één extensie UiOptions.enabled
op false heeft ingesteld, zal de download-UI verborgen zijn. Als u UiOptions.enabled
instelt op true terwijl ten minste één andere extensie is uitgeschakeld, wordt er een fout geretourneerd via runtime.lastError
. Vereist de toestemming "downloads.ui"
naast de toestemming "downloads"
.
Parameters
- opties
Een wijziging in de download-UI inkapselen.
- terugbellen
functie optioneel
De
callback
parameter ziet er als volgt uit:() => void
Retouren
Beloof <nietig>
Beloften worden ondersteund in Manifest V3 en hoger, maar er zijn callbacks beschikbaar voor achterwaartse compatibiliteit. U kunt niet beide gebruiken bij dezelfde functieaanroep. De belofte wordt opgelost met hetzelfde type dat wordt doorgegeven aan de callback.
show()
chrome.downloads.show(
downloadId: number,
)
Toon het gedownloade bestand in de map in bestandsbeheer.
Parameters
- downloadID
nummer
De ID van het gedownloade bestand.
showDefaultFolder()
chrome.downloads.showDefaultFolder()
Toon de standaardmap Downloads in bestandsbeheer.
Evenementen
onChanged
chrome.downloads.onChanged.addListener(
callback: function,
)
Wanneer een van de eigenschappen van een DownloadItem
behalve bytesReceived
en estimatedEndTime
verandert, wordt deze gebeurtenis geactiveerd met de downloadId
en een object met de gewijzigde eigenschappen.
Parameters
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(downloadDelta: DownloadDelta) => void
- downloadenDelta
onCreated
chrome.downloads.onCreated.addListener(
callback: function,
)
Deze gebeurtenis wordt geactiveerd met het DownloadItem
object wanneer een download begint.
Parameters
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(downloadItem: DownloadItem) => void
- downloadItem
onDeterminingFilename
chrome.downloads.onDeterminingFilename.addListener(
callback: function,
)
Tijdens het bepalen van de bestandsnaam krijgen extensies de mogelijkheid om het doel DownloadItem.filename
te overschrijven. Elke extensie mag niet meer dan één luisteraar voor deze gebeurtenis registreren. Elke luisteraar moet precies één keer suggest
aanroepen, synchroon of asynchroon. Als de luisteraaraanroepen asynchroon suggest
, moet deze true
retourneren. Als de luisteraar noch suggest
synchroon aanroept, noch true
retourneert, wordt suggest
automatisch aangeroepen. Het DownloadItem
wordt pas voltooid als alle luisteraars suggest
hebben aangeroepen. Luisteraars kunnen suggest
aanroepen zonder enige argumenten om de download downloadItem.filename
als bestandsnaam te laten gebruiken, of een suggestion
doorgeven om te suggest
om de doelbestandsnaam te overschrijven. Als meer dan één extensie de bestandsnaam overschrijft, wint de laatst geïnstalleerde extensie waarvan de luisteraar een suggestion
doorgeeft om suggest
. Om verwarring te voorkomen over welke extensie zal winnen, mogen gebruikers geen extensies installeren die mogelijk conflicten veroorzaken. Als het downloaden wordt gestart door download
en de doelbestandsnaam bekend is voordat het MIME-type en de voorlopige bestandsnaam zijn bepaald, geef dan filename
door om download
.
Parameters
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(downloadItem: DownloadItem, suggest: function) => void
- downloadItem
- voorstellen
functie
De
suggest
ziet er als volgt uit:(suggestion?: FilenameSuggestion) => void
- suggestie
Bestandsnaamsuggestie optioneel
onErased
chrome.downloads.onErased.addListener(
callback: function,
)
Wordt geactiveerd met de downloadId
wanneer een download uit de geschiedenis wordt gewist.
Parameters
- terugbellen
functie
De
callback
parameter ziet er als volgt uit:(downloadId: number) => void
- downloadID
nummer