UploadTask interface

Représente le processus de téléchargement d’un objet. Vous permet de surveiller et de gérer le téléchargement.

Signature:

export interface UploadTask 

Propriétés

Propriété	Taper	Description
instantané	TéléchargerTâcheInstantané	Un instantané de l'état actuel de la tâche.

Méthodes

Méthode	Description
Annuler()	Annule une tâche en cours d'exécution. N'a aucun effet sur une tâche terminée ou ayant échoué.
attraper (onRejected)	Équivaut à appeler then(null, onRejected) .
on (événement, nextOrObserver, erreur, terminé)	Écoute les événements sur cette tâche. Les événements ont trois fonctions de rappel (appelées next , error et complete ). Si seul l'événement est transmis, une fonction pouvant être utilisée pour enregistrer les rappels est renvoyée. Sinon, les rappels sont transmis après l'événement. Les rappels peuvent être transmis soit sous la forme de trois arguments distincts , soit sous la forme des propriétés next , error et complete d'un objet. L’un des trois rappels est facultatif, à condition qu’au moins un soit spécifié. De plus, lorsque vous ajoutez vos rappels, vous récupérez une fonction. Vous pouvez appeler cette fonction pour désenregistrer les rappels associés.
pause()	Met en pause une tâche en cours d'exécution. N'a aucun effet sur une tâche en pause ou en échec.
CV()	Reprend une tâche suspendue. N'a aucun effet sur une tâche en cours d'exécution ou ayant échoué.
puis (onFulfilled, onRejected)	Cet objet se comporte comme une promesse et se résout avec ses données d'instantané une fois le téléchargement terminé.

UploadTask.snapshot

Un instantané de l'état actuel de la tâche.

Signature:

snapshot: UploadTaskSnapshot;

UploadTask.cancel()

Annule une tâche en cours d'exécution. N'a aucun effet sur une tâche terminée ou ayant échoué.

Signature:

cancel(): boolean;

Retour:

booléen

Vrai si l'annulation a eu un effet.

UploadTask.catch()

Équivalent à appeler then(null, onRejected) .

Signature:

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

Paramètres

Paramètre	Taper	Description
surRejeté	(erreur : StorageError ) => inconnu

Retour:

Promesse<inconnu>

TéléchargerTask.on()

Écoute les événements sur cette tâche.

Les événements ont trois fonctions de rappel (appelées next , error , et complete ).

Si seul l'événement est transmis, une fonction pouvant être utilisée pour enregistrer les rappels est renvoyée. Sinon, les rappels sont transmis après l'événement.

Les rappels peuvent être transmis soit sous forme de trois arguments distincts , soit comme argument next , error et les propriétés complete d'un objet. L’un des trois rappels est facultatif, à condition qu’au moins un soit spécifié. De plus, lorsque vous ajoutez vos rappels, vous récupérez une fonction. Vous pouvez appeler cette fonction pour désenregistrer les rappels associés.

Signature:

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

Paramètres

Paramètre	Taper	Description
événement	Événement de tâche	Le type d’événement à écouter.
suivantOuObservateur	StockageObservateur < UploadTaskSnapshot > | nul | ((instantané : UploadTaskSnapshot ) => inconnu)	La fonction next , qui est appelée pour chaque élément du flux d'événements, ou un objet observateur avec tout ou partie de ces trois propriétés ( next , error , complete ).
erreur	((a : erreur de stockage ) => inconnu) | nul	Fonction qui est appelée avec StorageError si le flux d'événements se termine en raison d'une erreur.
complet	Se désabonner | nul

Retour:

Se désabonner | S'abonner < UploadTaskSnapshot >

Si seul l'argument event est passé, renvoie une fonction que vous pouvez utiliser pour ajouter des rappels (voir les exemples ci-dessus). Si plus que l'argument d'événement est passé, renvoie une fonction que vous pouvez appeler pour annuler l'enregistrement des rappels.

Exemple 1

**Transmettez les rappels séparément ou dans un objet.**

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

Exemple 2

**Tout rappel est facultatif.**

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

Exemple 3

**Utilisez la fonction renvoyée pour supprimer les rappels.**

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

Met en pause une tâche en cours d'exécution. N'a aucun effet sur une tâche en pause ou en échec.

Signature:

pause(): boolean;

Retour:

booléen

Vrai si l'opération a pris effet, faux si elle est ignorée.

UploadTask.resume()

Reprend une tâche suspendue. N'a aucun effet sur une tâche en cours d'exécution ou ayant échoué.

Signature:

resume(): boolean;

Retour:

booléen

Vrai si l'opération a pris effet, faux si elle est ignorée.

UploadTask.then()

Cet objet se comporte comme une promesse et se résout avec ses données d'instantané une fois le téléchargement terminé.

Signature:

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

Paramètres

Paramètre	Taper	Description
surRéalisé	((instantané : UploadTaskSnapshot ) => inconnu) | nul	Le rappel d’exécution. Le chaînage des promesses fonctionne normalement.
surRejeté	((erreur : StorageError ) => inconnu) | nul	Le rappel de rejet.

Retour:

Promesse<inconnu>