chrome.downloads

Descrizione

Utilizza l'API chrome.downloads per avviare, monitorare, manipolare e cercare download in modo programmatico.

Autorizzazioni

downloads

Per utilizzare questa API, devi dichiarare l'autorizzazione "downloads" nel manifest dell'estensione.

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

Esempi

Puoi trovare semplici esempi di utilizzo dell'API chrome.downloads in examples/api/downloads . Per altri esempi e per assistenza nella visualizzazione del codice sorgente, consulta Esempi.

Tipi

BooleanDelta

Proprietà

  • attuale

    booleano facoltativo

  • indietro

    booleano facoltativo

DangerType

file

Il nome file del download è sospetto.

url

È noto che l'URL di download è dannoso.

contenuti

È noto che il file scaricato è dannoso.

insolito

L'URL di download non viene comunemente scaricato e potrebbe essere pericoloso.

host

Il download proviene da un host noto per la distribuzione di file binari dannosi e probabilmente è pericoloso.

indesiderato

Il download è potenzialmente indesiderato o non sicuro. Ad es. potresti apportare modifiche alle impostazioni del browser o del computer.

sicuro

Il download non presenta alcun pericolo noto per il computer dell'utente.

accettato

L'utente ha accettato il download pericoloso.

Enum

"file"

"url"

"contenuti"

"uncommon"

"host"

"unwanted"

"safe"

"accettato"

"allowlistedByPolicy"

"asyncScanning"

"asyncLocalPasswordScanning"

"passwordProtected"

"blockTooLarge"

"sensitiveContentWarning"

"sensitiveContentBlock"

"deepScannedFailed"

"deepScannedSafe"

"deepS CanaryOpened ossia di pericoloso"

"promptForScanning"

"promptForLocalPasswordScanning"

"Compromise"

"blockScanFailed"

DoubleDelta

Proprietà

  • attuale

    numero facoltativo

  • indietro

    numero facoltativo

DownloadDelta

Proprietà

  • canResume

    BooleanDelta facoltativo

    La modifica in canResume, se presente.

  • pericolo

    StringDelta facoltativo

    La modifica in danger, se presente.

  • endTime

    StringDelta facoltativo

    La modifica in endTime, se presente.

  • errore

    StringDelta facoltativo

    La modifica in error, se presente.

  • esiste

    BooleanDelta facoltativo

    La modifica in exists, se presente.

  • fileSize

    DoubleDelta facoltativo

    La modifica in fileSize, se presente.

  • nome file

    StringDelta facoltativo

    La modifica in filename, se presente.

  • finalUrl

    StringDelta facoltativo

    Chrome 54 e versioni successive .

    La modifica in finalUrl, se presente.

  • id

    numero

    Il id di DownloadItem che è cambiato.

  • mimo

    StringDelta facoltativo

    La modifica in mime, se presente.

  • in pausa

    BooleanDelta facoltativo

    La modifica in paused, se presente.

  • startTime

    StringDelta facoltativo

    La modifica in startTime, se presente.

  • stato

    StringDelta facoltativo

    La modifica in state, se presente.

  • totalBytes

    DoubleDelta facoltativo

    La modifica in totalBytes, se presente.

  • url

    StringDelta facoltativo

    La modifica in url, se presente.

DownloadItem

