UploadTask interface

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

Firma:

export interface UploadTask 

Propiedades

Métodos

UploadTask.instantánea

Una instantánea del estado actual de la tarea.

Firma:

snapshot: UploadTaskSnapshot;

CargarTarea.cancelar()

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

Firma:

cancel(): boolean;

Devoluciones:

booleano

Verdadero si la cancelación tuvo efecto.

SubirTask.catch()

Equivalente a llamar then(null, onRejected) .

Firma:

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

Parámetros

Devoluciones:

Promesa<desconocida>

SubirTarea.on()

Escucha eventos en esta tarea.

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

Si solo se pasa el evento, se devuelve una función que se puede utilizar 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, recupera una función. Puede 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

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 cancelar el registro de las devoluciones de llamada.

Ejemplo 1

**Pasar 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

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

CargarTarea.pausa()

Pausa una tarea actualmente en ejecución. No tiene ningún efecto sobre una tarea pausada o fallida.

Firma:

pause(): boolean;

Devoluciones:

booleano

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

SubirTarea.resume()

Reanuda una tarea pausada. No tiene ningún efecto sobre una tarea actualmente en ejecución o fallida.

Firma:

resume(): boolean;

Devoluciones:

booleano

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

SubirTarea.luego()

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

Firma:

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

Parámetros

Devoluciones:

Promesa<desconocida>