UploadTask interface

객체를 업로드하는 프로세스를 나타냅니다. 업로드를 모니터링하고 관리할 수 있습니다.

서명:

export interface UploadTask 

속성

재산	유형	설명
스냅 사진	업로드작업스냅샷	현재 작업 상태의 스냅샷입니다.

행동 양식

방법	설명
취소()	실행 중인 작업을 취소합니다. 완료되거나 실패한 작업에는 영향을 미치지 않습니다.
잡기(거부됨)	then(null, onRejected) 호출하는 것과 동일합니다.
on(이벤트, nextOrObserver, 오류, 완료)	이 작업에 대한 이벤트를 수신합니다. 이벤트에는 세 가지 콜백 함수( next , error 및 complete 라고 함)가 있습니다. 이벤트만 전달되면 콜백을 등록하는 데 사용할 수 있는 함수가 반환됩니다. 그렇지 않으면 이벤트 후에 콜백이 전달됩니다. 콜백은 세 개의 개별 인수로 전달 되거나 객체의 next , error 및 complete 속성으로 전달될 수 있습니다. 세 가지 콜백 중 하나 이상이 지정되어 있는 한 선택 사항입니다. 또한 콜백을 추가하면 함수가 다시 제공됩니다. 이 함수를 호출하여 연결된 콜백을 등록 취소할 수 있습니다.
정지시키다()	현재 실행 중인 작업을 일시 중지합니다. 일시 중지되거나 실패한 작업에는 영향을 미치지 않습니다.
재개하다()	일시 중지된 작업을 재개합니다. 현재 실행 중이거나 실패한 작업에는 영향을 주지 않습니다.
then(onFulfilled, onRejected)	이 객체는 Promise처럼 동작하며 업로드가 완료되면 스냅샷 데이터로 확인됩니다.

UploadTask.스냅샷

현재 작업 상태의 스냅샷입니다.

서명:

snapshot: UploadTaskSnapshot;

UploadTask.cancel()

실행 중인 작업을 취소합니다. 완료되거나 실패한 작업에는 영향을 미치지 않습니다.

서명:

cancel(): boolean;

보고:

부울

취소가 적용된 경우 참입니다.

UploadTask.catch()

then(null, onRejected) 호출하는 것과 동일합니다. .

서명:

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

매개변수

매개변수	유형	설명
거부됨	(오류: StorageError ) => 알 수 없음

보고:

약속<알 수 없음>

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

매개변수

매개변수	유형	설명
이벤트	태스크이벤트	수신 대기할 이벤트 유형입니다.
다음또는관찰자	스토리지옵저버 < UploadTask스냅샷 > | null | ((스냅샷: UploadTaskSnapshot ) => 알 수 없음)	이벤트 스트림의 각 항목에 대해 호출되는 next 함수 또는 이러한 세 가지 속성( next , error , complete ) 중 일부 또는 전부를 가진 관찰자 개체입니다.
오류	((a: 저장 오류 ) => 알 수 없음) | 없는	오류로 인해 이벤트 스트림이 종료되면 StorageError 와 함께 호출되는 함수입니다.
완벽한	구독 취소 | 없는

보고:

구독 취소 | 구독하다 < UploadTask스냅샷 >

이벤트 인수만 전달된 경우 콜백을 추가하는 데 사용할 수 있는 함수를 반환합니다(위 예 참조). 이벤트 인수 이상이 전달되면 콜백 등록을 취소하기 위해 호출할 수 있는 함수를 반환합니다.

실시예 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()

현재 실행 중인 작업을 일시 중지합니다. 일시 중지되거나 실패한 작업에는 영향을 주지 않습니다.

서명:

pause(): boolean;

보고:

부울

작업이 적용되면 True이고, 무시되면 False입니다.

UploadTask.resume()

일시 중지된 작업을 재개합니다. 현재 실행 중이거나 실패한 작업에는 영향을 주지 않습니다.

서명:

resume(): boolean;

보고:

부울

작업이 적용되면 True이고, 무시되면 False입니다.

UploadTask.then()

이 객체는 Promise처럼 동작하며 업로드가 완료되면 스냅샷 데이터로 확인됩니다.

서명:

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

매개변수

매개변수	유형	설명
이행 시	((스냅샷: UploadTaskSnapshot ) => 알 수 없음) | 없는	이행 콜백. Promise Chaining은 정상적으로 작동합니다.
거부됨	((오류: StorageError ) => 알 수 없음) | 없는	거부 콜백.

보고:

약속<알 수 없음>