UploadTask interface

Reprezentuje proces przesyłania obiektu. Umożliwia monitorowanie przesyłania i zarządzanie nim.

Podpis:

export interface UploadTask 

Właściwości

Właściwość	Typ	Opis
zrzut	UploadTaskSnapshot (Prześlij zrzut ekranu)	Zrzut bieżącego stanu zadania.

Metody

Metoda	Opis
cancel()	Anuluje uruchomione zadanie. Nie ma wpływu na ukończone ani nieudane zadanie.
catch(odrzucony)	Odpowiednik wywołania funkcji then(null, onRejected).
on(event, nextOrObserver, error, complete)	Nasłuchuje zdarzeń związanych z tym zadaniem.Zdarzenia mają 3 funkcje wywołania zwrotnego (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 3 osobne argumenty lub jako właściwości next, error i complete obiektu. Każde z 3 wywołań zwrotnych jest opcjonalne, o ile określono co najmniej jedno. Poza tym dodanie wywołań zwrotnych jest równoznaczne z odzyskaniem funkcji. Możesz ją wywołać, aby wyrejestrować powiązane wywołania zwrotne.
pause()	Wstrzymuje uruchomione zadanie. Nie ma wpływu na wstrzymane ani nieudane zadanie.
wznów()	Wznawia wstrzymane zadanie. Nie ma wpływu na aktualnie uruchomione ani nieudane zadanie.
then(onFulpełniony, onClosed)	Ten obiekt działa jak obiekt obietnicowy i po zakończeniu przesyłania rozwiązuje problem z danymi ze zrzutu.

UploadTask.zrzut

Zrzut bieżącego stanu zadania.

Podpis:

snapshot: UploadTaskSnapshot;

UploadTask.cancel()

Anuluje uruchomione zadanie. Nie ma wpływu na ukończone ani nieudane zadanie.

Podpis:

cancel(): boolean;

Zwroty:

wartość logiczna

Prawda, jeśli anulowanie przyniosło efekt.

UploadTask.catch()

Równoważne wywołaniu then(null, onRejected).

Podpis:

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

Parametry

Parametr	Typ	Opis
onOdrzucone	(Błąd: StorageError) => brak informacji

Zwroty:

Obietnica<nieznana>

UploadTask.on()

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

Zdarzenia mają 3 funkcje wywołania zwrotnego (nazywane next, error i complete).

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

Wywołania zwrotne mogą być przekazywane jako 3 osobne argumenty lub jako właściwości next, error i complete obiektu. Każde z 3 wywołań zwrotnych jest opcjonalne, o ile określono co najmniej jedno. Poza tym dodanie wywołań zwrotnych jest równoznaczne z odzyskaniem funkcji. Możesz ją wywołać, 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
event	TaskEvent	Typ nasłuchiwanego zdarzenia.
nextOrObserver	StorageObserver<UploadTaskSnapshot> – | null | ((zrzut: UploadTaskSnapshot) => nieznany)	Funkcja next, która jest wywoływana w przypadku każdego elementu w strumieniu zdarzeń, lub obiekt obserwatora z niektórymi bądź wszystkimi z tych 3 właściwości (next, error, complete).
błąd	((a: StorageError) => nieznany) | wartość null	Funkcja, która jest wywoływana z użyciem metody StorageError, jeśli strumień zdarzeń kończy się z powodu błędu.
zakończono	Anuluj subskrypcję | wartość null

Zwroty:

Anuluj subskrypcję | Subskrybuj<UploadTaskSnapshot>

Jeśli przekazano tylko argument zdarzenia, zwraca funkcję, której można użyć do dodawania wywołań zwrotnych (zobacz przykłady powyżej). Jeśli przekazanych jest więcej niż argument zdarzenia, zwraca funkcję, którą można wywołać w celu wyrejestrowania wywołań zwrotnych.

Przykład 1

**Przekazuj wywołania zwrotne oddzielnie 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 wywołanie zwrotne 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();
});

UploadTask.pause()

Wstrzymuje uruchomione zadanie. Nie ma wpływu na wstrzymane ani nieudane zadanie.

Podpis:

pause(): boolean;

Zwroty:

wartość logiczna

Wartość „prawda”, jeśli operacja odniosła skutek, lub „false”, jeśli została zignorowana.

UploadTask.resume()

Wznawia wstrzymane zadanie. Nie ma wpływu na aktualnie uruchomione ani nieudane zadanie.

Podpis:

resume(): boolean;

Zwroty:

wartość logiczna

Wartość „prawda”, jeśli operacja odniosła skutek, lub „false”, jeśli została zignorowana.

UploadTask.then()

Ten obiekt działa jak obiekt obietnicowy i po zakończeniu przesyłania rozwiązuje problem z danymi ze zrzutu.

Podpis:

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

Parametry

Parametr	Typ	Opis
onFulpełniony:	((zrzut: UploadTaskSnapshot) => nieznany) | wartość null	Wywołanie zwrotne realizacji. Łańcuch obietnic działa normalnie.
onOdrzucone	((błąd: StorageError) => nieznany) | wartość null	Wywołanie zwrotne odrzucenia.

Zwroty:

Obietnica<nieznana>