chrome.downloads

Descripción

Usa la API de chrome.downloads para iniciar, supervisar, manipular y buscar descargas de manera programática.

Permisos

downloads

Para usar esta API, debes declarar el permiso "downloads" en el manifiesto de extensión.

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

Ejemplos

Puedes encontrar ejemplos simples de cómo usar la API de chrome.downloads en examples/api/downloads. . Para ver otros ejemplos y ayuda para ver el código fuente, consulta Muestras.

Tipos

BooleanDelta

Propiedades

  • actual

    booleano opcional

  • anterior

    booleano opcional

DangerType

archivo

El nombre de archivo de la descarga es sospechoso.

url

Se sabe que la URL de la descarga es maliciosa.

contenido

Se sabe que el archivo descargado es malicioso.

poco común

La URL de descarga no se descarga con frecuencia y podría ser peligrosa.

host

La descarga provino de un host conocido por distribuir binarios maliciosos y probablemente sea peligrosa.

no deseado

La descarga es potencialmente no deseada o no segura. P.ej., podría hacer cambios en la configuración del navegador o la computadora.

seguro

La descarga no presenta ningún peligro conocido para la computadora del usuario.

aceptada

El usuario aceptó la descarga peligrosa.

Enum

“file”

"url"

“contenido”

“poco común”

“host”

“no deseado”

“seguro”

“aceptado”

"allowlistedByPolicy"

"asyncScanning"

"asyncLocalPasswordScanning"

"passwordProtected"

"blockTooLarge"

“sensitiveContentWarning”

"sensitiveContentBlock"

"deepScannedFailed"

"deepScannedSafe"

"deepSgenerated OpenedHidden"

"promptForScanning"

"promptForLocalPasswordScanning"

“accountCompromise”

"blockScanFailed"

DoubleDelta

Propiedades

  • actual

    número opcional

  • anterior

    número opcional

DownloadDelta

Propiedades

  • canResume

    BooleanDelta opcional

    El cambio en canResume, si corresponde

  • peligro

    StringDelta opcional

    El cambio en danger, si corresponde

  • endTime

    StringDelta opcional

    El cambio en endTime, si corresponde

  • error

    StringDelta opcional

    El cambio en error, si corresponde

  • existe

    BooleanDelta opcional

    El cambio en exists, si corresponde

  • fileSize

    DoubleDelta opcional

    El cambio en fileSize, si corresponde

  • filename

    StringDelta opcional

    El cambio en filename, si corresponde

  • finalUrl

    StringDelta opcional

    Chrome 54 y versiones posteriores

    El cambio en finalUrl, si corresponde

  • id

    número

    El id de DownloadItem que cambió.

  • mimo

    StringDelta opcional

    El cambio en mime, si corresponde

  • detenido

    BooleanDelta opcional

    El cambio en paused, si corresponde

  • startTime

    StringDelta opcional

    El cambio en startTime, si corresponde

  • state

    StringDelta opcional

    El cambio en state, si corresponde

  • totalBytes

    DoubleDelta opcional

    El cambio en totalBytes, si corresponde

  • url

    StringDelta opcional

    El cambio en url, si corresponde

DownloadItem

