nsIDownloadManager

by 3 contributors:

Imagen:traduccion-pendiente.png Esta página está traduciéndose a partir del artículo nsIDownloadManager, razón por la cual puede haber algunos errores sintácticos o partes sin traducir. Puedes colaborar continuando con la traducción

El interfaz nsIDownloadManager permite a las aplicaciones y extensiones comunicarse con el Administrador de Descargas, añadiendo y quitando archivos a descargar, recolectando información sobre las descargas y siendo notificado cuando las descargas son finalizadas.


Please add a summary to this article.
  Last changed in Gecko 1.9 (Firefox 3)

Deriva desde: nsISupports

Implementado por: @mozilla.org/download-manager;1. Para crear una unidad, usa:

var dm = Components.classes["@mozilla.org/download-manager;1"]
                   .createInstance(Components.interfaces.nsIDownloadManager);

Descripción del método

nsIDownload addDownload(aDownloadType para abreviar, en nsIURI aSource, en nsIURI aTarget, en AString aDisplayName, en nsIMIMEInfo aMIMEInfo, en PRTime aStartTime, en nsILocalFile aTempFile, en nsICancelable aCancelable)
nsIDownload getDownload(in unsigned long aID)
void cancelDownload(in unsigned long aID)
void removeDownload(in unsigned long aID)
void pauseDownload(in unsigned long aID)
void resumeDownload(in unsigned long aID)
void retryDownload(in unsigned long aID)
void cleanUp()
void addListener(in nsIDownloadProgressListener aListener)
void removeListener(in nsIDownloadProgressListener aListener)

Atributos

Atributo Tipo Descripción
DBConnection mozIStorageConnection La conexión de la base de datos con la base de datos de descargas. Sólo lectura
canCleanUp boolean Si hay o no descargas que se pueden limpiar (quitar) p.e. descargas completadas, fallidas o canceladas. Sólo lectura
activeDownloadCount long Número de archivos actualmente siendo descargados. Sólo lectura
activeDownloads nsISimpleEnumerator Enumeración de los nsIDownloads activos. Sólo lectura
defaultDownloadsDirectory nsILocalFile Devuelve el directorio por defecto (dependiendo del SO) para las descargas. Sólo lectura
userDownloadsDirectory nsILocalFile Devuelve el directorio, configurado por el usuario, para las descargas. Sólo lecturaonly.

El path depende de dos configuraciones del usuario en las preferencias:

browser.download.folderList define la localización por defecto para los archivos:

  • 0: Los archivos se descargan en el Escritorio por defecto.
  • 1: Los archivos se descargan en el directorio especificado por el OS por defecto.
  • 2: Los archivos se descargan en el directorio local especificado por la preferencia browser.download.dir. Si esta preferencia es invalida, la descarga se realiza en el sitio por defecto.

Constantes

Constane Valor Descripción
DOWNLOAD_NOTSTARTED -1 La descarga no ha comenzado aún.
DOWNLOAD_DOWNLOADING 0 La descarga esta en proceso de ser descargada.
DOWNLOAD_FINISHED 1 La descarga ha terminado.
DOWNLOAD_FAILED 2 La descarga ha fallado.
DOWNLOAD_CANCELED 3 La descarga fue cancelada por el usuario.
DOWNLOAD_PAUSED 4 La descarga está actualmente en pausa.
DOWNLOAD_QUEUED 5 La descarga está en cola pero no está siendo descargada.
DOWNLOAD_BLOCKED 6 La descarga ha sido bloqueada, bien por un control paterno o el escáner de virus ha determinado que el archivo está infectado y no puede limpiarse.
DOWNLOAD_SCANNING 7 La descarga está siendo escaneada por la utilidad antivirus.
DOWNLOAD_TYPE_DOWNLOAD 0 ¿Qué es esto?

Métodos

addDownload()

Crea un nsIDownload y lo añade para ser manejado por el Administrador de descargas.

