UploadTask interface

Stellt den Prozess des Hochladens eines Objekts dar. Ermöglicht Ihnen, den Upload zu überwachen und zu verwalten.

Unterschrift:

export interface UploadTask 

Eigenschaften

Methoden

UploadTask.snapshot

Eine Momentaufnahme des aktuellen Aufgabenstatus.

Unterschrift:

snapshot: UploadTaskSnapshot;

UploadTask.cancel()

Bricht eine laufende Aufgabe ab. Hat keine Auswirkung auf eine abgeschlossene oder fehlgeschlagene Aufgabe.

Unterschrift:

cancel(): boolean;

Kehrt zurück:

Boolescher Wert

True, wenn der Abbruch eine Auswirkung hatte.

UploadTask.catch()

Entspricht dem Aufruf von then(null, onRejected) .

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<unbekannt>

UploadTask.on()

Hört auf Ereignisse für diese Aufgabe.

Ereignisse verfügen über drei Rückruffunktionen (im Folgenden als next bezeichnet). , error , und complete ).

Wenn nur das Ereignis übergeben wird, wird eine Funktion zurückgegeben, mit der die Rückrufe registriert werden können. Andernfalls werden die Rückrufe nach dem Ereignis übergeben.

Rückrufe können entweder als drei separate Argumente oder als next übergeben werden , error und complete Eigenschaften eines Objekts. Jeder der drei Rückrufe ist optional, sofern mindestens einer angegeben wird. Wenn Sie Ihre Rückrufe hinzufügen, erhalten Sie außerdem eine Funktion zurück. Sie können diese Funktion aufrufen, um die Registrierung der zugehörigen Rückrufe aufzuheben.

Unterschrift:

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

Parameter

Kehrt zurück:

Abmelden | Abonnieren < UploadTaskSnapshot >

Wenn nur das Ereignisargument übergeben wird, wird eine Funktion zurückgegeben, mit der Sie Rückrufe hinzufügen können (siehe Beispiele oben). Wenn mehr als nur das Ereignisargument übergeben wird, wird eine Funktion zurückgegeben, die Sie aufrufen können, um die Registrierung der Rückrufe aufzuheben.

Beispiel 1

**Rückrufe separat oder in einem Objekt übergeben.**

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

Beispiel 2

**Jeder Rückruf ist optional.**

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

Beispiel 3

**Verwenden Sie die zurückgegebene Funktion, um Rückrufe zu entfernen.**

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

Pausiert eine aktuell laufende Aufgabe. Hat keine Auswirkung auf eine angehaltene oder fehlgeschlagene Aufgabe.

Unterschrift:

pause(): boolean;

Kehrt zurück:

Boolescher Wert

True, wenn der Vorgang wirksam wurde, false, wenn er ignoriert wird.

UploadTask.resume()

Setzt eine angehaltene Aufgabe fort. Hat keine Auswirkung auf eine aktuell laufende oder fehlgeschlagene Aufgabe.

Unterschrift:

resume(): boolean;

Kehrt zurück:

Boolescher Wert

True, wenn der Vorgang wirksam wurde, false, wenn er ignoriert wird.

UploadTask.then()

Dieses Objekt verhält sich wie ein Promise und wird mit seinen Snapshot-Daten aufgelöst, wenn der Upload abgeschlossen ist.

Unterschrift:

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

Parameter

Kehrt zurück:

Versprechen<unbekannt>