Propiedades

  • byExtensionId

    string opcional

    Es el identificador de la extensión que inició esta descarga si esta fue iniciada por una extensión. No cambia una vez que se establece.

  • byExtensionName

    string opcional

    Es el nombre localizado de la extensión que inició esta descarga si esta fue iniciada por una extensión. Puede variar si la extensión cambia de nombre o si el usuario cambia su configuración regional.

  • bytesReceived

    número

    Cantidad de bytes recibidos hasta el momento del host, sin considerar la compresión de archivos.

  • canResume

    boolean

    Es verdadero si la descarga está en curso y se detuvo, o si se interrumpe y se puede reanudar desde el punto en que se interrumpió.

  • peligro

    DangerType

    Indicios que indiquen si se considera que esta descarga es segura o sospechosa.

  • endTime

    string opcional

    Indica la hora en que finalizó la descarga, en formato ISO 8601. Se puede pasar directamente al constructor Date: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.endTime) console.log(new Date(item.endTime))})})

  • error

    InterruptReason opcional

    Por qué se interrumpió la descarga. Se pueden agrupar varios tipos de errores de HTTP debajo de uno de los que comienza con SERVER_. Los errores relacionados con la red comienzan con NETWORK_; los errores relacionados con el proceso de escritura del archivo en el sistema de archivos comienzan con FILE_, y las interrupciones iniciadas por el usuario comienzan con USER_.

  • estimatedEndTime

    string opcional

    Tiempo estimado en el que se completará la descarga en formato ISO 8601. Se puede pasar directamente al constructor Date: chrome.downloads.search({}, function(items){items.forEach(function(item){if (item.estimatedEndTime) console.log(new Date(item.estimatedEndTime))})})

  • existe

    boolean

    Si el archivo descargado aún existe Es posible que esta información esté desactualizada porque Chrome no vigila automáticamente la eliminación de archivos. Llama a search() para activar la verificación de la existencia del archivo. Cuando se complete la verificación de existencia, si se borró el archivo, se activará un evento onChanged. Ten en cuenta que search() no espera a que finalice la comprobación de existencia antes de mostrar resultados, por lo que es posible que los resultados de search() no reflejen con precisión el sistema de archivos. Además, se puede llamar a search() tantas veces como sea necesario, pero no verificará la existencia de un archivo con una frecuencia superior a una cada 10 segundos.

  • fileSize

    número

    Cantidad de bytes en todo el archivo después de la descompresión o -1 si se desconoce.

  • filename

    string

    Ruta local absoluta.

  • finalUrl

    string

    Chrome 54 y versiones posteriores

    Es la URL absoluta desde la que se realiza esta descarga, después de todos los redireccionamientos.

  • id

    número

    Un identificador que persiste en todas las sesiones del navegador.

  • incógnito

    boolean

    Falso si esta descarga se registra en el historial. Es verdadero si no se registra.

  • mimo

    string

    Es el tipo de MIME del archivo.

  • detenido

    boolean

    Es verdadero si la descarga dejó de leer datos del host, pero mantuvo la conexión abierta.

  • referente

    string

    URL absoluta.

  • startTime

    string

    Indica el momento en que comenzó la descarga en formato ISO 8601. Se puede pasar directamente al constructor Date: chrome.downloads.search({}, function(items){items.forEach(function(item){console.log(new Date(item.startTime))})})

  • state

    Estado

    Indica si la descarga está en progreso, si está interrumpida o si está completa.

  • totalBytes

    número

    Cantidad de bytes en el archivo completo, sin considerar la compresión del archivo o -1 si se desconoce.

  • url

    string

    Es la URL absoluta desde la que se inició esta descarga, antes de los redireccionamientos.

DownloadOptions

Propiedades

  • body

    string opcional

    Cuerpo de la entrada

  • conflictAction

    FilenameConflictAction opcional

    La acción que se debe realizar si filename ya existe.

  • filename

    string opcional

    Una ruta de acceso al archivo en relación con el directorio Descargas para contener el archivo descargado, que posiblemente contenga subdirectorios. Rutas de acceso absolutas, vacías y que contienen referencias inversas ".." causará un error. onDeterminingFilename permite sugerir un nombre de archivo después de determinar el tipo de MIME y el nombre de archivo provisional.

  • encabezados

    HeaderNameValuePair[] opcional

    Encabezados HTTP adicionales para enviar con la solicitud si la URL usa el protocolo HTTP[s]. Cada encabezado se representa como un diccionario que contiene las claves name y value o binaryValue, restringido a las que permite XMLHttpRequest.

  • method

    HttpMethod opcional

    El método HTTP que se debe usar si la URL usa el protocolo HTTP[S].

  • saveAs

    booleano opcional

    Usa un selector de archivos para permitir que el usuario seleccione un nombre de archivo independientemente de si se configuró filename o ya existe.

  • url

    string

    La URL que se descargará.

DownloadQuery

