メインコンテンツへスキップ

@capgo/capacitor-uploader

Capacitor Uploader Plugin:バックグラウンド実行と進捗トラッキングに対応したファイルアップロード用プラグイン。

@capgo/capacitor-uploader デバイスから大容量ファイルを移動するのに使用します ネイティブのバックグラウンドアップロード iOSとAndroidに対応。進捗と完了はプラグインイベントで通知されるため、アップロード中もUIを切り離したままにできます。WebViewでファイル全体をバッファリングせず、カメラ撮影やファイルシステムのパスと組み合わせて使えます。

主なユースケース:写真や動画のバックアップ、S3の署名付きURLへのアップロード、メタデータフィールド付きのマルチパートフォームPOST、および〜を使った堅牢なリトライ maxRetries.

プラットフォームバックグラウンドアップロード備考
iOSとはいバックグラウンド URLSession
Androidでははいアップロード中のフォアグラウンドサービス形式の通知
Webページを開いている間fetch ベースで、ネイティブのバックグラウンド継続は不可

WebはIndexedDB形式のパスもサポートしています: idb://[database]/[collection]/[key].

  • startUpload - サーバーへのファイルアップロードを開始します。
  • removeUpload - 進行中のアップロードをキャンセルして削除します。
メソッド説明
startUploadサーバーへのファイルアップロードを開始します。
removeUpload進行中のアップロードをキャンセルして削除します。
addListenerアップロードの進捗とステータスイベントをリッスンします。
getPluginVersionネイティブの Capacitor プラグインのバージョンを取得します。

このリファレンスは以下から同期されています: src/definitions.ts における capacitor-uploader.

@capgo/capacitor-uploader から続ける

「@capgo/capacitor-uploader」から継続する

使用している場合 @capgo/capacitor-uploader ストレージとファイル処理を計画するには、以下と連携してください: @capgo/capacitor-uploader の使用方法 「@capgo/capacitor-uploader」の使用方法におけるネイティブ機能として、 @capgo/capacitor-data-storage-sqlite @capgo/capacitor-data-storage-sqlite の実装の詳細については、 @capgo/capacitor-data-storage-sqlite の使い方 「@capgo/capacitor-data-storage-sqliteの使用方法」におけるネイティブ機能について、 @capgo/capacitor-file @capgo/capacitor-file の実装の詳細については、 @capgo/capacitor-file の使い方 @capgo/capacitor-file. の使い方で扱うネイティブ機能については