プラグインのマニュアル: <doc/index.md>
このプラグインは、アップロードし、ファイルをダウンロードすることができます。
このプラグインでは、グローバル FileTransfer
、FileUploadOptions
コンス トラクターを定義します。
グローバル スコープでは使用できませんまで deviceready
イベントの後です。
document.addEventListener("deviceready", onDeviceReady, false); function onDeviceReady() { console.log(FileTransfer); }
cordova plugin add cordova-plugin-file-transfer
\ * * Onprogress
もabort()
をサポートしていません。*
\ * * * Onprogress
をサポートしていません。*
出色
オブジェクトは、HTTP マルチパート POST または PUT 要求を使用してファイルをアップロードし、同様にファイルをダウンロードする方法を提供します。
ProgressEvent
データの新しいチャンクが転送されるたびに。(機能)アップロード: サーバーにファイルを送信します。
ダウンロード: サーバーからファイルをダウンロードします。
中止: 進行中の転送を中止します。
パラメーター:
fileURL: デバイス上のファイルを表すファイルシステム URL。 下位互換性は、このことも、デバイス上のファイルの完全パスであります。 (参照してください [後方互換性メモ] の下)
サーバー: によって符号化されるように、ファイルを受信するサーバーの URLencodeURI()
.
successCallback: FileUploadResult
オブジェクトが渡されるコールバック。(機能)
errorCallback: エラー FileUploadResult
を取得するが発生した場合に実行されるコールバック。FileTransferError
オブジェクトを使って呼び出されます。(機能)
オプション: 省略可能なパラメーター (オブジェクト)。有効なキー:
file
です。(,)image.jpg
です。(,)を置く
または POST
のいずれかを使用する HTTP メソッド。デフォルト のポスト
です。(,)イメージ/jpeg
のデフォルトです。(,)true
です。(ブール値)のポスト
です。(DOMString)trustAllHosts: 省略可能なパラメーターは、デフォルト false
。 場合設定 true
、セキュリティ証明書をすべて受け付けます。 これは Android の自己署名入りセキュリティ証明書を拒否するので便利です。 運用環境で使用しないでください。 Android と iOS でサポートされています。 (ブール値)
// !! Assumes variable fileURL contains a valid URL to a text file on the device, // for example, cdvfile://localhost/persistent/path/to/file.txt var win = function (r) { console.log("Code = " + r.responseCode); console.log("Response = " + r.response); console.log("Sent = " + r.bytesSent); } var fail = function (error) { alert("An error has occurred: Code = " + error.code); console.log("upload error source " + error.source); console.log("upload error target " + error.target); } var options = new FileUploadOptions(); options.fileKey = "file"; options.fileName = fileURL.substr(fileURL.lastIndexOf('/') + 1); options.mimeType = "text/plain"; var params = {}; params.value1 = "test"; params.value2 = "param"; options.params = params; var ft = new FileTransfer(); ft.upload(fileURL, encodeURI("http://some.server.com/upload.php"), win, fail, options);
function win(r) { console.log("Code = " + r.responseCode); console.log("Response = " + r.response); console.log("Sent = " + r.bytesSent); } function fail(error) { alert("An error has occurred: Code = " + error.code); console.log("upload error source " + error.source); console.log("upload error target " + error.target); } var uri = encodeURI("http://some.server.com/upload.php"); var options = new FileUploadOptions(); options.fileKey="file"; options.fileName=fileURL.substr(fileURL.lastIndexOf('/')+1); options.mimeType="text/plain"; var headers={'headerParam':'headerValue'}; options.headers = headers; var ft = new FileTransfer(); ft.onprogress = function(progressEvent) { if (progressEvent.lengthComputable) { loadingStatus.setPercentage(progressEvent.loaded / progressEvent.total); } else { loadingStatus.increment(); } }; ft.upload(fileURL, uri, win, fail, options);
FileUploadResult
オブジェクトは FileTransfer
オブジェクト upload()
メソッドの成功時のコールバックに渡されます。
bytesSent: アップロードの一部としてサーバーに送信されたバイト数。(ロング)
記述: サーバーによって返される HTTP 応答コード。(ロング)
応答: サーバーによって返される HTTP 応答。(,)
ヘッダー: HTTP 応答ヘッダー サーバーによって。(オブジェクト)
responseCode
またはbytesSent
.パラメーター:
ソース: によって符号化されるように、ファイルをダウンロードするサーバーの URLencodeURI()
.
ターゲット: デバイス上のファイルを表すファイルシステム url。 下位互換性は、このことも、デバイス上のファイルの完全パスであります。 (参照してください [後方互換性メモ] の下)
successCallback: 渡されたコールバックを FileEntry
オブジェクト。(機能)
errorCallback: FileEntry
を取得するときにエラーが発生した場合に実行されるコールバック。FileTransferError
オブジェクトを使って呼び出されます。(機能)
trustAllHosts: 省略可能なパラメーターは、デフォルト false
。 場合設定 true
、セキュリティ証明書をすべて受け付けます。 Android は、自己署名入りセキュリティ証明書を拒否しますので便利です。 運用環境で使用しないでください。 Android と iOS でサポートされています。 (ブール値)
オプション: 省略可能なパラメーターは、現在サポートするヘッダーのみ (認証 (基本認証) など)。
// !! Assumes variable fileURL contains a valid URL to a path on the device, // for example, cdvfile://localhost/persistent/path/to/downloads/ var fileTransfer = new FileTransfer(); var uri = encodeURI("http://some.server.com/download.php"); fileTransfer.download( uri, fileURL, function(entry) { console.log("download complete: " + entry.toURL()); }, function(error) { console.log("download error source " + error.source); console.log("download error target " + error.target); console.log("upload error code" + error.code); }, false, { headers: { "Authorization": "Basic dGVzdHVzZXJuYW1lOnRlc3RwYXNzd29yZA==" } } );
以来変更された if
ヘッダー メソッドをダウンロードします。進行中の転送を中止します。Onerror コールバックが FileTransferError.ABORT_ERR のエラー コードを持っている FileTransferError オブジェクトに渡されます。
// !! Assumes variable fileURL contains a valid URL to a text file on the device, // for example, cdvfile://localhost/persistent/path/to/file.txt var win = function(r) { console.log("Should not be called."); } var fail = function(error) { // error.code == FileTransferError.ABORT_ERR alert("An error has occurred: Code = " + error.code); console.log("upload error source " + error.source); console.log("upload error target " + error.target); } var options = new FileUploadOptions(); options.fileKey="file"; options.fileName="myphoto.jpg"; options.mimeType="image/jpeg"; var ft = new FileTransfer(); ft.upload(fileURL, encodeURI("http://some.server.com/upload.php"), win, fail, options); ft.abort();
FileTransferError
オブジェクトは、エラーが発生したときにエラー コールバックに渡されます。
コード: 次のいずれかの定義済みのエラー コード。(数)
ソース: ソースの URL。(文字列)
ターゲット: 先の URL。(文字列)
http_status: HTTP ステータス コード。この属性は、HTTP 接続から応答コードを受信したときにのみ使用できます。(数)
body応答本体。この属性は、HTTP 接続から応答を受信したときにのみ使用できます。(文字列)
exception: どちらか e.getMessage または e.toString (文字列)
FileTransferError.FILE_NOT_FOUND_ERR
FileTransferError.INVALID_URL_ERR
FileTransferError.CONNECTION_ERR
FileTransferError.ABORT_ERR
FileTransferError.NOT_MODIFIED_ERR
このプラグインの以前のバージョンまたはダウンロードのターゲットとして、アップロードのソースとしてのみデバイス絶対ファイル パスを受け入れるでしょう。これらのパスの形式は、通常
/var/mobile/Applications/<application UUID>/Documents/path/to/file (iOS) /storage/emulated/0/path/to/file (Android)
下位互換性、これらのパスを使用しても、アプリケーションは、永続的なストレージでこのようなパスを記録している場合、し彼らが引き続き使用されます。
これらのパスの FileEntry
やファイル プラグインによって返される DirectoryEntry
オブジェクトの fullPath
プロパティで公開されていなかった。 新しいプラグインのバージョン、ファイル、ただし、もはや java スクリプトの設定をこれらのパスを公開します。
新しいにアップグレードする場合 (1.0.0 以降) ファイルのバージョン以前を使用している entry.fullPath
download()
または upload()
への引数として、ファイルシステムの Url を代わりに使用するコードを変更する必要があります。
FileEntry.toURL()
と DirectoryEntry.toURL()
ファイルシステムの URL を返すフォーム
cdvfile://localhost/persistent/path/to/file
download()
、upload()
メソッドの絶対ファイル パスの代わりに使用できます。