nsIDownload addDownload(
  in short aDownloadType, 
  in nsIURI aSource,
  in nsIURI aTarget,
  in AString aDisplayName,
  in nsIMIMEInfo aMIMEInfo,
  in PRTime aStartTime,
  in nsILocalFile aTempFile,
  in nsICancelable aCancelable
)
Parámetros
aDownloadType
El tipo de transferencia de descarga.
aSource
El inicio del URI de transferencia. No debe ser null.
aTarget
El destino del URI dónde debe guardarse la transferencia. No debe ser null.
aDisplayName
Una descripción de la transferencia, legible por el usuario. Puede ser una cadena vacía.
aMIMEInfo
La información MIME asociada con el objetivo. Esto puede incluir el tipo MIME y la aplicación de ayuda en caso necesario. Este parámetro es opcional.
startTime
La hora a la que empezó la descarga.
aTempFile
La localización del archivo temporal (un archivo temporal en el que guardar los datos recibidos, que no es igual que el archivo de destino). El archivo será movido a su localización definitiva indicada por aTarget cuando se complete la descarga. Esto puede ser null.
aCancelable
Un objeto que puede ser utilizado para abortar una descarga. No debe ser null.
Valor devuelto

El objeto recientemente creado con las propiedades dadas.

Nota: Agregar una descarga no comienza el proceso de transferencia. Si quieres que sea así, necsitas crear un objeto nsIWebBrowserPersist, llamar al método, poner el progressListener al objeto de descarga devuelto y entonces llamar al método saveURI().

getDownload()

Lee una descarga manejada por el administrador de descargas. La descarga puede estra en proceso, o haber terminado y estar almacenada en la base de datos.

nsIDownload getDownload(
  in unsigned long aID
)
Parámetros
aID
La ID única de la descarga.
Valor devuelto

TLa descarga con el ID único especificado.

Excepciones
NS_ERROR_NOT_AVAILABLE
La descarga no está en la base de datos.

cancelDownload()

Cancela la descarga que tiene el ID único especificado, si se encuentra en progreso. Esto llama a cancel(NS_BINDING_ABORTED) en el nsICancelable dado por la descarga.

 void cancelDownload(
   in unsigned long aID
 )
Parámetros
aID
El ID único de la descarga.
Excepciones
NS_ERROR_FAILURE
La descarga no está en progreso.

removeDownload()

Quita de la lista, la descarga con el ID único especificado, si ésta no está en progreso. Así como cancelDownload() simplemente cancela la transferencia mientras que la información de la descarga se mantiene, removeDownload() borra todos los datos pertenecientes a la descarga.

 void removeDownload(
   in unsigned long aID
 )
Parámetros
aID
La ID única de la descarga.
Excepciones
NS_ERROR_FAILURE
La descarga está activa (está en proceso de transferencia).

pauseDownload()

Pone la descarga especificada en pausa.

 void pauseDownload(
   in unsigned long aID
 )
Parámetros
aID
La ID única de la descarga a detener.
Excepciones
NS_ERROR_FAILURE
La descarga no está en proceso.

resumeDownload()

Reanuda la descarga especificada.

 void resumeDownload(
   in unsigned long aID
 )
Parámetros
aID
La ID única de la descarga a reanudar.
Excepciones
NS_ERROR_FAILURE
La descarga no está en progreso.

retryDownload()

Reintenta una descarga fallida.

 void retryDownload(
   in unsigned long aID
 )
Parámetros
aID
La ID única de la descarga.
Excepciones
NS_ERROR_NOT_AVAILALE
si la descarga es desconocida.

cleanUp()

Quita de la lista las descargas terminadas, fallidas y canceladas.

 void cleanUp()
Parámetros

Ninguno.

addListener()

Agrega una escucha al Administrador de Descargas.

 void addListener(
   in nsIDownloadProgressListener aListener
 )
Parámetros
aListener
El objeto nsIDownloadProgressListener que recibirá la información de estado desde el Administrador de Descargas.

removeListener()

Retira una escucha del Administrador de Descargas.

 void removeListener(
   in nsIDownloadProgressListener aListener
 )
Parámetros
aListener
El objeto nsIDownloadProgressListener dejará de escuchar al Administrador de Descargas.

Ver también

Etiquetas y colaboradores del documento

Contributors to this page: JZA, HenryGR, Wrongloop
Última actualización por: JZA,