Proprietà

  • byExtensionId

    stringa facoltativo

    L'identificatore dell'estensione che ha avviato il download, se questo è stato avviato da un'estensione. Non cambia una volta impostato.

  • byExtensionName

    stringa facoltativo

    Il nome localizzato dell'estensione che ha avviato il download, se il download è stato avviato da un'estensione. Può cambiare se il nome dell'estensione cambia o se l'utente cambia le impostazioni internazionali.

  • bytesReceived

    numero

    Numero di byte ricevuti finora dall'host, senza considerare la compressione dei file.

  • canResume

    booleano

    True se il download è in corso ed è in pausa oppure se è stato interrotto e può essere ripreso a partire dal punto in cui lo era stato interrotto.

  • pericolo

    Indica se il download è ritenuto sicuro o noto come sospetto.

  • endTime

    stringa facoltativo

    L'ora di fine del download in formato ISO 8601. Può essere trasmesso direttamente al costruttore Date: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.endTime) console.log(new Date(item.endTime))})})

  • errore

    InterruptReason facoltativo

    Perché il download è stato interrotto. Diversi tipi di errori HTTP possono essere raggruppati in uno degli errori che inizia con SERVER_. Gli errori relativi alla rete iniziano con NETWORK_, gli errori relativi al processo di scrittura del file nel file system iniziano con FILE_ e le interruzioni avviate dall'utente iniziano con USER_.

  • estimatedEndTime

    stringa facoltativo

    Tempo stimato per il completamento del download in formato ISO 8601. Può essere trasmesso direttamente al costruttore Date: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.estimatedEndTime) console.log(new Date(item.estimatedEndTime))})})

  • esiste

    booleano

    Se il file scaricato esiste ancora. Queste informazioni potrebbero non essere aggiornate perché Chrome non controlla automaticamente la rimozione dei file. Chiama search() per attivare il controllo dell'esistenza del file. Al termine del controllo dell'esistenza, se il file è stato eliminato, viene attivato un evento onChanged. Tieni presente che search() non attende il completamento del controllo dell'esistenza prima di tornare, quindi i risultati di search() potrebbero non riflettere accuratamente il file system. Inoltre, la funzione search() può essere chiamata tutte le volte che è necessario, ma non verifica l'esistenza dei file più di una volta ogni 10 secondi.

  • fileSize

    numero

    Numero di byte nell'intero file dopo la decompressione o -1 se sconosciuto.

  • nome file

    stringa

    Percorso locale assoluto.

  • finalUrl

    stringa

    Chrome 54 e versioni successive .

    L'URL assoluto da cui viene eseguito il download, dopo tutti i reindirizzamenti.

  • id

    numero

    Un identificatore persistente tra le sessioni del browser.

  • in incognito

    booleano

    False se il download è registrato nella cronologia, true se non è registrato.

  • mimo

    stringa

    Il tipo MIME del file.

  • in pausa

    booleano

    True se il download ha smesso di leggere i dati dall'host, ma ha mantenuto la connessione aperta.

  • referrer

    stringa

    URL assoluto.

  • startTime

    stringa

    L'ora di inizio del download in formato ISO 8601. Può essere trasmesso direttamente al costruttore Date: chrome.downloads.search({}, function(items){items.forEach(function(item){console.log(new Date(item.startTime))})})

  • stato

    Indica se il download è in corso, interrotto o completato.

  • totalBytes

    numero

    Numero di byte nell'intero file, senza considerare la compressione, o -1 se sconosciuto.

  • url

    stringa

    L'URL assoluto da cui è stato avviato il download, prima di qualsiasi reindirizzamento.

DownloadOptions

Proprietà

  • corpo

    stringa facoltativo

    Corpo del post.

  • conflictAction

    L'azione da eseguire se filename esiste già.

  • nome file

    stringa facoltativo

    Un percorso file relativo alla directory Download in cui inserire il file scaricato, che potrebbe contenere sottodirectory. Percorsi assoluti, percorsi vuoti e percorsi contenenti riferimenti a ritroso ".." causerà un errore. onDeterminingFilename consente di suggerire un nome file dopo aver determinato il tipo MIME del file e un nome file provvisorio.

  • intestazioni

    HeaderNameValuePair[] facoltativo

    Intestazioni HTTP aggiuntive da inviare con la richiesta se l'URL utilizza il protocollo HTTP[s]. Ogni intestazione è rappresentata come un dizionario contenente le chiavi name e value o binaryValue, limitate a quelle consentite da XMLHttpRequest.

  • method

    HttpMethod facoltativo

    Il metodo HTTP da utilizzare se l'URL impiega il protocollo HTTP[S].

  • saveAs

    booleano facoltativo

    Utilizza un selettore file per consentire all'utente di selezionare un nome file, indipendentemente dal fatto che filename sia impostato o esista già.

  • url

    stringa

    L'URL da scaricare.

