UploadTask interface

Representa el proceso de carga de un objeto. Le permite monitorear y administrar la carga.

Firma:

export interface UploadTask 

Propiedades

Propiedad	Escribe	Descripción
instantánea	SubirTareaInstantánea	Una instantánea del estado actual de la tarea.

Métodos

Método	Descripción
cancelar()	Cancela una tarea en ejecución. No tiene efecto en una tarea completa o fallida.
catch(enRechazado)	Equivale a llamar a then(null, onRejected) .
on(evento, nextOrObserver, error, completo)	Escucha 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 devuelve 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 una. Además, cuando agrega sus devoluciones de llamada, obtiene una función de vuelta. Puede llamar a esta función para anular el registro de las devoluciones de llamada asociadas.
pausa()	Pausa una tarea que se está ejecutando actualmente. No tiene efecto en una tarea en pausa o fallida.
reanudar()	Reanuda una tarea en pausa. No tiene efecto en una tarea actualmente en ejecución o fallida.
entonces (onCompletado, onRechazado)	Este objeto se comporta como una Promesa y se resuelve con sus datos de instantánea cuando se completa la carga.

UploadTask.instantánea

Una instantánea del estado actual de la tarea.

Firma:

snapshot: UploadTaskSnapshot;

SubirTarea.cancel()

Cancela una tarea en ejecución. No tiene efecto en una tarea completa o fallida.

Firma:

cancel(): boolean;

Devoluciones:

booleano

Verdadero si la cancelación tuvo un efecto.

SubirTarea.catch()

Equivalente a llamar then(null, onRejected) .

Firma:

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

Parámetros

Parámetro	Escribe	Descripción
enRechazado	(error: error de almacenamiento ) => desconocido

Devoluciones:

Promesa <desconocido>

CargarTarea.on()

Escucha 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 devuelve 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 el next , error y propiedades complete de un objeto. Cualquiera de las tres devoluciones de llamada es opcional, siempre que se especifique al menos una. Además, cuando agrega sus devoluciones de llamada, obtiene una función de vuelta. Puede llamar a esta función para anular 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	Escribe	Descripción
evento	Evento de tarea	El tipo de evento a escuchar.
siguienteOrObserver	StorageObserver < SubirTareaInstantánea > | nulo | ((instantánea: UploadTaskSnapshot ) => desconocido)	La next función, que se llama para cada elemento en el flujo de eventos, o un objeto observador con algunas o todas estas tres propiedades ( next , error , complete ).
error	((a: error de almacenamiento ) => desconocido) | nulo	Una función a la que se llama con StorageError si el flujo de eventos finaliza debido a un error.
completo	Darse de baja | nulo

Devoluciones:

Darse de baja | Suscribir < SubirTareaInstantánea >

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

Ejemplo 1

**Pase las devoluciones de llamadas 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

**Utilice la función devuelta para eliminar las 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();
});

SubirTarea.pausa()

Pausa una tarea que se está ejecutando actualmente. No tiene efecto en una tarea en pausa o fallida.

Firma:

pause(): boolean;

Devoluciones:

booleano

Verdadero si la operación tuvo efecto, falso si se ignora.

CargarTarea.resume()

Reanuda una tarea en pausa. No tiene efecto en una tarea actualmente en ejecución o fallida.

Firma:

resume(): boolean;

Devoluciones:

booleano

Verdadero si la operación tuvo efecto, falso si se ignora.

CargarTarea.luego()

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

Firma:

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

Parámetros

Parámetro	Escribe	Descripción
el Cumplido	((instantánea: UploadTaskSnapshot ) => desconocido) | nulo	La devolución de llamada de cumplimiento. El encadenamiento de promesas funciona normalmente.
enRechazado	((error: error de almacenamiento ) => desconocido) | nulo	La devolución de llamada de rechazo.

Devoluciones:

Promesa <desconocido>