Propiedades

  • bytesReceived

    número opcional

    Cantidad de bytes recibidos hasta el momento del host, sin considerar la compresión de archivos.

  • peligro

    DangerType opcional

    Indicios que indiquen si se considera que esta descarga es segura o sospechosa.

  • endTime

    string opcional

    Indica la hora en que finalizó la descarga, en formato ISO 8601.

  • endedAfter

    string opcional

    Limita los resultados a DownloadItem que finalizaron después de los ms especificados en formato ISO 8601.

  • endedBefore

    string opcional

    Limita los resultados a DownloadItem que finalizaron antes de los ms especificados en formato ISO 8601.

  • error

    InterruptReason opcional

    Por qué se interrumpió una descarga.

  • existe

    booleano opcional

    Si el archivo descargado existe;

  • fileSize

    número opcional

    Cantidad de bytes en todo el archivo después de la descompresión o -1 si se desconoce.

  • filename

    string opcional

    Ruta local absoluta.

  • filenameRegex

    string opcional

    Limita los resultados a DownloadItem cuyo filename coincide con la expresión regular especificada.

  • finalUrl

    string opcional

    Chrome 54 y versiones posteriores

    Es la URL absoluta desde la que se realiza esta descarga, después de todos los redireccionamientos.

  • finalUrlRegex

    string opcional

    Chrome 54 y versiones posteriores

    Limita los resultados a DownloadItem cuyo finalUrl coincide con la expresión regular especificada.

  • id

    número opcional

    El id de DownloadItem que se consultará.

  • límite

    número opcional

    La cantidad máxima de DownloadItem coincidentes que se muestran. La configuración predeterminada es 1,000. Configúralo en 0 para mostrar todos los DownloadItem que coincidan. Consulta search para ver cómo desplazarse por los resultados.

  • mimo

    string opcional

    Es el tipo de MIME del archivo.

  • orderBy

    string[] opcional

    Establece elementos de este array en propiedades DownloadItem para ordenar los resultados de la búsqueda. Por ejemplo, cuando se configura orderBy=['startTime'], se ordena DownloadItem por la hora de inicio, en orden ascendente. Para especificar el orden descendente, usa un guion como prefijo: “-startTime”.

  • detenido

    booleano opcional

    Es verdadero si la descarga dejó de leer datos del host, pero mantuvo la conexión abierta.

  • consulta

    string[] opcional

    Este array de términos de búsqueda limita los resultados a DownloadItem cuyos filename, url o finalUrl contienen todos los términos de búsqueda que no comienzan con un guion "-". ni ninguno de los términos que empiezan con un guion.

  • startTime

    string opcional

    Indica el momento en que comenzó la descarga en formato ISO 8601.

  • startedAfter

    string opcional

    Limita los resultados a DownloadItem que comenzaron después de los ms determinados en formato ISO 8601.

  • startedBefore

    string opcional

    Limita los resultados a DownloadItem que comenzaron antes de los ms especificados en formato ISO 8601.

  • state

    Estado opcional

    Indica si la descarga está en progreso, si está interrumpida o si está completa.

  • totalBytes

    número opcional

    Cantidad de bytes en el archivo completo, sin considerar la compresión del archivo o -1 si se desconoce.

  • totalBytesGreater

    número opcional

    Limita los resultados a DownloadItem cuyo totalBytes es mayor que el número entero especificado.

  • totalBytesLess

    número opcional

    Limita los resultados a DownloadItem cuyo totalBytes es menor que el número entero especificado.

  • url

    string opcional

    Es la URL absoluta desde la que se inició esta descarga, antes de los redireccionamientos.

  • urlRegex

    string opcional

    Limita los resultados a DownloadItem cuyo url coincide con la expresión regular especificada.

FilenameConflictAction

uniquify

Para evitar la duplicación, se cambia filename para incluir un contador antes de la extensión del nombre de archivo.

reemplazar

El archivo existente se reemplazará por el nuevo.

mensaje

Se le mostrará al usuario un diálogo de selector de archivos.

Enum

“uniquify”

“overwrite”

“mensaje”

FilenameSuggestion

Propiedades

  • conflictAction

    FilenameConflictAction opcional

    La acción que se debe realizar si filename ya existe.

  • filename

    string

    El nuevo destino DownloadItem.filename de DownloadItem, como una ruta relativa al directorio de Descargas predeterminado del usuario, que posiblemente contenga subdirectorios. Rutas de acceso absolutas, vacías y que contienen referencias inversas ".." se ignorarán. filename se ignora si hay objetos de escucha onDeterminingFilename registrados por alguna extensión.

GetFileIconOptions

Propiedades

  • tamaño

    número opcional

    El tamaño del ícono que se muestra. El ícono será cuadrado, con las dimensiones del tamaño * el tamaño en píxeles. El tamaño predeterminado y más grande del ícono es de 32 x 32 píxeles. Los únicos tamaños admitidos son 16 y 32. Es un error especificar cualquier otro tamaño.

HeaderNameValuePair

Propiedades

  • nombre

    string

    El nombre del encabezado HTTP.

  • valor

    string

    El valor del encabezado HTTP.

HttpMethod

Enum

"GET"

"PUBLICAR"

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”

“BORRAR”

State

in_progress

En este momento, la descarga recibe datos del servidor.

interrumpido

Un error interrumpió la conexión con el host del archivo.

completo

La descarga se completó correctamente.

Enum

"in_progress"

“interrumpido”

"complete"

StringDelta

Propiedades

  • actual

    string opcional

  • anterior

    string opcional

UiOptions

Chrome 105 y versiones posteriores

Propiedades

  • habilitado

    boolean

    Habilita o inhabilita la IU para la descarga.

Métodos

acceptDanger()

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

