ファイル転送 プラグイン
非推奨プラグイン (Cordova 9.0 以降) cordova-plugin-file-transfer の移行については、こちらを参照ください。
テスト環境 ( バージョン番号 ) :1.7.0
このプラグインを使用して、ファイルのアップロードとダウンロードを行えます。
このプラグインでは、グローバルなコンストラクタ 「 FileTransfer
」 と 「 FileUploadOptions
」 を使用します。なお、グローバルスコープに属していますが、使用できるのは、deviceready
イベントの発火後になります。
document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
console.log(FileTransfer);
}
廃止予定
XMLHttpRequest で導入された新機能により、このプラグインは必要ありません。このプラグインから XMLHttpRequest の新機能へ移行する方法については、Cordova blog post を参照してください。
プラグイン ID
cordova-plugin-file-transfer
プラグインの追加方法 ( Monaca 上での処理 )
ファイル転送 プラグイン
は、 ファイル操作プラグイン
に依存しているため、はじめに Monaca クラウド IDEで、File
プラグインを [有効]() にし、 次に File Transfe
プラグインを有効にしてください。
サポート対象のプラットフォーム
Android
iOS
API の解説
FileTransfer
FileTransfer
オブジェクトを使用して、ファイルのアップロード ( HTTP MultiPart POST/PUT リクエストを使用 ) とダウンロードを行います。
プロパティ
onprogress: データの送受信時に、
ProgressEvent
を渡して呼び出す関数。 (Function)
メソッド
upload: サーバーにファイルを送信するときに使用します。
download: サーバーからファイルをダウンロードするときに使用します。
abort: 実行中の送受信を中止するときに使用します。
upload
パラメーター:
fileURL: 端末上のファイルの位置または data URIを指し示すファイルシステムの URL。
後方互換性を考慮する場合には、端末上のファイルへのフルパス ( fullpath ) を使用することもできます ( このページ内の[ 後方互換性に関するメモ書き ]も併せてご確認ください )。
server: ファイルを受け取るサーバーの URL (
encodeURI()
を使用して、エンコード)。successCallback:
FileUploadResult
オブジェクトを渡して実行するコールバック関数。 (Function)errorCallback:
FileUploadResult
を取得するときにエラーが発生した場合に実行されるコールバック関数。FileTransferError
オブジェクトを渡して呼び出します。(Function)options: 任意のパラメーター。使用できる key は、次のとおりです。(Object)
fileKey: form 要素の name 属性。デフォルトは、
file
です。(DOMString)fileName: サーバーにファイルを保存するときに使用するファイル名。デフォルトは、
image.jpg
です。 (DOMString)httpMethod: 使用する、HTTP の method 属性。
PUT
またはPOST
を使用します。デフォルトは、POST
です。 (DOMString)mimeType: アップロードするデータの MIMEタイプ。デフォルトは、
image/jpeg
です。 (DOMString)params: HTTP リクエスト内に任意で設定する key と valueの組み合わせ (Object)
chunkedMode: チャンク/チャンクド形式のストリーミング ( chunked
streaming mode )を使用して、データのアップロードを行うか否かの設定。デフォルトは、
true
です。 (Boolean)headers: ヘッダーのプロパティ名とその値の組み合わせ。値が複数ある場合には、ハッシュを使用します。iOS、Android では、Content-Type が記述されている場合には、マルチパートフォームデータ形式 ( multipartform data ) は使用されません。 (Object)
trustAllHosts: 任意のパラメーター。デフォルトは
false
です。true
に設定した場合、すべてのセキュリティー証明書を許可します。正式リリース版または商用のアプリには推奨しません。Android と iOS で使用できます。 (boolean)
例
// !! 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);
例 アップロード時の Headers と ProgressEvent の使用例 ( Android と iOS 専用 )
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', 'headerParam2':'headerValue2'};
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);
download
パラメーター:
source: ファイルのダウンロード元となるサーバーの URL (
encodeURI()
を使用して、エンコード )。target: 端末上のファイルの位置を指し示す、ファイルシステムの URL( Filesystem URL
)。後方互換性を考慮する場合には、ここには、端末上のファイルへのフルパスを使用することもできます (後方互換性に関しては、下の後方互換性に関するメモ書を参照のこと )。
successCallback:
FileEntry
オブジェクトを渡して実行するコールバック。(Function)errorCallback:
FileEntry
の取得時にエラーが発生した場合に実行されるコールバック。FileTransferError
オブジェクトを渡して実行します。 (Function)trustAllHosts: 任意のパラメーター。デフォルトは
false
です。true
に設定した場合、すべてのセキュリティー証明書を許可します。正式リリース版または商用のアプリには推奨しません。Android と iOS で使用できます。 (boolean)options: 任意のパラメーター。現時点では、headersのみ使用できます ( BASIC 認証などを指定できる Authorizationヘッダーなどを設定できます )。
例
// !! 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("download error code" + error.code);
},
false,
{
headers: {
"Authorization": "Basic dGVzdHVzZXJuYW1lOnRlc3RwYXNzd29yZA=="
}
}
);
abort
実行中のファイルの送受信を中止します。 FileTransferError
オブジェクトを使用して、失敗時のコールバックが呼び出されます。このオブジェクトには、 FileTransferError.ABORT_ERR
エラーコードが格納されています。
例
// !! 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();
FileUploadResult
FileUploadResult
オブジェクトは、FileTransfer
オブジェクトの upload()
メソッドの成功時のコールバックに渡されます。
プロパティ
bytesSent: アップロード時に、サーバーに送られたバイト ( byte )数 (long)
responseCode: サーバーから返ってきた HTTP レスポンスコード (long)
response: サーバーから返ってきた HTTP レスポンス (DOMString)
headers: サーバーから返ってきた HTTP レスポンスのヘッダー (Object)
現時点では、iOS 上でのみ使用できます。
iOS 特有の動作
responseCode
またはbytesSent
は使用できません。chunkedMode=true と
multipartMode=false
に設定している場合、空ファイルのアップロードはできません。
FileTransferError
エラー発生時、FileTransferError
オブジェクトが失敗時のコールバックに渡されます。
プロパティ
code: 後述のエラーコードのいずれか (Number)
source: ソースへの URL (String)
target: ターゲットへの URL (String)
http_status: HTTP ステータスコード。HTTP接続の状態を示すレスポンスコードを受け取った場合のみ、この属性を使用できます。(Number)
body : レスポンスのボディー。HTTP接続の状態を示すレスポンスコードを受け取った場合のみ、この属性を使用できます。(String)
exception:
e.getMessage
またはe.toString
のいずれか (String)
iOS 特有の動作
exception は、定義されません。
定数
1 =
FileTransferError.FILE_NOT_FOUND_ERR
2 =
FileTransferError.INVALID_URL_ERR
3 =
FileTransferError.CONNECTION_ERR
4 =
FileTransferError.ABORT_ERR
5 =
FileTransferError.NOT_MODIFIED_ERR
後方互換性に関するメモ書き
このプラグインの以前のバージョンでは、アップロード時のソースまたはダウンロード時のターゲットには、ファイルの保存場所への端末固有の絶対パス ( device-absolute-file-location
) を使用していました。典型的なパスの形式は、次のとおりでした。
/var/mobile/Applications/<application UUID>/Documents/path/to/file (iOS)
/storage/emulated/0/path/to/file (Android)
後方互換性を考慮して、これらの形式のパスは今でも使用できます。また、永続的なストレージに、これらのパスを保存して使用していた場合でも、継続して、これらの形式のパスを使用できます。
以前は、これらのパスは、ファイル操作プラグイン ( File プラグイン ) が返す FileEntry
と DirectoryEntry
オブジェクトの fullPath
プロパティ内で、JavaScript 側にも暴露されていました。新しいバーションのファイル操作プラグイン ( File プラグイン ) では、この問題も解消され、JavaScript 側へは暴露されません。
ファイル操作プラグイン ( File プラグイン ) のバージョンを 1.0.0 以降にアップグレードして、加えて、以前は、download()
または upload()
への引数に entry.fullPath
を使用していた場合には、代わりに、ファイルシステムの URL ( Filesystem URL ) を使用するように、コードを変更する必要があります。
FileEntry.toURL()
と DirectoryEntry.toURL()
では、ファイルシステムの URL ( Filesystem URL ) を、次の形式で返します。
cdvfile://localhost/persistent/path/to/file
download()
と upload()
の両メソッド内において、ファイルへの絶対パスを指定する代わりに、この URL を使用できます。
サンプルコード : ファイルのダウンロードとアップロード
ファイル転送プラグインを使用して、ファイルのアップロードとダウンロードを行います。ここでは、次の処理を行います。
アプリのキャッシュ用ディレクトリーへ、バイナリーファイルをダウンロード
ファイル操作プラグイン ( File
プラグイン ) とファイル転送プラグインを併用して、 target
の作成/取得とファイルのダウンロードを行います ( ダウンロード時の target とは、「 端末上のファイルの位置を指し示す、ファイルシステムの URL 」 であり、この例では、FileEntry
オブジェクトを指します )。ファイルをダウンロードする前に、resolveLocalFileSystemURL
を使用して、 DirectoryEntry
オブジェクトを作成/取得します。成功時のコールバックでは、DirectoryEntry
の fs.root.getFile
メソッドを使用して、ダウンロード先となるファイル ( FileEntry
) を作成/取得します。
window.requestFileSystem(window.TEMPORARY, 5 * 1024 * 1024, function (fs) {
console.log('file system open: ' + fs.name);
// Make sure you add the domain name to the Content-Security-Policy <meta> element.
var url = 'http://cordova.apache.org/static/img/cordova_bot.png';
// Parameters passed to getFile create a new file or return the file if it already exists.
fs.root.getFile('downloaded-image.png', { create: true, exclusive: false }, function (fileEntry) {
download(fileEntry, url, true);
}, onErrorCreateFile);
}, onErrorLoadFs);
FileEntry
オブジェクトの作成/取得後、 FileTransfer
オブジェクトの download
メソッドを使用して、ファイルを ダウンロード
します。 FileTransfer
の download
メソッドの第三引数は、成功時のコールバックです。このコールバック内で、readBinaryFile
関数を使用しています。また、ここで使用している変数 entry
には、 download
の処理結果として受けとった、新規の FileEntry
オブジェクトが格納されています。
function download(fileEntry, uri, readBinaryData) {
var fileTransfer = new FileTransfer();
var fileURL = fileEntry.toURL();
fileTransfer.download(
uri,
fileURL,
function (entry) {
console.log("Successful download...");
console.log("download complete: " + entry.toURL());
if (readBinaryData) {
// Read the file...
readBinaryFile(entry);
}
else {
// Or just display it.
displayImageByFileURL(entry);
}
},
function (error) {
console.log("download error source " + error.source);
console.log("download error target " + error.target);
console.log("upload error code" + error.code);
},
null, // or, pass false
{
//headers: {
// "Authorization": "Basic dGVzdHVzZXJuYW1lOnRlc3RwYXNzd29yZA=="
//}
}
);
}
画像を単に表示する場合には、次のように、 FileEntry
を渡して、 FileEntry
自身の toURL()
関数を呼び出します。
function displayImageByFileURL(fileEntry) {
var elem = document.getElementById('imageElement');
elem.src = fileEntry.toURL();
}
バイナリーファイルの読み込み後に、なんらかの処理をする場合、FileReader の readAsBinaryString
と readAsArrayBuffer
の 2 つのメソッドを使用できます。ここでは、readAsArrayBuffer
を使用し、FileEntry
オブジェクトをこのメソッドに渡します。ファイルの読み込み後は、その処理結果を使用して、 Blob
オブジェクトを作成します。
function readBinaryFile(fileEntry) {
fileEntry.file(function (file) {
var reader = new FileReader();
reader.onloadend = function() {
console.log("Successful file read: " + this.result);
// displayFileData(fileEntry.fullPath + ": " + this.result);
var blob = new Blob([new Uint8Array(this.result)], { type: "image/png" });
displayImage(blob);
};
reader.readAsArrayBuffer(file);
}, onErrorReadFile);
}
ファイルの読み込み後、createObjectURL
を使用すれば、DOM 上で使用できる URL を取得できます。次に、この URL を使用して、画像を表示します。
function displayImage(blob) {
// Note: Use window.URL.revokeObjectURL when finished with image.
var objURL = window.URL.createObjectURL(blob);
// Displays image if result is a valid DOM string for an image.
var elem = document.getElementById('imageElement');
elem.src = objURL;
}
上記で示したように、ダウンロードした画像を単に表示するのであれば、FileEntry.toURL()
を使用することもできます。
ファイルのアップロード
ファイル転送プラグインを使用してファイルをアップロードする場合、アップロード対象となるファイルを取得するときには、ファイル操作プラグイン ( File
プラグイン ) を使用します ( ダウンロード時と同じく、ファイルは、 FileEtnry
オブジェクトとなります )。アップロード前に、 DirectoryEntry
の getFile
を使用して、アップロード用のファイルを作成/取得します。ここでは、アプリのキャッシュ用ディレクトリー ( fs.root
) 内にファイルを作成しています。次に、アップロードするコンテンツを渡して、 writeFile
関数を実行します。
function onUploadFile() {
window.requestFileSystem(window.TEMPORARY, 5 * 1024 * 1024, function (fs) {
console.log('file system open: ' + fs.name);
var fileName = "uploadSource.txt";
var dirEntry = fs.root;
dirEntry.getFile(fileName, { create: true, exclusive: false }, function (fileEntry) {
// Write something to the file before uploading it.
writeFile(fileEntry);
}, onErrorCreateFile);
}, onErrorLoadFs);
}
この例では、 FileWrite
オブジェクトを作成/取得して、次に、 upload
関数を実行しています。
function writeFile(fileEntry, dataObj) {
// Create a FileWriter object for our FileEntry (log.txt).
fileEntry.createWriter(function (fileWriter) {
fileWriter.onwriteend = function () {
console.log("Successful file write...");
upload(fileEntry);
};
fileWriter.onerror = function (e) {
console.log("Failed file write: " + e.toString());
};
if (!dataObj) {
dataObj = new Blob(['file data to upload'], { type: 'text/plain' });
}
fileWriter.write(dataObj);
});
}
ここでは、 upload
関数へ FileEntry
オブジェクトを渡しています。なお、実際のアップロード処理には、 FileTransfer
オブジェクトの upload
関数を使用します。
function upload(fileEntry) {
// !! Assumes variable fileURL contains a valid URL to a text file on the device,
var fileURL = fileEntry.toURL();
var success = function (r) {
console.log("Successful upload...");
console.log("Code = " + r.responseCode);
// displayFileData(fileEntry.fullPath + " (content uploaded to server)");
}
var fail = function (error) {
alert("An error has occurred: Code = " + error.code);
}
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();
// SERVER must be a URL that can handle the request, like
// http://some.server.com/upload.php
ft.upload(fileURL, encodeURI(SERVER), success, fail, options);
};
ファイルのダウンロード ( ここでは、先ほどの例で使用したファイルをダウンロードします )
先ほどアップロードしたテキストを、今度は、ダウンロードします ( 「 ファイルのアップロード 」 を参照のこと )。必要なものは、有効な URL です ( ダウンロード元を指す URL、たとえば、http://some.server.com/download.php )。 FileTransfer.download
メソッドの成功時のハンドラーには、 FileEntry
オブジェクトが渡されます。上記のダウンロードの例 ( 「 バイナリーファイルのダウンロード 」 を参照のこと ) と異なる点として、ここでは、ダウンロードの処理結果を読み込むときに、 FileReader.readAsText
を使用しています。これは、先ほどのアップロードの例 ( 「 ファイルのアップロード 」 を参照のこと ) では、テキスト形式のコンテンツとして、ファイルがアップロードされているためです。
function download(fileEntry, uri) {
var fileTransfer = new FileTransfer();
var fileURL = fileEntry.toURL();
fileTransfer.download(
uri,
fileURL,
function (entry) {
console.log("Successful download...");
console.log("download complete: " + entry.toURL());
readFile(entry);
},
function (error) {
console.log("download error source " + error.source);
console.log("download error target " + error.target);
console.log("upload error code" + error.code);
},
null, // or, pass false
{
//headers: {
// "Authorization": "Basic dGVzdHVzZXJuYW1lOnRlc3RwYXNzd29yZA=="
//}
}
);
}
readFile
関数内で、FileReader
オブジェクトの readAsText
メソッドを実行します。
function readFile(fileEntry) {
fileEntry.file(function (file) {
var reader = new FileReader();
reader.onloadend = function () {
console.log("Successful file read: " + this.result);
// displayFileData(fileEntry.fullPath + ": " + this.result);
};
reader.readAsText(file);
}, onErrorReadFile);
}
関連項目:
最終更新
役に立ちましたか?