UploadTask interface

Mewakili proses mengunggah suatu objek. Memungkinkan Anda memantau dan mengelola unggahan.

Tanda tangan:

export interface UploadTask 

Properti

Properti	Jenis	Keterangan
foto	UnggahTugasSnapshot	Cuplikan status tugas saat ini.

Metode

metode	Keterangan
membatalkan()	Membatalkan tugas yang sedang berjalan. Tidak berpengaruh pada tugas yang selesai atau gagal.
menangkap (ditolak)	Setara dengan menelepon then(null, onRejected) .
aktif (acara, nextOrObserver, error, selesai)	Mendengarkan peristiwa pada tugas ini. Peristiwa memiliki tiga fungsi panggilan balik (disebut next , error , dan complete ). Jika hanya peristiwa yang dilewati, fungsi yang dapat digunakan untuk mendaftarkan panggilan balik akan dikembalikan. Jika tidak, callback akan diteruskan setelah acara. Callback dapat diteruskan sebagai tiga argumen terpisah atau sebagai properti next , error , dan complete dari suatu objek. Salah satu dari ketiga callback tersebut bersifat opsional, selama setidaknya satu ditentukan. Selain itu, saat Anda menambahkan panggilan balik, Anda mendapatkan fungsi kembali. Anda dapat memanggil fungsi ini untuk membatalkan pendaftaran callback terkait.
berhenti sebentar()	Menjeda tugas yang sedang berjalan. Tidak berpengaruh pada tugas yang dijeda atau gagal.
melanjutkan()	Melanjutkan tugas yang dijeda. Tidak berpengaruh pada tugas yang sedang berjalan atau gagal.
lalu (dipenuhi, ditolak)	Objek ini berperilaku seperti Janji, dan diselesaikan dengan data cuplikannya saat pengunggahan selesai.

UnggahTask.snapshot

Cuplikan status tugas saat ini.

Tanda tangan:

snapshot: UploadTaskSnapshot;

UnggahTugas.batalkan()

Membatalkan tugas yang sedang berjalan. Tidak berpengaruh pada tugas yang selesai atau gagal.

Tanda tangan:

cancel(): boolean;

Pengembalian:

boolean

Benar jika pembatalan itu berpengaruh.

UnggahTask.catch()

Setara dengan panggilan then(null, onRejected) .

Tanda tangan:

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

Parameter

Parameter	Jenis	Keterangan
pada Ditolak	(kesalahan: StorageError ) => tidak diketahui

Pengembalian:

Janji<tidak diketahui>

UnggahTugas.on()

Mendengarkan peristiwa pada tugas ini.

Acara memiliki tiga fungsi panggilan balik (disebut next , error , dan complete ).

Jika hanya peristiwa yang dilewati, fungsi yang dapat digunakan untuk mendaftarkan panggilan balik akan dikembalikan. Jika tidak, callback akan diteruskan setelah acara.

Callback dapat diteruskan sebagai tiga argumen terpisah atau sebagai argumen next , error , dan properti complete suatu objek. Salah satu dari ketiga callback tersebut bersifat opsional, selama setidaknya satu ditentukan. Selain itu, saat Anda menambahkan panggilan balik, Anda mendapatkan fungsi kembali. 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	Keterangan
peristiwa	Acara Tugas	Jenis acara yang harus didengarkan.
berikutnyaAtauObserver	Pengamat Penyimpanan < UnggahTugasSnapshot > | batal | ((snapshot: UploadTaskSnapshot ) => tidak diketahui)	Fungsi next , yang dipanggil untuk setiap item dalam aliran peristiwa, atau objek pengamat dengan beberapa atau ketiga properti ini ( next , error , complete ).
kesalahan	((a: Kesalahan Penyimpanan ) => tidak diketahui) | batal	Fungsi yang dipanggil dengan StorageError jika aliran peristiwa berakhir karena kesalahan.
menyelesaikan	Berhenti berlangganan | batal

Pengembalian:

Berhenti berlangganan | Langganan < UnggahTugasSnapshot >

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

Contoh 1

**Melalui 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

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

UnggahTugas.jeda()

Menjeda tugas yang sedang berjalan. Tidak berpengaruh pada tugas yang dijeda atau gagal.

Tanda tangan:

pause(): boolean;

Pengembalian:

boolean

Benar jika operasi berhasil, salah jika diabaikan.

UnggahTugas.resume()

Melanjutkan tugas yang dijeda. Tidak berpengaruh pada tugas yang sedang berjalan atau gagal.

Tanda tangan:

resume(): boolean;

Pengembalian:

boolean

Benar jika operasi berhasil, salah jika diabaikan.

UnggahTugas.lalu()

Objek ini berperilaku seperti Janji, dan diselesaikan dengan data cuplikannya saat pengunggahan selesai.

Tanda tangan:

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

Parameter

Parameter	Jenis	Keterangan
diTerpenuhi	((snapshot: UploadTaskSnapshot ) => tidak diketahui) | batal	Panggilan balik pemenuhan. Rantai janji berfungsi seperti biasa.
pada Ditolak	((kesalahan: StorageError ) => tidak diketahui) | batal	Panggilan balik penolakan.

Pengembalian:

Janji<tidak diketahui>