Pídele al usuario que acepte una descarga peligrosa. Solo se puede llamar desde un contexto visible (pestaña, ventana o ventana emergente de acción en el navegador o la página). No acepta automáticamente descargas peligrosas. Si se acepta la descarga, se activará un evento onChanged. De lo contrario, no sucederá nada. Cuando todos los datos se recuperan a un archivo temporal y la descarga no es peligrosa o se acepta el peligro, se cambia el nombre del archivo temporal por el nombre de archivo de destino, state cambia a “completo” y se activa onChanged.

Parámetros

  • downloadId

    número

    Es el identificador de DownloadItem.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promesa<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El se resuelve con el mismo tipo que se pasa a la devolución de llamada.

cancel()

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

Cancela una descarga. Cuando se ejecuta callback, la descarga se cancela, se completa o se interrumpe, o ya no existe.

Parámetros

  • downloadId

    número

    Es el ID de la descarga que se cancelará.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promesa<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El se resuelve con el mismo tipo que se pasa a la devolución de llamada.

download()

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

Descarga una URL. Si la URL usa el protocolo HTTP[S], la solicitud incluirá todas las cookies configuradas actualmente para su nombre de host. Si se especifican filename y saveAs, se mostrará el diálogo Guardar como, prepropagado con el filename especificado. Si la descarga comenzó correctamente, se llamará a callback con el downloadId de DownloadItem nuevo. Si se produjo un error cuando se iniciaba la descarga, se llamará a callback con downloadId=undefined y runtime.lastError contendrá una cadena descriptiva. No se garantiza que las cadenas de error sean retrocompatibles entre versiones. Las extensiones no deben analizarlos.

Parámetros

  • opciones

    DownloadOptions

    Qué descargar y cómo

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (downloadId: number) => void

    • downloadId

      número

Muestra

  • Promise&lt;number&gt;

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El se resuelve con el mismo tipo que se pasa a la devolución de llamada.

erase()

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

Borra el DownloadItem que coincida del historial sin borrar el archivo descargado. Se activará un evento onErased por cada DownloadItem que coincida con query. Luego, se llamará a callback.

Parámetros

  • consulta

    DownloadQuery

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (erasedIds: number[]) => void

    • erasedIds

      número

Muestra

  • Promesa<número[]>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El se resuelve con el mismo tipo que se pasa a la devolución de llamada.

getFileIcon()

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

Recupera un ícono para la descarga especificada. En las descargas nuevas, los íconos de archivo estarán disponibles una vez que se haya recibido el evento onCreated. La imagen que muestra esta función mientras una descarga está en curso puede ser diferente de la imagen que se muestra una vez que se completa la descarga. La recuperación de íconos se realiza consultando el sistema operativo subyacente o el kit de herramientas según la plataforma. Por lo tanto, el ícono que se muestra dependerá de varios factores, incluidos el estado de la descarga, la plataforma, los tipos de archivos registrados y el tema visual. Si no se puede determinar un ícono de archivo, runtime.lastError contendrá un mensaje de error.

Parámetros

  • downloadId

    número

    Es el identificador de la descarga.

  • opciones

    GetFileIconOptions opcional

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    (iconURL?: string) => void

    • iconURL

      string opcional

Muestra

  • Promesa<string | indefinido>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El se resuelve con el mismo tipo que se pasa a la devolución de llamada.

open()

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

Ahora, se abrirá el archivo descargado si DownloadItem está completo. De lo contrario, muestra un error mediante runtime.lastError. Este método requiere el permiso "downloads.open", además del permiso "downloads". Se activa un evento onChanged cuando el elemento se abre por primera vez. Solo se puede llamar a este método en respuesta a un gesto del usuario.

Parámetros

  • downloadId

    número

    Es el identificador del archivo descargado.

  • callback

    función opcional

    Chrome 123 y versiones posteriores

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promesa<void>

    Chrome 123 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El se resuelve con el mismo tipo que se pasa a la devolución de llamada.

pause()

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

Pausa la descarga. Si la solicitud se realizó correctamente, la descarga se encuentra en estado de pausa. De lo contrario, runtime.lastError contiene un mensaje de error. La solicitud fallará si la descarga no está activa.

Parámetros

  • downloadId

    número

    Es el ID de la descarga que se pausará.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promesa<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El se resuelve con el mismo tipo que se pasa a la devolución de llamada.

removeFile()

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

Quita el archivo descargado si existe y si DownloadItem está completo. De lo contrario, mostrará un error mediante runtime.lastError.

Parámetros

  • downloadId

    número

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promesa<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El se resuelve con el mismo tipo que se pasa a la devolución de llamada.

resume()

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

