UploadTask interface

Merepresentasikan proses upload objek. Memungkinkan Anda memantau dan mengelola upload.

Tanda Tangan:

export interface UploadTask 

Properti

Properti	Jenis	Deskripsi
snapshot	UploadTaskSnapshot	Snapshot status tugas saat ini.

Metode

Metode	Deskripsi
cancel().	Membatalkan tugas yang sedang berjalan. Tidak memengaruhi tugas yang selesai atau gagal.
tangkapan(onDitolak)	Setara dengan memanggil then(null, onRejected).
on(event, nextOrObserver, error, complete)	Memproses peristiwa pada tugas ini.Peristiwa memiliki tiga fungsi callback (disebut sebagai next, error, dan complete).Jika hanya peristiwa yang diteruskan, fungsi yang dapat digunakan untuk mendaftarkan callback akan ditampilkan. Jika tidak, callback akan diteruskan setelah peristiwa.Callback dapat diteruskan sebagai tiga argumen terpisah atau sebagai properti next, error, dan complete suatu objek. Salah satu dari tiga callback bersifat opsional, selama minimal satu callback ditetapkan. Selain itu, saat menambahkan callback, Anda akan mendapatkan kembali fungsi. Anda dapat memanggil fungsi ini untuk membatalkan pendaftaran callback terkait.
pause()	Menjeda tugas yang sedang berjalan. Tidak memengaruhi tugas yang dijeda atau gagal.
resume()	Melanjutkan tugas yang dijeda. Tidak memengaruhi tugas yang sedang berjalan atau gagal.
lalu(onFulfilled, onReject)	Objek ini berperilaku seperti Promise, dan di-resolve dengan data snapshot-nya saat upload selesai.

UploadTask.snapshot

Snapshot status tugas saat ini.

Tanda Tangan:

snapshot: UploadTaskSnapshot;

UploadTask.cancel()

Membatalkan tugas yang sedang berjalan. Tidak memengaruhi tugas yang selesai atau gagal.

Tanda Tangan:

cancel(): boolean;

Hasil:

boolean

True jika pembatalan berpengaruh.

UploadTask.catch()

Setara dengan memanggil then(null, onRejected).

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
onDitolak	(error: StorageError) => tidak dikenal

Hasil:

Janji<tidak diketahui>

UploadTask.on()

Memproses peristiwa pada tugas ini.

Peristiwa memiliki tiga fungsi callback (disebut sebagai next, error, dan complete).

Jika hanya peristiwa yang diteruskan, fungsi yang dapat digunakan untuk mendaftarkan callback akan ditampilkan. Jika tidak, callback akan diteruskan setelah peristiwa.

Callback dapat diteruskan sebagai tiga argumen terpisah atau sebagai properti next, error, dan complete dari suatu objek. Salah satu dari tiga callback bersifat opsional, selama minimal satu callback ditetapkan. Selain itu, saat menambahkan callback, Anda akan mendapatkan kembali fungsi. Anda dapat memanggil fungsi ini untuk membatalkan pendaftaran callback terkait.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
event	TaskEvent	Jenis peristiwa yang akan diproses.
nextOrObserver	StorageObserver<UploadTaskSnapshot> | null | ((snapshot: UploadTaskSnapshot) => tidak diketahui)	Fungsi next, yang dipanggil untuk setiap item dalam aliran peristiwa, atau objek observer dengan sebagian atau semua dari ketiga properti ini (next, error, complete).
error	((a: StorageError) =>Unknown) | null (kosong)	Fungsi yang akan dipanggil dengan StorageError jika aliran peristiwa berakhir karena error.
selesai	Berhenti Berlangganan | null (kosong)

Hasil:

Berhenti Berlangganan | Berlangganan<UploadTaskSnapshot>

Jika hanya argumen peristiwa yang diteruskan, fungsi yang dapat Anda gunakan untuk menambahkan callback akan ditampilkan (lihat contoh di atas). Jika lebih dari sekadar argumen peristiwa yang diteruskan, akan ditampilkan fungsi yang dapat Anda panggil untuk membatalkan pendaftaran callback.

Contoh 1

**Teruskan callback secara terpisah atau dalam suatu objek.**

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

Contoh 2

**Callback apa pun bersifat opsional.**

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

Contoh 3

**Gunakan fungsi yang dikembalikan untuk menghapus 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();
});

UploadTask.pause()

Menjeda tugas yang sedang berjalan. Tidak memengaruhi tugas yang dijeda atau gagal.

Tanda Tangan:

pause(): boolean;

Hasil:

boolean

True jika operasi diterapkan, false jika diabaikan.

UploadTask.resume()

Melanjutkan tugas yang dijeda. Tidak memengaruhi tugas yang sedang berjalan atau gagal.

Tanda Tangan:

resume(): boolean;

Hasil:

boolean

True jika operasi diterapkan, false jika diabaikan.

UploadTask.then()

Objek ini berperilaku seperti Promise, dan di-resolve dengan data snapshot-nya saat upload selesai.

Tanda Tangan:

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

Parameter

Parameter	Jenis	Deskripsi
onFulfilled	((snapshot: UploadTaskSnapshot) => tidak diketahui) | null (kosong)	Callback fulfillment. Perantaian promise berfungsi seperti biasa.
onDitolak	((error: StorageError) => Unknown) | null (kosong)	Callback penolakan.

Hasil:

Janji<tidak diketahui>