DownloadQuery

Proprietà

  • bytesReceived

    numero facoltativo

    Numero di byte ricevuti finora dall'host, senza considerare la compressione dei file.

  • pericolo

    DangerType facoltativo

    Indica se il download è ritenuto sicuro o noto come sospetto.

  • endTime

    stringa facoltativo

    L'ora di fine del download in formato ISO 8601.

  • endedAfter

    stringa facoltativo

    Limita i risultati a DownloadItem che sono terminati dopo i millisecondi specificati in formato ISO 8601

  • endedBefore

    stringa facoltativo

    Limita i risultati a DownloadItem terminati prima dei millisecondi specificati in formato ISO 8601.

  • errore

    InterruptReason facoltativo

    Perché un download è stato interrotto.

  • esiste

    booleano facoltativo

    Se il file scaricato esiste;

  • fileSize

    numero facoltativo

    Numero di byte nell'intero file dopo la decompressione o -1 se sconosciuto.

  • nome file

    stringa facoltativo

    Percorso locale assoluto.

  • filenameRegex

    stringa facoltativo

    Limita i risultati a DownloadItem i cui filename corrisponde all'espressione regolare specificata.

  • finalUrl

    stringa facoltativo

    Chrome 54 e versioni successive .

    L'URL assoluto da cui viene eseguito il download, dopo tutti i reindirizzamenti.

  • finalUrlRegex

    stringa facoltativo

    Chrome 54 e versioni successive .

    Limita i risultati a DownloadItem i cui finalUrl corrisponde all'espressione regolare specificata.

  • id

    numero facoltativo

    Il id di DownloadItem su cui eseguire la query.

  • limite

    numero facoltativo

    È stato restituito il numero massimo di DownloadItem corrispondenti. Il valore predefinito è 1000. Impostalo su 0 per restituire tutte le DownloadItem corrispondenti. Per informazioni su come sfogliare i risultati, consulta la pagina search.

  • mimo

    stringa facoltativo

    Il tipo MIME del file.

  • orderBy

    string[] facoltativo

    Imposta gli elementi di questo array sulle proprietà DownloadItem per ordinare i risultati di ricerca. Ad esempio, l'impostazione orderBy=['startTime'] consente di ordinare DownloadItem in base all'ora di inizio in ordine crescente. Per specificare l'ordine decrescente, inserisci il prefisso con un trattino: "-startTime".

  • in pausa

    booleano facoltativo

    True se il download ha smesso di leggere i dati dall'host, ma ha mantenuto la connessione aperta.

  • query

    string[] facoltativo

    Questo array di termini di ricerca limita i risultati a DownloadItem i cui filename, url o finalUrl contengono tutti i termini di ricerca che non iniziano con un trattino "-" e nessuno dei termini di ricerca che iniziano con un trattino.

  • startTime

    stringa facoltativo

    L'ora di inizio del download in formato ISO 8601.

  • startedAfter

    stringa facoltativo

    Limita i risultati a DownloadItem iniziati dopo i millisecondi specificati in formato ISO 8601.

  • startedBefore

    stringa facoltativo

    Limita i risultati a DownloadItem iniziati prima dei millisecondi specificati in formato ISO 8601.

  • stato

    Stato facoltativo

    Indica se il download è in corso, interrotto o completato.

  • totalBytes

    numero facoltativo

    Numero di byte nell'intero file, senza considerare la compressione, o -1 se sconosciuto.

  • totalBytesGreater

    numero facoltativo

    Limita i risultati a DownloadItem i cui totalBytes è maggiore del numero intero specificato.

  • totalBytesLess

    numero facoltativo

    Limita i risultati a DownloadItem i cui totalBytes è inferiore al numero intero specificato.

  • url

    stringa facoltativo

    L'URL assoluto da cui è stato avviato il download, prima di qualsiasi reindirizzamento.

  • urlRegex

    stringa facoltativo

    Limita i risultati a DownloadItem i cui url corrisponde all'espressione regolare specificata.

