UploadTask interface

แสดงถึงกระบวนการอัพโหลดวัตถุ ช่วยให้คุณตรวจสอบและจัดการการอัปโหลด

ลายเซ็น:

export interface UploadTask 

คุณสมบัติ

วิธีการ

UploadTask.snapshot

สแน็ปช็อตของสถานะงานปัจจุบัน

ลายเซ็น:

snapshot: UploadTaskSnapshot;

UploadTask.cancel()

ยกเลิกงานที่กำลังทำงานอยู่ ไม่มีผลกระทบต่องานที่เสร็จสมบูรณ์หรือล้มเหลว

ลายเซ็น:

cancel(): boolean;

ผลตอบแทน:

บูลีน

เป็นจริงหากการยกเลิกมีผลกระทบ

UploadTask.catch()

เทียบเท่ากับการโทร then(null, onRejected) .

ลายเซ็น:

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

พารามิเตอร์

ผลตอบแทน:

สัญญา<ไม่ทราบ>

UploadTask.on()

รับฟังเหตุการณ์ในงานนี้

เหตุการณ์มีฟังก์ชันการโทรกลับสามฟังก์ชัน (จะเรียกว่า next , error และ complete ).

หากผ่านเฉพาะเหตุการณ์เท่านั้น ฟังก์ชันที่สามารถใช้เพื่อลงทะเบียนการเรียกกลับจะถูกส่งกลับ มิฉะนั้น การโทรกลับจะถูกส่งต่อหลังจากเหตุการณ์

การโทรกลับสามารถส่งผ่านเป็นอาร์กิวเมนต์แยกกันสามอาร์กิวเมนต์ หรือ เป็นอาร์กิวเมนต์ next , error และคุณสมบัติ complete ของวัตถุ การเรียกกลับใดๆ ในสามรายการเป็นทางเลือก ตราบเท่าที่มีการระบุอย่างน้อยหนึ่งรายการ นอกจากนี้ เมื่อคุณเพิ่มการโทรกลับ คุณจะได้รับฟังก์ชันกลับคืนมา คุณสามารถเรียกใช้ฟังก์ชันนี้เพื่อยกเลิกการลงทะเบียนการโทรกลับที่เกี่ยวข้องได้

ลายเซ็น:

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

พารามิเตอร์

ผลตอบแทน:

ยกเลิกการสมัคร | ติดตาม < อัปโหลด TaskSnapshot >

ถ้าเพียงอาร์กิวเมนต์เหตุการณ์เท่านั้นที่ถูกส่งกลับฟังก์ชันที่คุณสามารถใช้เพื่อเพิ่มการโทรกลับ (ดูตัวอย่างด้านบน) หากมีการส่งผ่านอาร์กิวเมนต์เหตุการณ์มากกว่าปกติ ให้ส่งคืนฟังก์ชันที่คุณสามารถเรียกใช้เพื่อยกเลิกการลงทะเบียนการเรียกกลับได้

ตัวอย่างที่ 1

**ส่งการโทรกลับแยกกันหรือในวัตถุ**

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

ตัวอย่างที่ 2

**การโทรกลับใดๆ เป็นทางเลือก**

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

ตัวอย่างที่ 3

**ใช้ฟังก์ชันที่ส่งคืนเพื่อลบการโทรกลับ**

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(): boolean;

ผลตอบแทน:

บูลีน

เป็นจริงหากการดำเนินการมีผล เท็จหากละเว้น

UploadTask.resume()

ดำเนินภารกิจที่หยุดชั่วคราวต่อ ไม่มีผลกระทบต่องานที่กำลังทำงานอยู่หรือล้มเหลวในปัจจุบัน

ลายเซ็น:

resume(): boolean;

ผลตอบแทน:

บูลีน

เป็นจริงหากการดำเนินการมีผล เท็จหากละเว้น

UploadTask.แล้ว()

ออบเจ็กต์นี้มีพฤติกรรมเหมือนสัญญา และแก้ไขด้วยข้อมูลสแน็ปช็อตเมื่อการอัปโหลดเสร็จสิ้น

ลายเซ็น:

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

พารามิเตอร์

ผลตอบแทน:

สัญญา<ไม่ทราบ>