chrome.downloads

Descripción

Usa la API de chrome.downloads para iniciar, supervisar, manipular y buscar descargas de forma 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 del uso de la API de chrome.downloads en el directorio examples/api/downloads. Para ver otros ejemplos y obtener ayuda con la visualización del código fuente, consulta Muestras.

Tipos

BooleanDelta

Propiedades

  • actual

    booleano opcional

  • anterior

    booleano opcional

DangerType

en el archivo.

El nombre del 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 comunes

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

host

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

no deseado

La descarga es potencialmente no deseada o insegura. (p.ej., podría realizar cambios en la configuración del navegador o de 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"

"asyncScanning"

"asyncLocalPasswordScanning"

"passwordProtected"

"blockedTooLarge"

"sensitiveContentWarning"

"sensitiveContentBlock"

"promptForScanning"

"promptForLocalPasswordScanning"

"accountCompromise"

"blockedScanFailed"

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

    Es el id de los DownloadItem que cambiaron.

  • 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

    cadena opcional

    Es el identificador de la extensión que inició esta descarga si la inició una extensión. No cambia una vez que está configurado.

  • byExtensionName

    cadena opcional

    Es el nombre localizado de la extensión que inició esta descarga si la inició una extensión. Puede cambiar si la extensión cambia su 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 detenida, o bien si se interrumpe y puede reanudarse desde donde se interrumpió.

  • peligro

    DangerType

    Indicación de si se considera que esta descarga es segura o sospechosa.

  • endTime

    cadena opcional

    Indica la hora a la 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. Varios tipos de errores de HTTP se pueden agrupar bajo uno de los errores que comienzan 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 que inicia el usuario con USER_.

  • estimatedEndTime

    cadena 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 todavía existe el archivo descargado Es posible que esta información esté desactualizada porque Chrome no supervisa 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 verificación de existencia antes de mostrar resultados, por lo que es posible que los resultados de search() no reflejen con exactitud el sistema de archivos. Además, se puede llamar a search() con la frecuencia que sea necesaria, pero no verificará la existencia del archivo con una frecuencia superior a una cada 10 segundos.

  • fileSize

    número

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

  • filename

    cadena

    Ruta local absoluta.

  • finalUrl

    cadena

    Chrome 54 y versiones posteriores

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

  • id

    número

    Un identificador que es persistente 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

    cadena

    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.

  • referrer

    cadena

    URL absoluta.

  • startTime

    cadena

    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á progresando, interrumpida o completa.

  • totalBytes

    número

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

  • url

    cadena

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

DownloadOptions

Propiedades

  • body

    cadena opcional

    Cuerpo de la entrada.

  • conflictAction

    FilenameConflictAction opcional

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

  • filename

    cadena opcional

    Una ruta de archivo relativa al directorio Descargas para contener el archivo descargado, que posiblemente contenga subdirectorios. Las rutas de acceso absolutas, las rutas vacías y las que contienen referencias inversas “..” generarán un error. onDeterminingFilename permite sugerir un nombre de archivo después de que se hayan determinado el tipo de MIME y un nombre de archivo tentativo.

  • headers

    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, que se restringen a las que XMLHttpRequest permite.

  • method

    HttpMethod opcional

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

  • saveAs

    booleano opcional

    Usa un selector de archivos para permitir que el usuario seleccione un nombre de archivo sin importar si filename está configurado o ya existe.

  • url

    cadena

    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

    Indicación de si se considera que esta descarga es segura o sospechosa.

  • endTime

    cadena opcional

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

  • endedAfter

    cadena opcional

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

  • endedBefore

    cadena opcional

    Limita los resultados a DownloadItem que finalizaron antes del ms especificado 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 el archivo completo después de la descompresión, o -1 si se desconoce.

  • filename

    cadena opcional

    Ruta local absoluta.

  • filenameRegex

    cadena opcional

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

  • finalUrl

    cadena opcional

    Chrome 54 y versiones posteriores

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

  • finalUrlRegex

    cadena 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 los DownloadItem que se buscarán.

  • 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 desplazarte por los resultados.

  • mimo

    cadena opcional

    El tipo de MIME del archivo.

  • orderBy

    string[] opcional

    Establece los elementos de este array en las propiedades DownloadItem para ordenar los resultados de la búsqueda. Por ejemplo, si se configura orderBy=['startTime'], se ordenarán los DownloadItem por su 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.

  • búsqueda

    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 “-” y ninguno de ellos.

  • startTime

    cadena opcional

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

  • startedAfter

    cadena opcional

    Limita los resultados a DownloadItem que comenzó después del ms dado en formato ISO 8601.

  • startedBefore

    cadena opcional

    Limita los resultados a DownloadItem que comenzó antes del ms dado en formato ISO 8601.

  • state

    Estado opcional

    Indica si la descarga está progresando, interrumpida o completa.

  • totalBytes

    número opcional

    Cantidad de bytes en todo el archivo, 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 dado.

  • url

    cadena opcional

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

  • urlRegex

    cadena opcional

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

FilenameConflictAction

uniquify

A fin de evitar la duplicación, se modifica filename para incluir un contador antes de la extensión del nombre de archivo.

overwrite

El archivo existente se reemplazará por el nuevo.

mensaje

Se le mostrará un diálogo de selección de archivos al usuario.

Enum

FilenameSuggestion

Propiedades

  • conflictAction

    FilenameConflictAction opcional

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

  • filename

    cadena

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

GetFileIconOptions

Propiedades

  • tamaño

     opcional

    El tamaño del ícono que se muestra. El ícono será cuadrado y tendrá dimensiones de tamaño × píxeles de tamaño. 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. Especificar otro tamaño es un error.

HeaderNameValuePair

Propiedades

  • name

    cadena

    Nombre del encabezado HTTP.

  • value

    cadena

    Valor del encabezado HTTP.

HttpMethod

Enum

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_CERT_PROBLEM"

"SERVER_FORBIDDEN"

"SERVER_UNREACHABLE"

"SERVER_CONTENT_LENGTH_MISMATCH"

"SERVER_CROSS_ORIGIN_REDIRECT"

"USER_CANCELED"

State

in_progress

En este momento, la descarga está recibiendo datos del servidor.

interrumpido

Se produjo un error y se interrumpió la conexión con el host del archivo.

completo

La descarga se completó correctamente.

Enum

StringDelta

Propiedades

  • actual

    cadena opcional

  • anterior

    cadena opcional

UiOptions

Chrome 105 y versiones posteriores

Propiedades

  • habilitado

    boolean

    Habilita o inhabilita la IU de descarga.

Métodos

acceptDanger()

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

Solicita al usuario que acepte una descarga peligrosa. Solo se puede llamar desde un contexto visible (pestaña, ventana o ventana emergente de acción de página o navegador). No acepta automáticamente descargas peligrosas. Si se acepta la descarga, se activará un evento onChanged. De lo contrario, no sucederá nada. Cuando se recuperan todos los datos en un archivo temporal y la descarga no es peligrosa o se acepta el peligro, se cambia el nombre del archivo temporal por el nombre del archivo de destino, state cambia a "complete" 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

Devuelve

  • Promise<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa 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, se interrumpe o ya no existe.

Parámetros

  • downloadId

    número

    El ID de la descarga que se cancelará.

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa 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 el nombre de host. Si se especifican filename y saveAs, se mostrará el diálogo Guardar como, prepropagado con la filename especificada. Si la descarga comenzó correctamente, se llamará a callback con el downloadId del nuevo DownloadItem. Si se produjo un error mientras 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 las versiones. Las extensiones no deben analizarlo.

Parámetros

  • Opciones

    DownloadOptions

    Qué descargar y cómo hacerlo

  • callback

    Función opcional

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

    (downloadId: number)=>void

    • downloadId

      número

Devuelve

  • Promesa<number>

    Chrome 96 y versiones posteriores

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

erase()

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

Borrar los elementos DownloadItem que coincidan del historial sin borrar el archivo descargado. Se activará un evento onErased por cada DownloadItem que coincida con query y, luego, se llamará a callback.

Parámetros

  • búsqueda

    DownloadQuery

  • callback

    Función opcional

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

    (erasedIds: number[])=>void

    • erasedIds

      número

Devuelve

  • Promesa<number[]>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa 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 el caso de las descargas nuevas, los íconos de archivo están disponibles después de recibir el evento onCreated. La imagen que muestra esta función mientras se realiza una descarga puede ser diferente de la imagen que se muestra después de que se completa la descarga. La recuperación de íconos se realiza consultando el kit de herramientas o el sistema operativo subyacente, según la plataforma. Por lo tanto, el ícono que se muestre dependerá de varios factores, como el estado de la descarga, la plataforma, los tipos de archivo 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

      cadena opcional

Devuelve

  • Promesa<string|undefined>

    Chrome 96 y versiones posteriores

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

open()

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

Abre el archivo descargado ahora si DownloadItem está completo; de lo contrario, muestra un error a través de 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

Devuelve

  • Promise<void>

    Chrome 123 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa 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 se realizó correctamente la solicitud, 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

    El ID de la descarga que se pausará.

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa 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 la DownloadItem está completa; de lo contrario, muestra un error a través de runtime.lastError.

Parámetros

  • downloadId

    número

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa 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 realizó 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

    El ID de la descarga que se reanudará.

  • callback

    Función opcional

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

    ()=>void

Devuelve

  • Promise<void>

    Chrome 96 y versiones posteriores

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa 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, establece solo el campo id. Para desplazarte por una gran cantidad de elementos, establece orderBy: ['-startTime'], limit en la cantidad de elementos por página y startedAfter en startTime del último elemento de la última página.

Parámetros

Devuelve

  • Promise<DownloadItem[]>

    Chrome 96 y versiones posteriores

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

setShelfEnabled()

Obsoleta a partir de Chrome 117
chrome.downloads.setShelfEnabled(
  enabled: boolean,
)

En su lugar, usa setUiOptions.

Habilita o inhabilita la biblioteca gris en la parte inferior de todas las ventanas asociadas con el perfil del navegador actual. Se inhabilitará la biblioteca, siempre y cuando la haya inhabilitado al menos una extensión. Si habilitas la biblioteca mientras al menos una extensión más está inhabilitada, se mostrará un error a través de 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,
)

Cambiar la IU de descarga de cada ventana asociada con el perfil actual del navegador Siempre y cuando al menos una extensión configure UiOptions.enabled como falsa, se ocultará la IU de descarga. Si estableces UiOptions.enabled como verdadera mientras al menos una extensión más esté inhabilitada, se mostrará un error mediante 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

Devuelve

  • Promise<void>

    Las promesas son compatibles con Manifest V3 y versiones posteriores, pero se proporcionan devoluciones de llamada para brindar retrocompatibilidad. No puedes usar ambos en la misma llamada a función. La promesa 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 cualquiera de las propiedades de DownloadItem, excepto bytesReceived y estimatedEndTime, este evento se activa con el downloadId y un objeto que contiene las propiedades que cambiaron.

Parámetros

  • callback

    la 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

    la 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 de destino. 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á a suggest automáticamente. El DownloadItem no se completará hasta que todos los objetos de escucha llamen a suggest. Los objetos de escucha pueden llamar a suggest sin argumentos para permitir que la descarga use downloadItem.filename para su 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 tentativo, pasa filename a download en su lugar.

Parámetros

  • callback

    la 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

    la función

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

    (downloadId: number)=>void

    • downloadId

      número