FilenameConflictAction

unico

Per evitare la duplicazione, filename viene modificato in modo da includere un contatore prima dell'estensione del nome file.

sovrascrivere

Il file esistente verrà sovrascritto con il nuovo file.

richiesta

All'utente verrà mostrata una finestra di dialogo del selettore file.

Enum

"uniquify"

"sovrascrittura"

"prompt"

FilenameSuggestion

Proprietà

  • conflictAction

    L'azione da eseguire se filename esiste già.

  • nome file

    stringa

    La nuova destinazione DownloadItem.filename di DownloadItem, come percorso relativo alla directory Download predefinita dell'utente, che potrebbe contenere sottodirectory. Percorsi assoluti, percorsi vuoti e percorsi contenenti riferimenti a ritroso ".." verrà ignorato. filename viene ignorato se sono presenti listener onDeterminingFilename registrati da qualsiasi estensione.

GetFileIconOptions

Proprietà

  • dimensioni

    numero facoltativo

    Le dimensioni dell'icona restituita. L'icona sarà quadrata, con dimensioni * dimensioni pixel. Le dimensioni predefinite e massime dell'icona sono 32 x 32 pixel. Le uniche dimensioni supportate sono 16 e 32. Specificare qualsiasi altra dimensione rappresenta un errore.

HeaderNameValuePair

Proprietà

  • nome

    stringa

    Nome dell'intestazione HTTP.

  • valore

    stringa

    Valore dell'intestazione HTTP.

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

Il download sta ricevendo dati dal server.

interrotto

Si è verificato un errore che ha interrotto la connessione con l'host del file.

completato

Download completato.

Enum

"in_progress"

"interrotto"

"completato"

StringDelta

Proprietà

  • attuale

    stringa facoltativo

  • indietro

    stringa facoltativo

UiOptions

Chrome 105 e versioni successive .

Proprietà

  • abilitata

    booleano

    Attiva o disattiva l'interfaccia utente di download.

Metodi

acceptDanger()

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

Chiedere all'utente di accettare un download pericoloso. Può essere chiamato solo da un contesto visibile (scheda, finestra o popup di azione pagina/browser). Non accetta automaticamente download pericolosi. Se il download viene accettato, viene attivato un evento onChanged, altrimenti non succederà nulla. Quando tutti i dati vengono recuperati in un file temporaneo e il download non è pericoloso o il pericolo è stato accettato, il file temporaneo viene rinominato con il nome file di destinazione, state diventa "completato" e si attiva onChanged.

Parametri

  • downloadId

    numero

    L'identificatore per DownloadItem.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto:

    () => void

Resi

  • Promesso<void>

    Chrome 96 e versioni successive .

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

cancel()

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

Annullare un download. Quando viene eseguito callback, il download viene annullato, completato, interrotto o non esiste più.

Parametri

  • downloadId

    numero

    L'ID del download da annullare.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto:

    () => void

Resi

  • Promesso<void>

    Chrome 96 e versioni successive .

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

download()

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

Scarica un URL. Se l'URL utilizza il protocollo HTTP[S], la richiesta includerà tutti i cookie attualmente impostati per il relativo nome host. Se filename e saveAs sono specificati, viene visualizzata la finestra di dialogo Salva con nome, precompilata con il filename specificato. Se il download viene avviato correttamente, callback verrà chiamato con il downloadId del nuovo DownloadItem. Se si è verificato un errore all'avvio del download, callback verrà chiamato con downloadId=undefined e runtime.lastError conterrà una stringa descrittiva. Non è garantito che le stringhe di errore rimangano compatibili con le versioni precedenti tra le release. Le estensioni non devono analizzarlo.

