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
snapshot UploadTaskSnapshot. Um snapshot do estado atual da tarefa.

Métodos

Método Descrição
cancel() (link em inglês). Cancela uma tarefa em execução. Não tem efeito em uma tarefa concluída ou com falha.
catch(onRejeitar) É equivalente a chamar then(null, onRejected).
on(event, nextOrObserver, error, complete) Detecta eventos nesta tarefa.Os eventos têm três funções de callback (chamadas de next, error e complete).Se apenas o evento for transmitido, será retornada uma função que pode ser usada para registrar os callbacks. Caso contrário, os callbacks serão transmitidos depois do evento.Eles podem ser transmitidos como três argumentos separados ou como as propriedades next, error e complete de um objeto. Qualquer um dos três callbacks é opcional, desde que pelo menos um seja especificado. Além disso, ao adicionar os callbacks, você recebe uma função de volta. É possível chamar esta função para cancelar o registro dos callbacks associados.
pause(). Pausa uma tarefa em execução no momento. Não tem efeito em uma tarefa pausada ou com falha.
resume(). Retoma uma tarefa pausada. Não tem efeito sobre uma tarefa em execução ou com falha no momento.
then(onFulfilled, onDenied) Esse objeto se comporta como uma promessa e é resolvido com os dados de snapshot quando o upload é concluído.

UploadTask.snapshot

Um snapshot 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:

booleano

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
onRejeitar (erro: StorageError) => desconhecido

Retorna:

Promessa<desconhecida>

UploadTask.on()

Detecta eventos nesta tarefa.

Os eventos têm três funções de callback (chamadas de next, error e complete).

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

Callbacks podem ser transmitidos como três argumentos separados ou como as propriedades next, error e complete de um objeto. Qualquer um dos três callbacks é opcional, desde que pelo menos um seja especificado. Além disso, ao adicionar os callbacks, você recebe uma função de volta. É possível chamar esta função para cancelar o registro dos callbacks 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 TaskEvent (link em inglês) O tipo de evento a ser detectado.
nextOrObserver StorageObserver<UploadTaskSnapshot> | null | ((snapshot: UploadTaskSnapshot) => desconhecido) A função next, que é chamada para cada item no fluxo de eventos, ou um objeto observador com algumas ou todas essas três propriedades (next, error, complete).
error ((a: StorageError) => desconhecido) | nulo Uma função que será chamada com um StorageError se o stream de eventos terminar devido a um erro.
complete Cancelar inscrição | nulo

Retorna:

Cancelar inscrição | Inscreva-se<UploadTaskSnapshot>

Se apenas o argumento do evento for passado, retorna uma função que pode ser usada para adicionar callbacks (veja os exemplos acima). Se mais do que apenas o argumento do evento for transmitido, retornará uma função que pode ser chamada para cancelar o registro dos callbacks.

Exemplo 1

**Transmita callbacks 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 callback é 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 callbacks.**

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

Assinatura:

pause(): boolean;

Retorna:

booleano

Verdadeiro se a operação tiver entrado em vigor, falso se ignorado.

UploadTask.resume()

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

Assinatura:

resume(): boolean;

Retorna:

booleano

Verdadeiro se a operação tiver entrado em vigor, falso se ignorado.

UploadTask.then()

Esse objeto se comporta como uma promessa e é resolvido com os dados de snapshot 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
onFulfill ((snapshot: UploadTaskSnapshot) => desconhecido) | nulo O callback de fulfillment. O encadeamento de promessas funciona normalmente.
onRejeitar ((erro: StorageError) => desconhecido) | nulo O callback de rejeição.

Retorna:

Promessa<desconhecida>