UploadTask interface

Thể hiện quá trình tải lên một đối tượng. Cho phép bạn theo dõi và quản lý việc tải lên.

Chữ ký:

export interface UploadTask 

Của cải

Tài sản	Kiểu	Sự miêu tả
ảnh chụp nhanh	Tải lênNhiệm vụSnapshot	Ảnh chụp nhanh về trạng thái tác vụ hiện tại.

phương pháp

Phương pháp	Sự miêu tả
Hủy bỏ()	Hủy bỏ một tác vụ đang chạy. Không có tác dụng đối với một nhiệm vụ hoàn thành hoặc thất bại.
bắt(onRejected)	Tương đương với việc gọi then(null, onRejected) .
on(sự kiện, nextOrObserver, lỗi, hoàn thành)	Lắng nghe các sự kiện về nhiệm vụ này. Các sự kiện có ba chức năng gọi lại (được gọi là next , error và complete ). Nếu chỉ sự kiện được thông qua, một hàm có thể được sử dụng để đăng ký các lệnh gọi lại sẽ được trả về. Nếu không, lệnh gọi lại sẽ được chuyển sau sự kiện. Các cuộc gọi lại có thể được chuyển dưới dạng ba đối số riêng biệt hoặc dưới dạng các thuộc tính next , error và complete của một đối tượng. Bất kỳ lệnh gọi lại nào trong số ba lệnh gọi lại đều là tùy chọn, miễn là có ít nhất một lệnh gọi lại được chỉ định. Ngoài ra, khi bạn thêm lệnh gọi lại, bạn sẽ nhận được một chức năng. Bạn có thể gọi hàm này để hủy đăng ký các lệnh gọi lại liên quan.
tạm ngừng()	Tạm dừng một tác vụ hiện đang chạy. Không có tác dụng đối với tác vụ bị tạm dừng hoặc thất bại.
bản tóm tắt()	Tiếp tục một nhiệm vụ bị tạm dừng. Không có tác dụng đối với tác vụ hiện đang chạy hoặc bị lỗi.
sau đó(onFulfill, onRejected)	Đối tượng này hoạt động giống như một Promise và phân giải bằng dữ liệu ảnh chụp nhanh của nó khi quá trình tải lên hoàn tất.

Tải lênTask.snapshot

Ảnh chụp nhanh về trạng thái tác vụ hiện tại.

Chữ ký:

snapshot: UploadTaskSnapshot;

UploadTask.cancel()

Hủy bỏ một tác vụ đang chạy. Không có tác dụng đối với một nhiệm vụ hoàn thành hoặc thất bại.

Chữ ký:

cancel(): boolean;

Trả về:

boolean

Đúng nếu việc hủy có hiệu lực.

UploadTask.catch()

Tương đương với việc gọi then(null, onRejected) .

Chữ ký:

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

Thông số

Tham số	Kiểu	Sự miêu tả
trênBị từ chối	(lỗi: Lỗi lưu trữ ) => chưa biết

Trả về:

Hứa<không rõ>

UploadTask.on()

Lắng nghe các sự kiện về nhiệm vụ này.

Sự kiện có ba chức năng gọi lại (gọi là next , error , và complete ).

Nếu chỉ sự kiện được thông qua, một hàm có thể được sử dụng để đăng ký các lệnh gọi lại sẽ được trả về. Nếu không, lệnh gọi lại sẽ được chuyển sau sự kiện.

Cuộc gọi lại có thể được chuyển dưới dạng ba đối số riêng biệt hoặc dưới dạng đối next , error và các thuộc tính complete của một đối tượng. Bất kỳ lệnh gọi lại nào trong số ba lệnh gọi lại đều là tùy chọn, miễn là có ít nhất một lệnh gọi lại được chỉ định. Ngoài ra, khi bạn thêm lệnh gọi lại, bạn sẽ nhận được một chức năng. Bạn có thể gọi hàm này để hủy đăng ký các lệnh gọi lại liên quan.

Chữ ký:

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

Thông số

Tham số	Kiểu	Sự miêu tả
sự kiện	Sự kiện nhiệm vụ	Loại sự kiện cần lắng nghe.
tiếp theoHoặcObserver	Người quan sát lưu trữ < Tải lênNhiệm vụSnapshot > | vô giá trị | ((ảnh chụp nhanh: UploadTaskSnapshot ) => chưa biết)	Hàm next , được gọi cho từng mục trong luồng sự kiện hoặc đối tượng quan sát viên có một số hoặc tất cả ba thuộc tính này ( next , error , complete ).
lỗi	((a: Lỗi lưu trữ ) => chưa biết) | vô giá trị	Một hàm được gọi kèm theo StorageError nếu luồng sự kiện kết thúc do lỗi.
hoàn thành	Hủy đăng ký | vô giá trị

Trả về:

Hủy đăng ký | Đặt mua < Tải lênNhiệm vụSnapshot >

Nếu chỉ truyền đối số sự kiện, hàm sẽ trả về một hàm mà bạn có thể sử dụng để thêm lệnh gọi lại (xem các ví dụ ở trên). Nếu không chỉ có đối số sự kiện được truyền, thì sẽ trả về một hàm mà bạn có thể gọi để hủy đăng ký các lệnh gọi lại.

ví dụ 1

**Truyền lệnh gọi lại riêng biệt hoặc trong một đối tượng.**

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

Ví dụ 2

**Mọi lệnh gọi lại đều không bắt buộc.**

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

Ví dụ 3

**Sử dụng hàm trả về để xóa lệnh gọi lại.**

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

Tạm dừng một tác vụ hiện đang chạy. Không có tác dụng đối với tác vụ bị tạm dừng hoặc thất bại.

Chữ ký:

pause(): boolean;

Trả về:

boolean

Đúng nếu thao tác có hiệu lực, sai nếu bị bỏ qua.

UploadTask.resume()

Tiếp tục một nhiệm vụ bị tạm dừng. Không có tác dụng đối với tác vụ hiện đang chạy hoặc bị lỗi.

Chữ ký:

resume(): boolean;

Trả về:

boolean

Đúng nếu thao tác có hiệu lực, sai nếu bị bỏ qua.

UploadTask.then()

Đối tượng này hoạt động giống như một Promise và phân giải bằng dữ liệu ảnh chụp nhanh của nó khi quá trình tải lên hoàn tất.

Chữ ký:

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

Thông số

Tham số	Kiểu	Sự miêu tả
trênĐã hoàn thành	((ảnh chụp nhanh: UploadTaskSnapshot ) => chưa biết) | vô giá trị	Lệnh gọi lại thực hiện. Chuỗi hứa hẹn hoạt động như bình thường.
trênBị từ chối	((lỗi: Lỗi lưu trữ ) => chưa biết) | vô giá trị	Cuộc gọi lại từ chối.

Trả về:

Hứa<không rõ>