UploadTask interface

Rappresenta il processo di caricamento di un oggetto. Consente di monitorare e gestire il caricamento.

Firma:

export interface UploadTask 

Proprietà

Proprietà Tipo Descrizione
istantanea Carica TaskSnapshot Un'istantanea dello stato attuale dell'attività.

Metodi

Metodo Descrizione
Annulla() Annulla un'attività in esecuzione. Non ha alcun effetto su un'attività completata o non riuscita.
catch(suRifiutato) Equivalente a chiamare then(null, onRejected) .
on(evento, nextOrObserver, errore, completo) Ascolta gli eventi su questa attività. Gli eventi hanno tre funzioni di callback (denominate next , error e complete ). Se viene passato solo l'evento, viene restituita una funzione che può essere utilizzata per registrare i callback. In caso contrario, le richiamate verranno passate dopo l'evento. I callback possono essere passati come tre argomenti separati o come proprietà next , error e complete di un oggetto. Uno qualsiasi dei tre callback è facoltativo, purché ne venga specificato almeno uno. Inoltre, quando aggiungi le tue richiamate, ottieni di nuovo una funzione. È possibile chiamare questa funzione per annullare la registrazione dei callback associati.
pausa() Mette in pausa un'attività attualmente in esecuzione. Non ha alcun effetto su un'attività in pausa o non riuscita.
riprendere() Riprende un'attività sospesa. Non ha alcun effetto su un'attività attualmente in esecuzione o non riuscita.
allora(onCompilato, onRifiutato) Questo oggetto si comporta come una promessa e si risolve con i dati dello snapshot al termine del caricamento.

UploadTask.istantanea

Un'istantanea dello stato attuale dell'attività.

Firma:

snapshot: UploadTaskSnapshot;

UploadTask.cancel()

Annulla un'attività in esecuzione. Non ha alcun effetto su un'attività completata o non riuscita.

Firma:

cancel(): boolean;

Ritorna:

booleano

Vero se l'annullamento ha avuto effetto.

CaricaTask.catch()

Equivalente a chiamare then(null, onRejected) .

Firma:

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

Parametri

Parametro Tipo Descrizione
onRifiutato (errore: Errore di archiviazione ) => sconosciuto

Ritorna:

Promesso<sconosciuto>

CaricaAttività.on()

Ascolta gli eventi su questa attività.

Gli eventi hanno tre funzioni di callback (denominate di next , error e complete ).

Se viene passato solo l'evento, viene restituita una funzione che può essere utilizzata per registrare i callback. In caso contrario, le richiamate verranno passate dopo l'evento.

I callback possono essere passati come tre argomenti separati o come next , error e le proprietà complete di un oggetto. Uno qualsiasi dei tre callback è facoltativo, purché ne venga specificato almeno uno. Inoltre, quando aggiungi le tue richiamate, ottieni di nuovo una funzione. È possibile chiamare questa funzione per annullare la registrazione dei callback associati.

Firma:

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

Parametri

Parametro Tipo Descrizione
evento TaskEvent Il tipo di evento da ascoltare.
nextOrObserver StorageObserver < CaricaTaskSnapshot > | nullo | ((istantanea: UploadTaskSnapshot ) => sconosciuto) La funzione next , che viene chiamata per ogni elemento nel flusso di eventi, o un oggetto osservatore con alcune o tutte queste tre proprietà ( next , error , complete ).
errore ((a: Errore di archiviazione ) => sconosciuto) | nullo Una funzione che viene chiamata con StorageError se il flusso di eventi termina a causa di un errore.
completare Cancellati | nullo

Ritorna:

Cancellati | sottoscrivi < CaricaTaskSnapshot >

Se viene passato solo l'argomento evento, restituisce una funzione che puoi utilizzare per aggiungere callback (vedi gli esempi sopra). Se viene passato più del semplice argomento evento, restituisce una funzione che puoi chiamare per annullare la registrazione dei callback.

Esempio 1

**Passa i callback separatamente o in un oggetto.**

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
});

Esempio 2

**Qualsiasi richiamata è facoltativa.**

// 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!');
  }
});

Esempio 3

**Utilizza la funzione restituita per rimuovere i callback.**

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();
});

CaricaAttività.pause()

Mette in pausa un'attività attualmente in esecuzione. Non ha alcun effetto su un'attività in pausa o non riuscita.

Firma:

pause(): boolean;

Ritorna:

booleano

Vero se l'operazione ha avuto effetto, falso se ignorata.

UploadTask.riprendi()

Riprende un'attività sospesa. Non ha alcun effetto su un'attività attualmente in esecuzione o non riuscita.

Firma:

resume(): boolean;

Ritorna:

booleano

Vero se l'operazione ha avuto effetto, falso se ignorata.

UploadTask.then()

Questo oggetto si comporta come una promessa e si risolve con i dati dello snapshot al termine del caricamento.

Firma:

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

Parametri

Parametro Tipo Descrizione
onCompletato ((istantanea: UploadTaskSnapshot ) => sconosciuto) | nullo Il callback di adempimento. Il concatenamento delle promesse funziona normalmente.
onRifiutato ((errore: Errore di archiviazione ) => sconosciuto) | nullo Il richiamo del rifiuto.

Ritorna:

Promesso<sconosciuto>