UploadTask interface

Reprezentuje proces przekazywania obiektu. Umożliwia monitorowanie i zarządzanie przesyłaniem.

Podpis:

export interface UploadTask 

Nieruchomości

Nieruchomość	Typ	Opis
migawka	Prześlij migawkę zadania	Migawka bieżącego stanu zadania.

Metody

metoda	Opis
anulować()	Anuluje uruchomione zadanie. Nie ma wpływu na ukończone lub nieukończone zadanie.
catch(onRejected)	Odpowiednik wywołania then(null, onRejected) .
on(event, nextOrObserver, błąd, zakończone)	Nasłuchuje zdarzeń związanych z tym zadaniem. Zdarzenia mają trzy funkcje wywołania zwrotnego (określane jako next , error complete ). Jeśli tylko zdarzenie zostanie przekazane, zwracana jest funkcja, której można użyć do zarejestrowania wywołań zwrotnych. W przeciwnym razie wywołania zwrotne są przekazywane po zdarzeniu. Wywołania zwrotne mogą być przekazywane jako trzy oddzielne argumenty lub jako właściwości obiektu next , error complete . Każde z trzech wywołań zwrotnych jest opcjonalne, o ile określono co najmniej jedno. Ponadto, gdy dodasz swoje wywołania zwrotne, otrzymasz funkcję z powrotem. Możesz wywołać tę funkcję, aby wyrejestrować powiązane wywołania zwrotne.
pauza()	Wstrzymuje aktualnie uruchomione zadanie. Nie ma wpływu na zadanie wstrzymane lub zakończone niepowodzeniem.
wznawiać()	Wznawia wstrzymane zadanie. Nie ma wpływu na aktualnie uruchomione lub zakończone niepowodzeniem zadanie.
następnie(onSpełniony, onOdrzucony)	Obiekt ten zachowuje się jak obietnica i po zakończeniu przesyłania jest rozpoznawany na podstawie danych migawki.

Prześlij zrzut zadania

Migawka bieżącego stanu zadania.

Podpis:

snapshot: UploadTaskSnapshot;

Prześlij zadanie.cancel()

Anuluje uruchomione zadanie. Nie ma wpływu na ukończone lub nieukończone zadanie.

Podpis:

cancel(): boolean;

Zwroty:

wartość logiczna

Prawda, jeśli anulowanie miało wpływ.

PrześlijZadanie.catch()

Odpowiednik wywołania then(null, onRejected) .

Podpis:

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

Parametry

Parametr	Typ	Opis
onOdrzucony	(błąd: Błąd przechowywania ) => nieznane

Zwroty:

Obietnica<nieznana>

PrześlijZadanie.on()

Nasłuchuje zdarzeń związanych z tym zadaniem.

Zdarzenia mają trzy funkcje wywołania zwrotnego (określane jako next , error i complete ).

Jeśli tylko zdarzenie zostanie przekazane, zwracana jest funkcja, której można użyć do zarejestrowania wywołań zwrotnych. W przeciwnym razie wywołania zwrotne są przekazywane po zdarzeniu.

Wywołania zwrotne można przekazywać jako trzy oddzielne argumenty lub jako next , error i complete właściwości obiektu. Każde z trzech wywołań zwrotnych jest opcjonalne, o ile określono co najmniej jedno. Ponadto, gdy dodasz swoje wywołania zwrotne, otrzymasz funkcję z powrotem. Możesz wywołać tę funkcję, aby wyrejestrować powiązane wywołania zwrotne.

Podpis:

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

Parametry

Parametr	Typ	Opis
wydarzenie	ZadanieZdarzenie	Typ zdarzenia, którego należy nasłuchiwać.
nextOrObserver	Obserwator pamięci masowej < Prześlij migawkę zadania > | zero | ((migawka: UploadTaskSnapshot ) => nieznany)	next funkcja, która jest wywoływana dla każdego elementu strumienia zdarzeń lub obiektu obserwatora z niektórymi lub wszystkimi z tych trzech właściwości ( next , error , complete ).
błąd	((a: Błąd przechowywania ) => nieznany) | zero	Funkcja wywoływana z błędem StorageError , jeśli strumień zdarzeń zakończy się z powodu błędu.
kompletny	Wypisz się | zero

Zwroty:

Wypisz się | Subskrybuj < Prześlij migawkę zadania >

Jeśli zostanie przekazany tylko argument zdarzenia, zwraca funkcję, której możesz użyć do dodania wywołań zwrotnych (patrz przykłady powyżej). Jeśli przekazany zostanie więcej niż tylko argument zdarzenia, zwraca funkcję, którą możesz wywołać, aby wyrejestrować wywołania zwrotne.

Przykład 1

**Przekazuj wywołania zwrotne osobno lub w obiekcie.**

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

Przykład 2

**Każde oddzwonienie jest opcjonalne.**

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

Przykład 3

**Użyj zwróconej funkcji, aby usunąć wywołania zwrotne.**

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

PrześlijZadanie.pause()

Wstrzymuje aktualnie uruchomione zadanie. Nie ma wpływu na zadanie wstrzymane lub zakończone niepowodzeniem.

Podpis:

pause(): boolean;

Zwroty:

wartość logiczna

Prawda, jeśli operacja została zastosowana, fałsz, jeśli została zignorowana.

PrześlijZadanie.resume()

Wznawia wstrzymane zadanie. Nie ma wpływu na aktualnie uruchomione lub zakończone niepowodzeniem zadanie.

Podpis:

resume(): boolean;

Zwroty:

wartość logiczna

Prawda, jeśli operacja została zastosowana, fałsz, jeśli została zignorowana.

PrześlijZadanie.then()

Obiekt ten zachowuje się jak obietnica i po zakończeniu przesyłania jest rozpoznawany na podstawie danych migawki.

Podpis:

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

Parametry

Parametr	Typ	Opis
onSpełniony	((migawka: UploadTaskSnapshot ) => nieznany) | zero	Oddzwonienie dotyczące spełnienia. Łańcuch obietnic działa normalnie.
onOdrzucony	((błąd: StorageError ) => nieznany) | zero	Wywołanie zwrotne odrzucenia.

Zwroty:

Obietnica<nieznana>