Parametri

  • opzioni

    Cosa scaricare e come.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto:

    (downloadId: number) => void

    • downloadId

      numero

Resi

  • Promise&lt;number&gt;

    Chrome 96 e versioni successive .

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

erase()

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

Cancella la DownloadItem corrispondente dalla cronologia senza eliminare il file scaricato. Verrà attivato un evento onErased per ogni DownloadItem che corrisponde a query, dopodiché verrà chiamato callback.

Parametri

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto:

    (erasedIds: number[]) => void

    • erasedIds

      numero[]

Resi

  • Prometti<numero[]>

    Chrome 96 e versioni successive .

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

getFileIcon()

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

Recupera un'icona per il download specificato. Per i nuovi download, le icone dei file sono disponibili dopo la ricezione dell'evento onCreated. L'immagine restituita da questa funzione mentre è in corso un download potrebbe essere diversa dall'immagine restituita al termine del download. Il recupero delle icone viene effettuato mediante una query sul sistema operativo o sul toolkit sottostante, a seconda della piattaforma. L'icona che viene restituita dipende quindi da una serie di fattori, tra cui lo stato del download, la piattaforma, i tipi di file registrati e il tema visivo. Se non è possibile determinare l'icona di un file, runtime.lastError conterrà un messaggio di errore.

Parametri

  • downloadId

    numero

    L'identificatore del download.

  • opzioni

    GetFileIconOptions facoltativo

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto:

    (iconURL?: string) => void

    • iconURL

      stringa facoltativo

Resi

  • Promesso<string | non definito>

    Chrome 96 e versioni successive .

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

open()

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

Apre il file scaricato ora se l'elemento DownloadItem è completo. In caso contrario, restituisce un errore tramite runtime.lastError. Questo metodo richiede l'autorizzazione "downloads.open" oltre all'autorizzazione "downloads". Un evento onChanged viene attivato quando l'elemento viene aperto per la prima volta. Questo metodo può essere chiamato soltanto in risposta a un gesto dell'utente.

Parametri

  • downloadId

    numero

    L'identificatore del file scaricato.

  • callback

    funzione facoltativa

    Chrome 123 e versioni successive .

    Il parametro callback ha il seguente aspetto:

    () => void

Resi

  • Promesso<void>

    Chrome 123 e versioni successive .

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

pause()

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

Metti in pausa il download. Se la richiesta ha esito positivo, il download è in stato di pausa. In caso contrario, runtime.lastError contiene un messaggio di errore. Se il download non è attivo, la richiesta avrà esito negativo.

Parametri

  • downloadId

    numero

    L'ID del download da mettere in pausa.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto:

    () => void

Resi

  • Promesso<void>

    Chrome 96 e versioni successive .

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

removeFile()

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

Rimuovi il file scaricato, se presente e che la DownloadItem è completa. in caso contrario restituiscono un errore tramite runtime.lastError.

Parametri

  • downloadId

    numero

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto:

    () => void

Resi

  • Promesso<void>

    Chrome 96 e versioni successive .

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

resume()

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

Riprendi un download sospeso. Se la richiesta ha esito positivo, il download è in corso e poi riattivato. In caso contrario, runtime.lastError contiene un messaggio di errore. Se il download non è attivo, la richiesta avrà esito negativo.

Parametri

  • downloadId

    numero

    L'ID del download da riprendere.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto:

    () => void

Resi

  • Promesso<void>

    Chrome 96 e versioni successive .

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

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

Trova DownloadItem. Imposta query sull'oggetto vuoto per ottenere tutti i valori DownloadItem. Per ottenere un elemento DownloadItem specifico, imposta solo il campo id. Per sfogliare un numero elevato di elementi, imposta orderBy: ['-startTime'], imposta limit sul numero di elementi per pagina e imposta startedAfter sul startTime dell'ultimo elemento dell'ultima pagina.

Parametri

Resi

  • Promise&lt;DownloadItem[]&gt;

    Chrome 96 e versioni successive .

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

