UploadTask interface

Representa o processo de upload de um objeto. Permite monitorar e gerenciar o upload.

Assinatura:

export interface UploadTask 

Propriedades

Propriedade	Tipo	Descrição
instantâneo	UploadTaskSnapshot	Um instantâneo do estado atual da tarefa.

Métodos

Método	Descrição
cancelar()	Cancela uma tarefa em execução. Não tem efeito em uma tarefa concluída ou com falha.
pegar(onRejeitado)	Equivalente a chamar then(null, onRejected) .
on(evento, nextOrObserver, erro, completo)	Escuta eventos nesta tarefa. Os eventos têm três funções de retorno de chamada (conhecidas como next , error e complete ). Se apenas o evento for passado, será retornada uma função que pode ser usada para registrar os retornos de chamada. Caso contrário, os retornos de chamada serão passados ​​após o evento. Os retornos de chamada podem ser passados ​​como três argumentos separados ou como as propriedades next , error e complete de um objeto. Qualquer um dos três retornos de chamada é opcional, desde que pelo menos um seja especificado. Além disso, ao adicionar seus retornos de chamada, você recebe uma função de volta. Você pode chamar esta função para cancelar o registro dos retornos de chamada associados.
pausa()	Pausa uma tarefa atualmente em execução. Não tem efeito em uma tarefa pausada ou com falha.
retomar()	Retoma uma tarefa pausada. Não tem efeito em uma tarefa atualmente em execução ou com falha.
então(onFulfilled, onRejected)	Este objeto se comporta como uma promessa e é resolvido com seus dados de instantâneo quando o upload é concluído.

UploadTask.snapshot

Um instantâneo do estado atual da tarefa.

Assinatura:

snapshot: UploadTaskSnapshot;

UploadTask.cancel()

Cancela uma tarefa em execução. Não tem efeito em uma tarefa concluída ou com falha.

Assinatura:

cancel(): boolean;

Retorna:

boleano

Verdadeiro se o cancelamento tiver efeito.

UploadTask.catch()

Equivalente a chamar then(null, onRejected) .

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
onRejeitado	(erro: StorageError ) => desconhecido

Retorna:

Promessa<desconhecido>

UploadTask.on()

Escuta eventos nesta tarefa.

Os eventos têm três funções de retorno de chamada (referidas como next , error e complete ).

Se apenas o evento for passado, será retornada uma função que pode ser usada para registrar os retornos de chamada. Caso contrário, os retornos de chamada serão passados ​​após o evento.

Os retornos de chamada podem ser passados ​​como três argumentos separados ou como o next , error e propriedades complete de um objeto. Qualquer um dos três retornos de chamada é opcional, desde que pelo menos um seja especificado. Além disso, ao adicionar seus retornos de chamada, você recebe uma função de volta. Você pode chamar esta função para cancelar o registro dos retornos de chamada associados.

Assinatura:

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	Descrição
evento	Evento de Tarefa	O tipo de evento a ser ouvido.
próximoOrObserver	Observador de armazenamento < UploadTaskSnapshot > | nulo | ((instantâneo: UploadTaskSnapshot ) => desconhecido)	A next função, que é chamada para cada item no fluxo de eventos ou um objeto observador com algumas ou todas essas três propriedades ( next , error , complete ).
erro	((a: Erro de armazenamento ) => desconhecido) | nulo	Uma função que é chamada com um StorageError se o fluxo de eventos terminar devido a um erro.
completo	Cancelar inscrição | nulo

Retorna:

Cancelar inscrição | Se inscrever < UploadTaskSnapshot >

Se apenas o argumento do evento for passado, retorna uma função que você pode usar para adicionar retornos de chamada (veja os exemplos acima). Se mais do que apenas o argumento do evento for passado, retorna uma função que você pode chamar para cancelar o registro dos retornos de chamada.

Exemplo 1

**Passe retornos de chamada separadamente ou em um 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
});

Exemplo 2

**Qualquer retorno de chamada é 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!');
  }
});

Exemplo 3

**Use a função retornada para remover retornos de chamada.**

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 uma tarefa atualmente em execução. Não tem efeito em uma tarefa pausada ou com falha.

Assinatura:

pause(): boolean;

Retorna:

boleano

Verdadeiro se a operação tiver efeito, falso se ignorado.

UploadTask.resume()

Retoma uma tarefa pausada. Não tem efeito em uma tarefa atualmente em execução ou com falha.

Assinatura:

resume(): boolean;

Retorna:

boleano

Verdadeiro se a operação tiver efeito, falso se ignorado.

UploadTask.then()

Este objeto se comporta como uma promessa e é resolvido com seus dados de instantâneo quando o upload é concluído.

Assinatura:

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

Parâmetros

Parâmetro	Tipo	Descrição
onFulfilled	((instantâneo: UploadTaskSnapshot ) => desconhecido) | nulo	O retorno de chamada de cumprimento. O encadeamento de promessas funciona normalmente.
onRejeitado	((erro: StorageError ) => desconhecido) | nulo	O retorno de chamada de rejeição.

Retorna:

Promessa<desconhecido>