UploadTask interface

オブジェクトのアップロード プロセスを表します。アップロードのモニタリングと管理ができます。

署名:

export interface UploadTask

プロパティ

プロパティ 型 説明
snapshot UploadTaskSnapshot。 現在のタスク状態のスナップショット。

メソッド

メソッド 説明
cancel() 実行中のタスクをキャンセルします。完了したタスクや失敗したタスクには影響しません。
catch(onRejected) then(null, onRejected) の呼び出しと同じです。
on(event, nextOrObserver, error, complete) このタスクのイベントをリッスンします。イベントには 3 つのコールバック関数（next、error、complete）があります。イベントのみが渡されると、コールバックの登録に使用できる関数が返されます。それ以外の場合、コールバックはイベントの後に渡されます。コールバックは、3 つの個別の引数として、またはオブジェクトの next プロパティ、error プロパティ、complete プロパティとして渡すことができます。3 つのコールバックは、少なくとも 1 つ指定されていれば、いずれも省略可能です。また、コールバックを追加すると、関数が返ってきます。この関数を呼び出すと、関連付けられているコールバックの登録を解除できます。
pause() 現在実行中のタスクを一時停止します。一時停止または失敗したタスクには影響しません。
resume() 一時停止したタスクを再開します。現在実行中のタスクや失敗したタスクには影響しません。
then（onFulfilled、onRejected） このオブジェクトは Promise と同様に動作し、アップロードが完了するとスナップショット データで解決されます。

UploadTask.snapshot

現在のタスク状態のスナップショット。

署名:

snapshot: UploadTaskSnapshot;

UploadTask.cancel()

実行中のタスクをキャンセルします。完了したタスクや失敗したタスクには影響しません。

署名:

cancel(): boolean;

戻り値:

ブール値

キャンセルが反映されている場合は true を返します。

UploadTask.catch()

then(null, onRejected) の呼び出しと同じです。

署名:

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

パラメータ

パラメータ 型 説明
onRejected （エラー: StorageError）=>不明

戻り値:

約束 <unknown>

UploadTask.on()

このタスクのイベントをリッスンします。

イベントには 3 つのコールバック関数（next、error、complete）があります。

イベントのみが渡された場合は、コールバックの登録に使用できる関数が返されます。それ以外の場合は、コールバックはイベントの後に渡されます。

コールバックは、3 つの個別の引数、またはオブジェクトの next、error、complete プロパティのいずれかとして渡すことができます。3 つのコールバックは、少なくとも 1 つ指定されていれば、いずれも省略可能です。また、コールバックを追加すると、関数が返ってきます。この関数を呼び出すと、関連付けられているコールバックの登録を解除できます。

署名:

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

パラメータ

パラメータ 型 説明
event TaskEvent リッスンするイベントのタイプ。
nextOrObserver StorageObserver<UploadTaskSnapshot>|null |（（スナップショット: UploadTaskSnapshot）=> 不明） next 関数。イベント ストリーム内の各アイテム、またはこれら 3 つのプロパティ（next、error、complete）の一部またはすべてを持つオブザーバー オブジェクトに対して呼び出されます。
エラー （（a: StorageError）=> 不明）|null イベント ストリームがエラーによって終了した場合に、StorageError で呼び出される関数。
完了 配信停止 |null

戻り値:

配信停止 |サブスクライブ<UploadTaskSnapshot>

event 引数のみが渡された場合は、コールバックの追加に使用できる関数を返します（上記の例を参照）。event 引数以外の引数が渡された場合は、コールバックの登録を解除するために呼び出す関数を返します。

例 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）=> 不明）|null フルフィルメント コールバック。Promise チェーンは通常どおり機能します。
onRejected （（エラー: StorageError）=> 不明）|null 拒否のコールバック。

戻り値:

約束 <unknown>