Reanuda una descarga pausada. Si la solicitud se realiza correctamente, la descarga está en curso y se reanudó. De lo contrario, runtime.lastError contiene un mensaje de error. La solicitud fallará si la descarga no está activa.

Parámetros

  • downloadId

    número

    Es el ID de la descarga que se reanudará.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promesa<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El se resuelve con el mismo tipo que se pasa a la devolución de llamada.

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

Busca DownloadItem. Establece query en el objeto vacío para obtener todos los DownloadItem. Para obtener un DownloadItem específico, configura solo el campo id. Para desplazarte por una gran cantidad de elementos, configura orderBy: ['-startTime'], establece limit en la cantidad de elementos por página y startedAfter en el startTime del último elemento de la última página.

Parámetros

Muestra

  • Promise&lt;DownloadItem[]&gt;

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El se resuelve con el mismo tipo que se pasa a la devolución de llamada.

setShelfEnabled()

Obsoleto desde Chrome 117
chrome.downloads.setShelfEnabled(
  enabled: boolean,
)

En su lugar, usa setUiOptions.

Habilita o inhabilita la barra gris en la parte inferior de cada ventana asociada con el perfil actual del navegador. Se inhabilitará la biblioteca, siempre y cuando al menos una extensión la haya inhabilitado. Si habilitas la biblioteca mientras al menos otra extensión está inhabilitada, se mostrará un error hasta el runtime.lastError. Requiere el permiso "downloads.shelf", además del permiso "downloads".

Parámetros

  • habilitado

    boolean

setUiOptions()

Promesa Chrome 105 y versiones posteriores .
chrome.downloads.setUiOptions(
  options: UiOptions,
  callback?: function,
)

Cambia la IU de descarga de cada ventana asociada con el perfil actual del navegador. Si al menos una extensión estableció UiOptions.enabled como falsa, se ocultará la IU de descarga. Si estableces UiOptions.enabled como verdadera cuando al menos otra extensión esté inhabilitada, se mostrará un error hasta runtime.lastError. Requiere el permiso "downloads.ui", además del permiso "downloads".

Parámetros

  • opciones

    UiOptions

    Encapsula un cambio en la IU de descarga.

  • callback

    función opcional

    El parámetro callback se ve de la siguiente manera: 

    () => void

Muestra

  • Promesa<void>

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para retrocompatibilidad. No puedes usar ambos en la misma llamada a función. El se resuelve con el mismo tipo que se pasa a la devolución de llamada.

show()

chrome.downloads.show(
  downloadId: number,
)

Mostrará el archivo descargado en su carpeta en un administrador de archivos.

Parámetros

  • downloadId

    número

    Es el identificador del archivo descargado.

showDefaultFolder()

chrome.downloads.showDefaultFolder()

Mostrar la carpeta Descargas predeterminada en un administrador de archivos

Eventos

onChanged

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

Cuando cambia alguna de las propiedades de DownloadItem, excepto bytesReceived y estimatedEndTime, este evento se activa con downloadId y un objeto que contiene las propiedades que cambiaron.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (downloadDelta: DownloadDelta) => void

onCreated

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

Este evento se activa con el objeto DownloadItem cuando comienza una descarga.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (downloadItem: DownloadItem) => void

onDeterminingFilename

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

Durante el proceso de determinación del nombre de archivo, las extensiones tendrán la oportunidad de anular el DownloadItem.filename objetivo. Cada extensión no puede registrar más de un objeto de escucha para este evento. Cada objeto de escucha debe llamar a suggest exactamente una vez, ya sea de forma síncrona o asíncrona. Si el objeto de escucha llama a suggest de forma asíncrona, debe mostrar true. Si el objeto de escucha no llama a suggest de forma síncrona ni muestra true, se llamará automáticamente a suggest. DownloadItem no se completará hasta que todos los objetos de escucha llamen a suggest. Los objetos de escucha pueden llamar a suggest sin ningún argumento para permitir que la descarga use downloadItem.filename como nombre de archivo o pasar un objeto suggestion a suggest para anular el nombre de archivo de destino. Si más de una extensión anula el nombre de archivo, ganará la última extensión instalada cuyo objeto de escucha pase un objeto suggestion a suggest. Para evitar confusiones sobre qué extensión ganará, los usuarios no deben instalar extensiones que puedan entrar en conflicto. Si download inicia la descarga y se conoce el nombre del archivo de destino antes de que se determinen el tipo de MIME y el nombre de archivo provisional, pasa filename a download en su lugar.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

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

onErased

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

Se activa con el downloadId cuando se borra una descarga del historial.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (downloadId: number) => void

    • downloadId

      número