UploadTask interface

Representa el proceso de carga de un objeto. Te permite supervisar y administrar la carga.

Firma:

export interface UploadTask

Propiedades

Propiedad Tipo Descripción
snapshot UploadTaskSnapshot. Una instantánea del estado actual de la tarea.

Métodos

Método Descripción
cancel(). Cancela una tarea en ejecución. No tiene efecto en una tarea completada o con errores.
catch(onRejected) Equivale a la llamada a then(null, onRejected).
on(event, nextOrObserver, error, complete) Detecta eventos en esta tarea.Los eventos tienen tres funciones de devolución de llamada (denominadas next, error y complete).Si solo se pasa el evento, se muestra una función que se puede usar para registrar las devoluciones de llamada. De lo contrario, las devoluciones de llamada se pasan después del evento.Las devoluciones de llamada se pueden pasar como tres argumentos separados o como las propiedades next, error y complete de un objeto. Cualquiera de las tres devoluciones de llamada es opcional, siempre que se especifique al menos uno. Además, cuando agregas las devoluciones de llamada, obtienes una función de vuelta. Puedes llamar a esta función para cancelar el registro de las devoluciones de llamada asociadas.
pause() Pausa una tarea que está en ejecución. No tiene efecto en una tarea detenida o con errores.
reanudar() Reanuda una tarea pausada. No tiene efecto en una tarea en ejecución o con errores.
then(onFulfill, on libros) Este objeto se comporta como una promesa y se resuelve con sus datos de instantáneas cuando se completa la carga.

UploadTask.snapshot

Una instantánea del estado actual de la tarea.

Firma:

snapshot: UploadTaskSnapshot;

UploadTask.cancel()

Cancela una tarea en ejecución. No tiene efecto en una tarea completada o con errores.

Firma:

cancel(): boolean;

Muestra:

booleano

Es verdadero si la cancelación tuvo algún efecto.

UploadTask.catch()

Equivale a llamar a then(null, onRejected).

Firma:

catch(onRejected: (error: StorageError) => unknown): Promise<unknown>;

Parámetros

Parámetro Tipo Descripción
onRechazado (error: StorageError) => Desconocida

Muestra:

Promesa<desconocida>

UploadTask.on()

Detecta eventos en esta tarea.

Los eventos tienen tres funciones de devolución de llamada (denominadas next, error y complete).

Si solo se pasa el evento, se muestra una función que puede usarse para registrar las devoluciones de llamada. De lo contrario, las devoluciones de llamada se pasan después del evento.

Las devoluciones de llamada se pueden pasar como tres argumentos separados o como las propiedades next, error y complete de un objeto. Cualquiera de las tres devoluciones de llamada es opcional, siempre que se especifique al menos uno. Además, cuando agregas las devoluciones de llamada, obtienes una función de vuelta. Puedes llamar a esta función para cancelar el registro de las devoluciones de llamada asociadas.

Firma:

on(event: TaskEvent, nextOrObserver?: StorageObserver<UploadTaskSnapshot> | null | ((snapshot: UploadTaskSnapshot) => unknown), error?: ((a: StorageError) => unknown) | null, complete?: Unsubscribe | null): Unsubscribe | Subscribe<UploadTaskSnapshot>;

Parámetros

Parámetro Tipo Descripción
event TaskEvent. Es el tipo de evento que se debe escuchar:
nextOrObserver StorageObserver<UploadTaskSnapshot> | null | ((instantánea: UploadTaskSnapshot) => desconocido) La función next, a la que se llama para cada elemento del flujo de eventos, o un objeto observador con algunas de estas tres propiedades o todas (next, error, complete)
error ((a: StorageError) => desconocido) | nulo Una función a la que se llama con un StorageError si la transmisión del evento finaliza debido a un error.
complete Anular la suscripción | nulo

Muestra:

Anular la suscripción | Suscribirse<UploadTaskSnapshot>

Si solo se pasa el argumento del evento, muestra una función que puedes usar para agregar devoluciones de llamada (consulta los ejemplos anteriores). Si se pasa algo más que el argumento del evento, muestra una función a la que puedes llamar para cancelar el registro de las devoluciones de llamada.

Ejemplo 1

**Pasa devoluciones de llamada por separado o en un objeto.**

var next = function(snapshot) {};
var error = function(error) {};
var complete = function() {};

// The first example.
uploadTask.on(
    firebase.storage.TaskEvent.STATE_CHANGED,
    next,
    error,
    complete);

// This is equivalent to the first example.
uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED, {
  'next': next,
  'error': error,
  'complete': complete
});

// This is equivalent to the first example.
var subscribe = uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED);
subscribe(next, error, complete);

// This is equivalent to the first example.
var subscribe = uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED);
subscribe({
  'next': next,
  'error': error,
  'complete': complete
});

Ejemplo 2

**Cualquier devolución de llamada es opcional.**

// Just listening for completion, this is legal.
uploadTask.on(
    firebase.storage.TaskEvent.STATE_CHANGED,
    null,
    null,
    function() {
      console.log('upload complete!');
    });

// Just listening for progress/state changes, this is legal.
uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED, function(snapshot) {
  var percent = snapshot.bytesTransferred / snapshot.totalBytes * 100;
  console.log(percent + "% done");
});

// This is also legal.
uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED, {
  'complete': function() {
    console.log('upload complete!');
  }
});

Ejemplo 3

**Usa la función mostrada para quitar devoluciones de llamada.**

var unsubscribe = uploadTask.on(
    firebase.storage.TaskEvent.STATE_CHANGED,
    function(snapshot) {
      var percent = snapshot.bytesTransferred / snapshot.totalBytes * 100;
      console.log(percent + "% done");
      // Stop after receiving one update.
      unsubscribe();
    });

// This code is equivalent to the above.
var handle = uploadTask.on(firebase.storage.TaskEvent.STATE_CHANGED);
unsubscribe = handle(function(snapshot) {
  var percent = snapshot.bytesTransferred / snapshot.totalBytes * 100;
  console.log(percent + "% done");
  // Stop after receiving one update.
  unsubscribe();
});

UploadTask.pause()

Pausa una tarea que está en ejecución. No tiene efecto en una tarea detenida o con errores.

Firma:

pause(): boolean;

Muestra:

booleano

Es verdadero si la operación tiene efecto. Es falso si se ignora.

UploadTask.resume()

Reanuda una tarea pausada. No tiene efecto en una tarea en ejecución o con errores.

Firma:

resume(): boolean;

Muestra:

booleano

Es verdadero si la operación tiene efecto. Es falso si se ignora.

UploadTask.then()

Este objeto se comporta como una promesa y se resuelve con sus datos de instantáneas cuando se completa la carga.

Firma:

then(onFulfilled?: ((snapshot: UploadTaskSnapshot) => unknown) | null, onRejected?: ((error: StorageError) => unknown) | null): Promise<unknown>;

Parámetros

Parámetro Tipo Descripción
onFulfill ((instantánea: UploadTaskSnapshot) => desconocido) | nulo La devolución de llamada de entrega. El encadenamiento de promesas funciona con normalidad.
onRechazado ((error: StorageError) => desconocido) | nulo La devolución de llamada de rechazo.

Muestra:

Promesa<desconocida>