檔案傳輸

FileTransfer物件允許你上傳或下載檔案，伺服器和用戶端。

屬性

  • onprogress： 使用調用 ProgressEvent 每當一塊新的資料傳輸。（函數）

方法

  • 上傳： 將檔發送到伺服器。

  • 下載： 從伺服器上下載檔案。

  • 中止: 中止正在進行轉讓。

詳細資訊

FileTransfer物件提供一種方法將檔上載到遠端伺服器使用多部分的 HTTP POST 請求。 支援 HTTP 和 HTTPS 協定。 可以通過指定可選參數 [FileUploadOptions](../fileuploadoptions/fileuploadoptions.html) 物件的 upload() 方法。 上傳成功， [FileUploadResult](../fileuploadresult/fileuploadresult.html) 物件傳遞給成功回檔。 如果發生錯誤， [FileTransferError](../filetransfererror/filetransfererror.html) 物件傳遞到錯誤回檔。 它也是可能的 （只在 iOS 和 Android） 從遠端伺服器下載檔案並將其保存在設備上。

支援的平臺

  • Android 系統
  • 黑莓手機 WebWorks （OS 5.0 和更高）
  • iOS
  • Windows Phone 7 和 8
  • Windows 8

上傳

參數：

  • 檔路徑: 設備上的檔的完整路徑。

  • 伺服器： 伺服器以接收該檔，由編碼的 URLencodeURI().

  • successCallback： 傳遞一個回檔 Metadata 物件。（函數）

  • errorCallback： 回檔的執行如果出現檢索錯誤 Metadata 。調用與 [FileTransferError](../filetransfererror/filetransfererror.html) 物件。（函數）

  • 選項： 檔案名稱和 mimetype 等可選參數。

  • trustAllHosts: 可選參數，預設值為 false 。 如果設置為 true ，它可以接受的所有安全證書。 由於 Android 拒絕自行簽署式安全證書，這非常有用。 不建議供生產使用。 在 Android 和 iOS 上受支援。 (布林值)

快速的示例

// !! Assumes variable fileURI contains a valid URI to a text file on the device

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 = fileURI.substr(fileURI.lastIndexOf('/') + 1);
options.mimeType = "text/plain";

var params = {};
params.value1 = "test";
params.value2 = "param";

options.params = params;

var ft = new FileTransfer();
ft.upload(fileURI, encodeURI("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 Example</title>

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

        // Wait for device API libraries to load
        //
        document.addEventListener("deviceready", onDeviceReady, false);

        // device APIs are available
        //
        function onDeviceReady() {
            // Retrieve image file location from specified source
            navigator.camera.getPicture(
                uploadPhoto,
                function(message) { alert('get picture failed'); },
                {
                    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 = {};
            params.value1 = "test";
            params.value2 = "param";

            options.params = params;

            var ft = new FileTransfer();
            ft.upload(imageURI, 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);
        }

        </script>
</head>
<body>
    <h1>Example</h1>
    <p>Upload File</p>
</body>
</html>

設置上傳標頭

在 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=fileURI.substr(fileURI.lastIndexOf('/')+1);
options.mimeType="text/plain";

var headers={'headerParam':'headerValue'};

options.headers = headers;

var ft = new FileTransfer();
ft.upload(fileURI, uri, win, fail, options);

Android 的怪癖

設置 chunkedMode 選項 false ，防止將上載到 Nginx 伺服器的問題。

下載

參數：

  • 來源： 要下載的檔，如由編碼的伺服器的 URLencodeURI().

  • 目標： 在設備上的檔的完整路徑。

  • successCallback： 傳遞一個回檔 [FileEntry](../fileentry/fileentry.html) 物件。（函數）

  • errorCallback： 如果錯誤發生在檢索時將執行的回檔 Metadata 。調用與 [FileTransferError](../filetransfererror/filetransfererror.html) 物件。（函數）

  • trustAllHosts: 可選參數，預設值為 false 。 如果設置為 true 然後它將接受所有安全證書。 隨著 Android 拒絕自我簽署的安全證書，這非常有用。 不建議供生產使用。 在 Android 和 iOS 上受支援。 (布林值)

  • 選項： 可選參數，目前只支援標題 （如授權 （基本驗證） 等）。

快速的示例

// !! 假定檔路徑是設備 var 檔案傳輸的有效路徑 = 新 FileTransfer() ；var uri = encodeURI ("HTTP://some.server.com/download.php"） ；fileTransfer.download (uri，檔路徑，function(entry) {console.log ("下載完成："+ entry.fullPath） ；}，function(error) {console.log ("下載錯誤源"+ error.source) ；console.log ("下載錯誤目標"+ error.target) ；console.log ("上傳錯誤代碼"+ error.code) ；}，false，{標題： {"授權書"："基本 dGVzdHVzZXJuYW1lOnRlc3RwYXNzd29yZA = ="}}) ；

中止

中止正在進行轉讓。Onerror 回檔傳遞的錯誤代碼為 FileTransferError.ABORT_ERR 的 FileTransferError 物件。

支援的平臺

  • Android 系統
  • iOS

快速的示例

// !! 假定變數 fileURI 包含有效的 URI 到一個文字檔中，對設備無功贏 = function(r) {console.log ("不應調用。");}var 失敗 = function(error) {/ / error.code = = FileTransferError.ABORT_ERR 警報 ("發生了一個錯誤： 代碼 ="+ error.code） ；console.log （"上傳錯誤源"+ error.source） ；console.log ("上傳錯誤目標"+ error.target);}var 選項 = 新 FileUploadOptions() ；options.fileKey="file"；options.fileName="myphoto.jpg"；options.mimeType="image/jpeg"；var ft = 新 FileTransfer() ；ft.upload （fileURI、 encodeURI ("HTTP://some.server.com/upload.php"）、 贏、 失敗、 選項） ；ft.abort() ；

onprogress

每當新的資料區塊轉移與 ProgressEvent 調用。

支援的平臺

  • Android 系統
  • iOS

示例

fileTransfer.onprogress = function(progressEvent) {
    if (progressEvent.lengthComputable) {
      loadingStatus.setPercentage(progressEvent.loaded / progressEvent.total);
    } else {
      loadingStatus.increment();
    }
};
fileTransfer.download(...); // or fileTransfer.upload(...);

怪癖-在這兩個一個 iOS，Android 上 lengthComputable 是 false 使用 gzip 已編碼的下載。