オブジェクトをアップロードするプロセスを表します。アップロードを監視および管理できます。
サイン:
export interface UploadTask
プロパティ
財産 | タイプ | 説明 |
---|---|---|
スナップショット | タスクスナップショットのアップロード | 現在のタスク状態のスナップショット。 |
メソッド
方法 | 説明 |
---|---|
キャンセル() | 実行中のタスクをキャンセルします。完了したタスクまたは失敗したタスクには影響しません。 |
catch(拒否された場合) | then(null, onRejected) を呼び出すことと同じです。 |
on(イベント、nextOrObserver、エラー、完了) | このタスクのイベントをリッスンします。イベントには 3 つのコールバック関数 ( next 、 error 、およびcomplete と呼ばれます) があります。イベントのみが渡された場合は、コールバックの登録に使用できる関数が返されます。それ以外の場合、コールバックはイベントの後に渡されます。コールバックは、3 つの個別の引数として、またはオブジェクトのnext 、 error 、およびcomplete プロパティとして渡すことができます。少なくとも 1 つが指定されていれば、3 つのコールバックはいずれもオプションです。さらに、コールバックを追加すると、関数が返されます。この関数を呼び出して、関連付けられたコールバックの登録を解除できます。 |
一時停止() | 現在実行中のタスクを一時停止します。一時停止または失敗したタスクには影響しません。 |
再開する() | 一時停止したタスクを再開します。現在実行中のタスクまたは失敗したタスクには影響しません。 |
then(onFulfilled、onRejected) | このオブジェクトは Promise のように動作し、アップロードが完了するとスナップショット データを使用して解決されます。 |
タスクのスナップショットのアップロード
現在のタスク状態のスナップショット。
サイン:
snapshot: UploadTaskSnapshot;
UploadTask.cancel()
実行中のタスクをキャンセルします。完了したタスクまたは失敗したタスクには影響しません。
サイン:
cancel(): boolean;
戻り値:
ブール値
キャンセルに効果がある場合は True。
UploadTask.catch()
then(null, onRejected)
を呼び出すのと同じ。
サイン:
catch(onRejected: (error: StorageError) => unknown): Promise<unknown>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
拒否された場合 | (エラー:ストレージエラー) => 不明 |
戻り値:
約束<不明>
UploadTask.on()
このタスクのイベントをリッスンします。
イベントには 3 つのコールバック関数があります ( next
コールバック関数と呼ばれます)。 、 error
、 complete
)。
イベントのみが渡された場合は、コールバックの登録に使用できる関数が返されます。それ以外の場合、コールバックはイベントの後に渡されます。
コールバックは、3 つの個別の引数として、またはnext
引数として渡すことができます。 、 error
、オブジェクトのcomplete
プロパティ。少なくとも 1 つが指定されていれば、3 つのコールバックはいずれもオプションです。さらに、コールバックを追加すると、関数が返されます。この関数を呼び出して、関連付けられたコールバックの登録を解除できます。
サイン:
on(event: TaskEvent, nextOrObserver?: StorageObserver<UploadTaskSnapshot> | null | ((snapshot: UploadTaskSnapshot) => unknown), error?: ((a: StorageError) => unknown) | null, complete?: Unsubscribe | null): Unsubscribe | Subscribe<UploadTaskSnapshot>;
パラメーター
パラメータ | タイプ | 説明 |
---|---|---|
イベント | タスクイベント | リッスンするイベントのタイプ。 |
次またはオブザーバー | ストレージオブザーバー<タスクスナップショットのアップロード> |ヌル | ((スナップショット: UploadTaskSnapshot ) => 不明) | イベント ストリーム内の各項目に対して呼び出されるnext 関数、またはこれら 3 つのプロパティ ( next 、 error 、 complete ) の一部またはすべてを持つオブザーバー オブジェクト。 |
エラー | ((a:ストレージエラー) => 不明) |ヌル | イベント ストリームがエラーにより終了した場合に、 StorageError で呼び出される関数。 |
完了 | 購読解除|ヌル |
戻り値:
イベント引数のみが渡された場合は、コールバックの追加に使用できる関数を返します (上記の例を参照)。イベント引数以外のものが渡された場合は、コールバックの登録を解除するために呼び出すことができる関数を返します。
例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 チェーンは通常どおりに機能します。 |
拒否された場合 | ((エラー:ストレージエラー) => 不明) |ヌル | 拒否コールバック。 |
戻り値:
約束<不明>