setShelfEnabled()

Ritirato da Chrome 117
chrome.downloads.setShelfEnabled(
  enabled: boolean,
)

Usa invece setUiOptions.

Consente di attivare o disattivare la barra delle app grigia nella parte inferiore di ogni finestra associata al profilo del browser corrente. La sezione verrà disattivata se è stata disattivata da almeno un'estensione. Se attivi la barra delle app mentre è stata disattivata da almeno un'altra estensione, verrà restituito un errore fino a runtime.lastError. Richiede l'autorizzazione "downloads.shelf" oltre all'autorizzazione "downloads".

Parametri

  • abilitata

    booleano

setUiOptions()

Promesso Chrome 105 e versioni successive
chrome.downloads.setUiOptions(
  options: UiOptions,
  callback?: function,
)

Modifica l'interfaccia utente di download di ogni finestra associata al profilo del browser corrente. Se almeno un'estensione ha impostato UiOptions.enabled su false, la UI di download sarà nascosta. Se imposti UiOptions.enabled su true mentre è stata disattivata da almeno un'altra estensione, verrà restituito un errore tramite runtime.lastError. Richiede l'autorizzazione "downloads.ui" oltre all'autorizzazione "downloads".

Parametri

  • opzioni

    Integra una modifica alla UI di download.

  • callback

    funzione facoltativa

    Il parametro callback ha il seguente aspetto:

    () => void

Resi

  • Promesso<void>

    Le promesse sono supportate in Manifest V3 e versioni successive, ma sono disponibili callback per la compatibilità con le versioni precedenti. Non puoi utilizzare entrambi nella stessa chiamata di funzione. La si risolve con lo stesso tipo passato al callback.

show()

chrome.downloads.show(
  downloadId: number,
)

Mostra il file scaricato nella relativa cartella in un gestore di file.

Parametri

  • downloadId

    numero

    L'identificatore del file scaricato.

showDefaultFolder()

chrome.downloads.showDefaultFolder()

Mostra la cartella Download predefinita in un gestore di file.

Eventi

onChanged

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

Quando una delle proprietà di un elemento DownloadItem, ad eccezione di bytesReceived e estimatedEndTime, cambia, questo evento viene attivato con l'oggetto downloadId e un oggetto contenente le proprietà modificate.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto:

    (downloadDelta: DownloadDelta) => void

onCreated

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

Questo evento viene attivato con l'oggetto DownloadItem all'inizio di un download.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto:

    (downloadItem: DownloadItem) => void

onDeterminingFilename

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

Durante il processo di determinazione del nome file, le estensioni hanno l'opportunità di sostituire il valore DownloadItem.filename di destinazione. Ogni estensione non può registrare più di un listener per questo evento. Ogni listener deve chiamare suggest esattamente una volta, in modo sincrono o asincrono. Se il listener chiama suggest in modo asincrono, deve restituire true. Se il listener non chiama suggest in modo sincrono né restituisce true, suggest verrà chiamato automaticamente. DownloadItem non verrà completato finché tutti gli ascoltatori non avranno chiamato suggest. I listener possono chiamare suggest senza argomenti per consentire al download di utilizzare downloadItem.filename per il nome file oppure passare un oggetto suggestion a suggest per eseguire l'override del nome file di destinazione. Se più estensioni sostituiscono il nome file, vince l'ultima estensione installata il cui listener passa un oggetto suggestion a suggest. Per evitare confusione in merito all'estensione che vincerà, gli utenti non devono installare estensioni che potrebbero essere in conflitto. Se il download viene avviato da download e il nome file di destinazione è noto prima di aver determinato il tipo MIME e il nome file provvisorio, passa invece filename a download.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto:

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

onErased

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

Attiva con downloadId quando un download viene cancellato dalla cronologia.

Parametri

  • callback

    funzione

    Il parametro callback ha il seguente aspetto:

    (downloadId: number) => void

    • downloadId

      numero