You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ld...@apache.org on 2014/07/07 19:50:52 UTC
[07/14] git commit: Lisa testing pulling in plugins for plugin:
cordova-plugin-file-transfer
Lisa testing pulling in plugins for plugin: cordova-plugin-file-transfer
Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file-transfer/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file-transfer/commit/0a2e3cb6
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file-transfer/tree/0a2e3cb6
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file-transfer/diff/0a2e3cb6
Branch: refs/heads/master
Commit: 0a2e3cb62f9f699a28148645bae9565dd6506ac4
Parents: 3fb0405
Author: ldeluca <ld...@us.ibm.com>
Authored: Tue May 27 17:49:32 2014 -0400
Committer: ldeluca <ld...@us.ibm.com>
Committed: Tue May 27 17:49:32 2014 -0400
----------------------------------------------------------------------
doc/ja/index.md | 281 +++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 281 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-plugin-file-transfer/blob/0a2e3cb6/doc/ja/index.md
----------------------------------------------------------------------
diff --git a/doc/ja/index.md b/doc/ja/index.md
new file mode 100644
index 0000000..b57d591
--- /dev/null
+++ b/doc/ja/index.md
@@ -0,0 +1,281 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# org.apache.cordova.file-transfer
+
+This plugin allows you to upload and download files.
+
+## インストール
+
+ cordova plugin add org.apache.cordova.file-transfer
+
+
+## サポートされているプラットフォーム
+
+* アマゾン火 OS
+* アンドロイド
+* BlackBerry 10*
+* iOS
+* Windows Phone 7 and 8*
+* Windows 8*
+
+* *Do not support `onprogress` nor `abort()`*
+
+# ファイル転送
+
+The `FileTransfer` object provides a way to upload files using an HTTP multi-part POST request, and to download files as well.
+
+## プロパティ
+
+* **onprogress**: と呼ばれる、 `ProgressEvent` データの新しいチャンクが転送されるたびに。*(機能)*
+
+## メソッド
+
+* **アップロード**: サーバーにファイルを送信します。
+
+* **ダウンロード**: サーバーからファイルをダウンロードします。
+
+* **中止**: 進行中の転送を中止します。
+
+## アップロード
+
+**パラメーター**:
+
+* **fileURL**: Filesystem URL representing the file on the device. For backwards compatibility, this can also be the full path of the file on the device. （参照してください [後方互換性メモ] の下)
+
+* **サーバー**: によって符号化されるように、ファイルを受信するサーバーの URL`encodeURI()`.
+
+* **successCallback**: 渡されたコールバックを `Metadata` オブジェクト。*(機能)*
+
+* **解り**: エラー取得が発生した場合に実行されるコールバック、 `Metadata` 。呼び出されると、 `FileTransferError` オブジェクト。*(機能)*
+
+* **trustAllHosts**: 省略可能なパラメーターは、デフォルト `false` 。 場合設定 `true` 、セキュリティ証明書をすべて受け付けます。 これは Android の自己署名入りセキュリティ証明書を拒否するので便利です。 運用環境で使用しないでください。 Android と iOS でサポートされています。 *(ブール値)*
+
+* **options**: Optional parameters *(Object)*. Valid keys:
+
+ * **fileKey**: フォーム要素の名前。既定値は `file` です。（，）
+ * **ファイル名**： ファイル名、サーバー上のファイルを保存するときに使用します。既定値は `image.jpg` です。（，）
+ * **mime タイプ**: アップロードするデータの mime タイプ。既定値は `image/jpeg` です。（，）
+ * **params**: HTTP リクエストに渡すために任意のキー/値ペアのセット。(オブジェクト)
+ * **chunkedMode**: チャンク ストリーミング モードでデータをアップロードするかどうか。既定値は `true` です。(ブール値)
+ * **ヘッダー**: ヘッダーの名前/ヘッダー値のマップ。1 つ以上の値を指定するには、配列を使用します。(オブジェクト)
+
+### 例
+
+ // !! 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);
+
+
+### Example with Upload Headers and Progress Events (Android and iOS only)
+
+ 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
+
+A `FileUploadResult` オブジェクトの成功時のコールバックに渡される、 `FileTransfer` オブジェクトの `upload()` メソッド。
+
+### プロパティ
+
+* **bytesSent**: アップロードの一部としてサーバーに送信されたバイト数。（ロング）
+
+* **記述**: サーバーによって返される HTTP 応答コード。（ロング）
+
+* **応答**: サーバーによって返される HTTP 応答。（，）
+
+* **ヘッダー**: HTTP 応答ヘッダー サーバーによって。(オブジェクト)
+
+ * 現在 iOS のみでサポートされます。
+
+### iOS の癖
+
+* サポートしていない `responseCode` または`bytesSent`.
+
+## ダウンロード
+
+**パラメーター**:
+
+* **ソース**: によって符号化されるように、ファイルをダウンロードするサーバーの URL`encodeURI()`.
+
+* **ターゲット**: デバイス上のファイルを表すファイルシステム url。 下位互換性は、このことも、デバイス上のファイルの完全パスであります。 （参照してください [後方互換性メモ] の下)
+
+* **successCallback**: 渡されたコールバックを `FileEntry` オブジェクト。*(機能)*
+
+* **解り**: コールバックを取得するときにエラーが発生した場合に実行される、 `Metadata` 。呼び出されると、 `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.fullPath);
+ },
+ 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=="
+ }
+ }
+ );
+
+
+## 中止
+
+進行中の転送を中止します。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
+
+A `FileTransferError` オブジェクトは、エラーが発生エラー コールバックに渡されます。
+
+### プロパティ
+
+* **コード**: 次のいずれかの定義済みのエラー コード。(数)
+
+* **ソース**: ソースの URL。(文字列)
+
+* **ターゲット**: 先の URL。(文字列)
+
+* **http_status**: HTTP ステータス コード。この属性は、HTTP 接続から応答コードを受信したときにのみ使用できます。(数)
+
+### 定数
+
+* `FileTransferError.FILE_NOT_FOUND_ERR`
+* `FileTransferError.INVALID_URL_ERR`
+* `FileTransferError.CONNECTION_ERR`
+* `FileTransferError.ABORT_ERR`
+
+## 後方互換性をノートします。
+
+このプラグインの以前のバージョンまたはダウンロードのターゲットとして、アップロードのソースとしてのみデバイス絶対ファイル パスを受け入れるでしょう。これらのパスの形式は、通常
+
+ /var/mobile/Applications/<application UUID>/Documents/path/to/file (iOS)
+ /storage/emulated/0/path/to/file (Android)
+
+
+下位互換性、これらのパスを使用しても、アプリケーションは、永続的なストレージでこのようなパスを記録している場合、し彼らが引き続き使用されます。
+
+これらのパスに公開されていなかった、 `fullPath` のプロパティ `FileEntry` および `DirectoryEntry` ファイル プラグインによって返されるオブジェクト。 新しいプラグインのバージョン、ファイル、ただし、もはや java スクリプトの設定をこれらのパスを公開します。
+
+新しいにアップグレードする場合 (1.0.0 以降) ファイルのバージョンが以前を使用して `entry.fullPath` への引数として `download()` または `upload()` 、ファイルシステムの Url を代わりに使用するコードを変更する必要があります。
+
+`FileEntry.toURL()``DirectoryEntry.toURL()`フォームのファイルシステムの URL を返す
+
+ cdvfile://localhost/persistent/path/to/file
+
+
+両方のファイルの絶対パスの代わりに使用できる `download()` および `upload()` メソッド。
\ No newline at end of file