CB-8438 cordova-plugin-file-transfer documentation translation: cordova-plugin-file-transfer

This commit is contained in:
Victor Sosa
2015-02-27 12:50:39 -06:00
parent fc2cdcca21
commit 5bdcc2d930
8 changed files with 367 additions and 352 deletions
+36 -24
View File
@@ -21,6 +21,16 @@
このプラグインは、アップロードし、ファイルをダウンロードすることができます。
このプラグインでは、グローバル `FileTransfer``FileUploadOptions` コンス トラクターを定義します。
グローバル スコープでは使用できませんまで `deviceready` イベントの後です。
document.addEventListener("deviceready", onDeviceReady, false);
function onDeviceReady() {
console.log(FileTransfer);
}
## インストール
cordova plugin add org.apache.cordova.file-transfer
@@ -31,21 +41,20 @@
* アマゾン火 OS
* アンドロイド
* ブラックベリー 10
* ブラウザー
* Firefox の OS * *
* iOS
* Windows Phone 7 と 8 *
* Windows 8 * * *|
* Windows * * *|
* Windows 8
* Windows
**サポートしていない `onprogress``abort()` *
* *`onprogress``abort()` をサポートしていません*
* **サポートしていない `onprogress` *
* * *`onprogress` をサポートしていません*
部分的なサポート `onprogress` のアップロード方法 `onprogress` は Windows limitations_ のための空のプログレスのイベントで呼び出されます。
# FileTransfer
# ファイル転送
`FileTransfer`オブジェクトはマルチパートのポスト、HTTP 要求を使用してファイルをアップロードして同様にファイルをダウンロードする方法を提供します。
`FileTransfer` オブジェクトはマルチパートのポスト、HTTP 要求を使用してファイルをアップロードして同様にファイルをダウンロードする方法を提供します。
## プロパティ
@@ -59,7 +68,7 @@
* **中止**: 進行中の転送を中止します。
## アップロード
## upload
**パラメーター**:
@@ -67,18 +76,19 @@
* **サーバー**: によって符号化されるように、ファイルを受信するサーバーの URL`encodeURI()`.
* **successCallback**: 渡されたコールバックを `Metadata` オブジェクト。*(機能)*
* **successCallback**: `FileUploadResult` オブジェクトが渡されるコールバック。*(機能)*
* **解り**: エラー取得が発生した場合に実行されるコールバック、 `Metadata` 。呼び出されると、 `FileTransferError` オブジェクト。*(機能)*
* **errorCallback**: エラー `FileUploadResult` を取得するが発生した場合に実行されるコールバック。`FileTransferError` オブジェクトを使って呼び出されます。*(機能)*
* **オプション**: 省略可能なパラメーター *(オブジェクト)*。有効なキー:
* **fileKey**: フォーム要素の名前。既定値は `file` です。(,)
* **ファイル名**: ファイル名、サーバー上のファイルを保存するときに使用します。既定値は `image.jpg` です。(,)
* **mime タイプ**: アップロードするデータの mime タイプ。既定値は `image/jpeg` です。(,)
* **httpMethod**: - `を置く` または `POST` のいずれかを使用する HTTP メソッド。デフォルト `のポスト` です。(,)
* **mimeType**: アップロードするデータの mime タイプ。`イメージ/jpeg` のデフォルトです。(,)
* **params**: HTTP リクエストに渡すために任意のキー/値ペアのセット。(オブジェクト)
* **chunkedMode**: チャンク ストリーミング モードでデータをアップロードするかどうか。既定値`true` です。(ブール値)
* **ヘッダー**: ヘッダーの名前/ヘッダー値のマップ。1 つ以上の値を指定するには、配列を使用します。(オブジェクト)
* **chunkedMode**: チャンク ストリーミング モードでデータをアップロードするかどうか。デフォルト`true` です。(ブール値)
* **headers**: ヘッダーの名前/ヘッダー値のマップ。1 つ以上の値を指定するには、配列を使用します。(オブジェクト)
* **trustAllHosts**: 省略可能なパラメーターは、デフォルト `false` 。 場合設定 `true` 、セキュリティ証明書をすべて受け付けます。 これは Android の自己署名入りセキュリティ証明書を拒否するので便利です。 運用環境で使用しないでください。 Android と iOS でサポートされています。 *(ブール値)*
@@ -152,7 +162,7 @@
## FileUploadResult
A `FileUploadResult` オブジェクトの成功時のコールバックに渡される、 `FileTransfer` オブジェクト `upload()` メソッド。
`FileUploadResult` オブジェクト `FileTransfer` オブジェクト `upload()` メソッドの成功時のコールバックに渡されます
### プロパティ
@@ -170,7 +180,7 @@ A `FileUploadResult` オブジェクトの成功時のコールバックに渡
* サポートしていない `responseCode` または`bytesSent`.
## ダウンロード
## download
**パラメーター**:
@@ -180,7 +190,7 @@ A `FileUploadResult` オブジェクトの成功時のコールバックに渡
* **successCallback**: 渡されたコールバックを `FileEntry` オブジェクト。*(機能)*
* **解り**: コールバックを取得するときにエラーが発生した場合に実行される、 `Metadata` 。呼び出されると、 `FileTransferError` オブジェクト。*(機能)*
* **errorCallback**: `FileEntry` を取得するときにエラーが発生した場合に実行されるコールバック。`FileTransferError` オブジェクトを使って呼び出されます。*(機能)*
* **trustAllHosts**: 省略可能なパラメーターは、デフォルト `false` 。 場合設定 `true` 、セキュリティ証明書をすべて受け付けます。 Android は、自己署名入りセキュリティ証明書を拒否しますので便利です。 運用環境で使用しないでください。 Android と iOS でサポートされています。 *(ブール値)*
@@ -214,7 +224,7 @@ A `FileUploadResult` オブジェクトの成功時のコールバックに渡
);
## 中止
## abort
進行中の転送を中止します。Onerror コールバックが FileTransferError.ABORT_ERR のエラー コードを持っている FileTransferError オブジェクトに渡されます。
@@ -246,7 +256,7 @@ A `FileUploadResult` オブジェクトの成功時のコールバックに渡
## FileTransferError
A `FileTransferError` オブジェクトは、エラーが発生エラー コールバックに渡されます。
`FileTransferError` オブジェクトは、エラーが発生したときにエラー コールバックに渡されます。
### プロパティ
@@ -258,7 +268,9 @@ A `FileTransferError` オブジェクトは、エラーが発生エラー コー
* **http_status**: HTTP ステータス コード。この属性は、HTTP 接続から応答コードを受信したときにのみ使用できます。(数)
* **例外**: どちらか e.getMessage または e.toString (文字列)
* **body**応答本体。この属性は、HTTP 接続から応答を受信したときにのみ使用できます。(文字列)
* **exception**: どちらか e.getMessage または e.toString (文字列)
### 定数
@@ -278,13 +290,13 @@ A `FileTransferError` オブジェクトは、エラーが発生エラー コー
下位互換性、これらのパスを使用しても、アプリケーションは、永続的なストレージでこのようなパスを記録している場合、し彼らが引き続き使用されます。
これらのパスに公開されていなかった、 `fullPath` のプロパティ `FileEntry` および `DirectoryEntry` ファイル プラグインによって返されるオブジェクト。 新しいプラグインのバージョン、ファイル、ただし、もはや java スクリプトの設定をこれらのパスを公開します。
これらのパス`FileEntry` やファイル プラグインによって返される `DirectoryEntry` オブジェクトの `fullPath` プロパティで公開されていなかった。 新しいプラグインのバージョン、ファイル、ただし、もはや java スクリプトの設定をこれらのパスを公開します。
新しいにアップグレードする場合 (1.0.0 以降) ファイルのバージョン以前を使用して `entry.fullPath` への引数として `download()` または `upload()` 、ファイルシステムの Url を代わりに使用するコードを変更する必要があります。
新しいにアップグレードする場合 (1.0.0 以降) ファイルのバージョン以前を使用している `entry.fullPath` `download()` または `upload()` への引数として、ファイルシステムの Url を代わりに使用するコードを変更する必要があります。
`FileEntry.toURL()``DirectoryEntry.toURL()`フォームのファイルシステムの URL を返す
`FileEntry.toURL()``DirectoryEntry.toURL()` ファイルシステムの URL を返すフォーム
cdvfile://localhost/persistent/path/to/file
両方のファイルの絶対パスの代わりに使用できる `download()` および `upload()` メソッド。
`download()``upload()` メソッドの絶対ファイル パスの代わりに使用できます