FileTransfer

FileTransfer オブジェクトはファイルをサーバーにアップロードまたはサーバからダウンロードする際に使用します。

プロパティー

なし

メソッド

  • upload: サーバーにファイルを送信
  • download: サーバーからファイルをダウンロード

詳細

FileTransfer オブジェクトは HTTP マルチパート POST リクエストを使ってファイルをサーバーにアップロードする機能を提供します。このメソッドは HTTP と HTTPS の両方のプロトコルをサポートします。 upload メソッドに FileUploadOptions オブジェクトを渡すことで、任意のパラメーターを追加できます。アップロードが成功した場合 FileUploadResult オブジェクトとともに success コールバック関数が呼ばれます。エラーが発生した場合は FileTransferError オブジェクトとともに error コールバック関数が呼ばれます。 また、サーバーからファイルをダウンロードし保存することもできます (iOS と Android のみ) 。

サポートされているプラットフォーム

  • Android
  • BlackBerry WebWorks (OS 5.0 以上)
  • iOS
  • Windows Phone 7 (Mango)

upload

パラメーター:

  • filePath - デバイス内のファイルのフルパスを表します
  • server - ファイルを受け取るサーバーの URL を表します
  • successCallback - Metadata オブジェクトを伴って呼び出されるコールバック関数を表します (Function)
  • errorCallback - Metadata の取得時にエラーが起きた場合に呼び出されるコールバック関数を表します。 FileError オブジェクトを伴って呼び出されます (Function)
  • options - ファイル名や minetype などのオプションのパラメーターを表します

使用例

// !! fileURI の値は有効なデバイス内の有効なテキストファイルの URI であるとみなします

var win = function(r) {
    console.log("コード = " + r.responseCode);
    console.log("結果 = " + r.response);
    console.log("送信バイト数 = " + r.bytesSent);
}

var fail = function(error) {
    alert("エラーが発生しました: 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=fileURI.substr(fileURI.lastIndexOf('/')+1);
options.mimeType="text/plain";

var params = new Object();
params.value1 = "test";
params.value2 = "param";

options.params = params;

var ft = new FileTransfer();
ft.upload(fileURI, "http://some.server.com/upload.php", win, fail, options);

詳細な使用例

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
  <head>
    <title>File Transfer の使用例</title>

    <script type="text/javascript" charset="utf-8" src="cordova-1.8.1.js"></script>
    <script type="text/javascript" charset="utf-8">

        // Cordova の読み込み完了まで待機
        //
        document.addEventListener("deviceready", onDeviceReady, false);

        // Cordova 準備完了
        //
        function onDeviceReady() {

            // 写真をファイル URI として取得する場合
            navigator.camera.getPicture(uploadPhoto,
                                        function(message) { alert('写真の取得に失敗しました'); },
                                        { quality: 50,
                                        destinationType: navigator.camera.DestinationType.FILE_URI,
                                        sourceType: navigator.camera.PictureSourceType.PHOTOLIBRARY }
                                        );

        }

        function uploadPhoto(imageURI) {
            var options = new FileUploadOptions();
            options.fileKey="file";
            options.fileName=imageURI.substr(imageURI.lastIndexOf('/')+1);
            options.mimeType="image/jpeg";

            var params = new Object();
            params.value1 = "test";
            params.value2 = "param";

            options.params = params;

            var ft = new FileTransfer();
            ft.upload(imageURI, "http://some.server.com/upload.php", win, fail, options);
        }

        function win(r) {
            console.log("コード = " + r.responseCode);
            console.log("結果 = " + r.response);
            console.log("送信バイト数 = " + r.bytesSent);
        }

        function fail(error) {
            alert("エラーが発生しました: Code = " + error.code);
            console.log("upload error source " + error.source);
            console.log("upload error target " + error.target);
        }

     </script>
   </head>
   <body>
     <h1>使用例</h1>
     <p>ファイルアップロード</p>
   </body>
</html>

download

パラメーター:

  • source - ファイルを取得するサーバーの URL を表します
  • target - デバイス内のファイルのフルパスを表します
  • successCallback - FileEntry オブジェクトを伴って呼び出されるコールバック関数を表します (Function)
  • errorCallback - Metadata の取得時にエラーが起きた場合に呼び出されるコールバック関数を表します。 FileError オブジェクトを伴って呼び出されます (Function)

使用例

// !! url はサーバー内の有効なファイルを指すことと filePath がデバイス内の有効な値であるとみなします

var fileTransfer = new FileTransfer();

fileTransfer.download(
    url,
    filePath,
    function(entry) {
        console.log("ダウンロード完了: " + entry.fullPath);
    },
    function(error) {
        console.log("download error source " + error.source);
        console.log("download error target " + error.target);
        console.log("upload error code" + error.code);
    }
);