cordova-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ldel...@apache.org
Subject [08/17] git commit: Lisa testing pulling in plugins for plugin: cordova-plugin-file
Date Mon, 07 Jul 2014 17:50:45 GMT
Lisa testing pulling in plugins for plugin: cordova-plugin-file


Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/commit/d73a602f
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/tree/d73a602f
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/diff/d73a602f

Branch: refs/heads/master
Commit: d73a602f152ee028da270f6d31b1277280e4541f
Parents: d2fcdc1
Author: ldeluca <ldeluca@us.ibm.com>
Authored: Tue May 27 17:49:28 2014 -0400
Committer: ldeluca <ldeluca@us.ibm.com>
Committed: Tue May 27 17:49:28 2014 -0400

----------------------------------------------------------------------
 doc/ja/index.md   | 175 +++++++++++++++++++++++++++++++++++++++++++++++++
 doc/ja/plugins.md | 124 +++++++++++++++++++++++++++++++++++
 2 files changed, 299 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/blob/d73a602f/doc/ja/index.md
----------------------------------------------------------------------
diff --git a/doc/ja/index.md b/doc/ja/index.md
new file mode 100644
index 0000000..4351109
--- /dev/null
+++ b/doc/ja/index.md
@@ -0,0 +1,175 @@
+<!---
+    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
+
+This plugin provides the [HTML5 Filesystem API][1]. For usage, refer to HTML5 Rocks' [FileSystem
article][2] on the subject. For an overview of other storage options, refer to Cordova's [storage
guide][3].
+
+ [1]: http://dev.w3.org/2009/dap/file-system/pub/FileSystem/
+ [2]: http://www.html5rocks.com/en/tutorials/file/filesystem/
+ [3]: http://cordova.apache.org/docs/en/edge/cordova_storage_storage.md.html
+
+## インストール
+
+    cordova plugin add org.apache.cordova.file
+    
+
+## サポートされているプラットフォーム
+
+*   アマゾン火 OS
+*   アンドロイド
+*   BlackBerry 10*
+*   iOS
+*   Windows Phone 7 and 8*
+*   Windows 8*
+
+* *These platforms do not support `FileReader.readAsArrayBuffer` nor `FileWriter.write(blob)`.*
+
+## Configuring the Plugin
+
+利用可能なファイルシステムのセットは構成されたプラットフォームをすることができます。IOS
と Android の両方を認識します。 <preference> タグの `config.xml` をインストールするファイルシステムの名前します。既定では、すべてのファイル
システムのルートが有効になります。
+
+    <preference name="iosExtraFilesystems" value="library,library-nosync,documents,documents-nosync,cache,bundle,root"
/>
+    <preference name="AndroidExtraFilesystems" value="files,files-external,documents,sdcard,cache,cache-external,root"
/>
+    
+
+### アンドロイド
+
+*   ファイル: アプリケーションの内部ファイルのストレージ ディレクトリ
+*   外部ファイル: アプリケーションの外部のファイルのストレージ
ディレクトリ
+*   sdcard: The global external file storage directory (this is the root of the SD card,
if one is installed)
+*   cache: The application's internal cache directory
+*   cache-external: The application's external cache directory
+*   root: The entire device filesystem
+
+Android also supports a special filesystem named "documents", which represents a "/Documents/"
subdirectory within the "files" filesystem.
+
+### iOS
+
+*   library: The application's Library directory
+*   documents: The application's Documents directory
+*   cache: The application's Cache directory
+*   app-bundle: The application's bundle; the location of the app itself on disk
+*   root: The entire device filesystem
+
+By default, the library and documents directories can be synced to iCloud. You can also request
two additional filesystems, "library-nosync" and "documents-nosync", which represent a special
non-synced directory within the Library or Documents filesystem.
+
+## Android の癖
+
+### Android Persistent storage location
+
+There are multiple valid locations to store persistent files on an Android device. See [this
page][4] for an extensive discussion of the various possibilities.
+
+ [4]: http://developer.android.com/guide/topics/data/data-storage.html
+
+Previous versions of the plugin would choose the location of the temporary and persistent
files on startup, based on whether the device claimed that the SD Card (or equivalent storage
partition) was mounted. If the SD Card was mounted, or if a large internal storage partition
was available (such as on Nexus devices,) then the persistent files would be stored in the
root of that space. This meant that all Cordova apps could see all of the files available
on the card.
+
+If the SD card was not available, then previous versions would store data under /data/data/<packageid>,
which isolates apps from each other, but may still cause data to be shared between users.
+
+It is now possible to choose whether to store files in the internal file storage location,
or using the previous logic, with a preference in your application's config.xml file. To do
this, add one of these two lines to config.xml:
+
+    <preference name="AndroidPersistentFileLocation" value="Internal" />
+    
+    <preference name="AndroidPersistentFileLocation" value="Compatibility" />
+    
+
+この行がなければファイル プラグインは既定値として「互換性」を使用します。優先タグが存在し、これらの値の
1 つではない場合、アプリケーションは起動しません。
+
+アプリケーションは、ユーザーに以前出荷されている場合、古い (前
1.0) を使用して、このプラグインのバージョンし、永続的なファイルシステムに保存されているファイルには「互換性」を設定する必要があります。
自分のアプリケーションをアップグレードする既存のユーザーを彼らの装置によって、以前に保存されたファイルにアクセスすることができることがあることを意味する「内部」に場所をスイッチングします。
+
+アプリケーション場合は、新しい、または永続的なファイルシステムにファイルが格納され以前は決して、「内部」の設定は推奨一般に。
+
+## ブラックベリーの癖
+
+`DirectoryEntry.removeRecursively()`失敗する可能性があります、 `ControlledAccessException`
、次の場合。
+
+*   アプリは、アプリの以前のインストールによって作成されたディレクトリにアクセスしようとします。
+
+> 解決策: 手動で、または再インストールする前にアプリケーションによって一時ディレクトリはきれいに確認してください。
+
+*   場合は、デバイスは USB で接続されました。
+
+> ソリューション: 再実行して、デバイスから USB ケーブルを外します。
+
+## iOS の癖
+
+*   `FileReader.readAsText(blob, encoding)` 
+    *   `encoding`パラメーターはサポートされていませんし、utf-8 エンコーディングが常に有効です。
+
+### iOS の永続的なストレージの場所
+
+IOS デバイスに永続的なファイルを格納する 2 つの有効な場所がある:
ドキュメントとライブラリのディレクトリ。 プラグインの以前のバージョンは、唯一のこれまでドキュメント
ディレクトリに永続的なファイルを格納されます。 これは、ディレクトリの目的は、輸出のための完全なドキュメントを作成するのではなくなかったがしばしば意図されていたり、特に多数の小さいファイルを処理するアプリケーションの場合、iTunes
に表示されているすべてのアプリケーションのファイルを作るの副作用があった。
+
+ドキュメントまたはアプリケーションの config.xml ファイルに優先順位のライブラリ
ディレクトリにファイルを保存するかどうかを選択することが可能です今。
これを行うに、config.xml に次の 2 行のいずれかを追加します。
+
+    <preference name="iosPersistentFileLocation" value="Library" />
+    
+    <preference name="iosPersistentFileLocation" value="Compatibility" />
+    
+
+この行がなければファイル プラグインは既定値として「互換性」を使用します。優先タグが存在し、これらの値の
1 つではない場合、アプリケーションは起動しません。
+
+アプリケーションは、ユーザーに以前出荷されている場合、古い (前
1.0) を使用して、このプラグインのバージョンし、永続的なファイルシステムに保存されているファイルには「互換性」を設定する必要があります。
自分のアプリケーションをアップグレードする既存のユーザーを以前に保存されたファイルにアクセスすることができるだろうことを意味する「ライブラリ」に場所をスイッチングします。
+
+アプリケーション場合は、新しい、または永続的なファイルシステムにファイルが格納され以前は決して、「ライブラリ」設定は推奨一般に。
+
+## ノートをアップグレードします。
+
+このプラグインのデベロッパーで、 `FileEntry` と `DirectoryEntry` 構造変更、公開された仕様に沿ったより多くであります。
+
+プラグインの前 (pre 1.0.0) バージョン、デバイス-絶対-ファイルの場所に格納されている、
`fullPath` のプロパティ `Entry` オブジェクト。これらのパスはようになります通常
+
+    /var/mobile/Applications/<application UUID>/Documents/path/to/file  (iOS)
+    /storage/emulated/0/path/to/file                                    (Android)
+    
+
+これらのパスはまたによって返された、 `toURL()` 法、 `Entry` オブジェクト。
+
+デベロッパーと、 `fullPath` 属性は、 *HTML のファイルシステムのルートに対する相対パス*のファイルへのパス。
したがって、上記のパスは両方によって表される今、 `FileEntry` オブジェクトが、
`fullPath` の
+
+    /path/to/file
+    
+
+If your application works with device-absolute-paths, and you previously retrieved those
paths through the `fullPath` property of `Entry` objects, then you should update your code
to use `entry.toURL()` instead. このメソッドは、フォームのファイルシステムの
Url を返します今
+
+    cdvfile://localhost/persistent/path/to/file
+    
+
+which can be used to identify the file uniquely.
+
+For backwards compatibility, the `resolveLocalFileSystemURL()` method will accept a device-absolute-path,
and will return an `Entry` object corresponding to it, as long as that file exists within
either the TEMPORARY or PERSISTENT filesystems.
+
+これは特に以前デバイス絶対パスを使用してファイル転送のプラグインで問題となっている
(そしてまだそれらを受け入れることができます)。 ので交換、ファイルシステムの
Url で正しく動作するように更新されている `entry.fullPath` と `entry.toURL()`
デバイス上のファイルで動作するプラグインを得て問題を解決する必要があります。
+
+## エラー コードと意味のリスト
+
+エラーがスローされると、次のコードのいずれかが使用されます。
+
+*   1 = NOT\_FOUND\_ERR
+*   2 = SECURITY_ERR
+*   3 = ABORT_ERR
+*   4 = NOT\_READABLE\_ERR
+*   5 = ENCODING_ERR
+*   6 = NO\_MODIFICATION\_ALLOWED_ERR
+*   7 = INVALID\_STATE\_ERR
+*   8 = SYNTAX_ERR
+*   9 = INVALID\_MODIFICATION\_ERR
+*   10 = QUOTA\_EXCEEDED\_ERR
+*   11 = TYPE\_MISMATCH\_ERR
+*   12 = PATH\_EXISTS\_ERR
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/blob/d73a602f/doc/ja/plugins.md
----------------------------------------------------------------------
diff --git a/doc/ja/plugins.md b/doc/ja/plugins.md
new file mode 100644
index 0000000..1a0efa1
--- /dev/null
+++ b/doc/ja/plugins.md
@@ -0,0 +1,124 @@
+<!---
+    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.
+-->
+
+# Notes for plugin developers
+
+これらのノートは、主に人造人間と iOS 開発者向けファイルのプラグインを使用して、ファイル
システムでプラグインのインターフェイスを記述するもの。
+
+## コルドバのファイル システムの Url の操作
+
+バージョン 1.0.0 以降このプラグインが使用した Url とは `cdvfile` raw
デバイス ファイル システム パスを JavaScript に公開するのではなく、ブリッジ上のすべての通信方式します。
+
+JavaScript 側認証と DirectoryEntry オブジェクトの HTML ファイル システムのルートからの相対である
fullPath 属性があることを意味します。 呼び出す必要がありますプラグインの
JavaScript API は、認証または DirectoryEntry オブジェクトを受け入れる場合
`.toURL()` 、橋を渡ってネイティブ コードに渡す前に、そのオブジェクト。
+
+### Cdvfile を変換する://fileystem のパスに Url
+
+ファイルシステムへの書き込みする必要があるプラグインは実際のファイルシステムの場所に受信ファイル用の
URL を変換したい可能性があります。ネイティブのプラットフォームによって、これを行うための複数の方法があります。
+
+覚えておくことが重要ですすべてではない `cdvfile://` の Url はデバイス上の実際のファイルをマッピング可能な。
いくつかの Url は、ファイルでは表されないまたはリモートのリソースを参照することができますもをデバイス上の資産を参照できます。
プラグインはこれらの可能性のために彼らの Url パスに変換するしようとしているときに戻って、有意義な結果を得るかどうか常にテスト必要があります。
+
+#### アンドロイド
+
+Android 上で変換する最も簡単な方法は `cdvfile://` を使用してファイルシステムのパスに
URL が `org.apache.cordova.CordovaResourceApi` 。 `CordovaResourceApi`扱うことができるいくつかの方法があります
`cdvfile://` Url:
+
+    // webView is a member of the Plugin class
+    CordovaResourceApi resourceApi = webView.getResourceApi();
+    
+    // Obtain a file:/// URL representing this file on the device,
+    // or the same URL unchanged if it cannot be mapped to a file
+    Uri fileURL = resourceApi.remapUri(Uri.parse(cdvfileURL));
+    
+
+また、ファイル プラグインを直接使用することが可能です。
+
+    import org.apache.cordova.file.FileUtils;
+    import org.apache.cordova.file.FileSystem;
+    import java.net.MalformedURLException;
+    
+    // Get the File plugin from the plugin manager
+    FileUtils filePlugin = (FileUtils)webView.pluginManager.getPlugin("File");
+    
+    // Given a URL, get a path for it
+    try {
+        String path = filePlugin.filesystemPathForURL(cdvfileURL);
+    } catch (MalformedURLException e) {
+        // The filesystem url wasn't recognized
+    }
+    
+
+パスから変換する、 `cdvfile://` の URL:
+
+    import org.apache.cordova.file.LocalFilesystemURL;
+    
+    // Get a LocalFilesystemURL object for a device path,
+    // or null if it cannot be represented as a cdvfile URL.
+    LocalFilesystemURL url = filePlugin.filesystemURLforLocalPath(path);
+    // Get the string representation of the URL object
+    String cdvfileURL = url.toString();
+    
+
+あなたのプラグインは、ファイルを作成し、認証オブジェクトを返す場合ファイルのプラグインを使用:
+
+    // Return a JSON structure suitable for returning to JavaScript,
+    // or null if this file is not representable as a cdvfile URL.
+    JSONObject entry = filePlugin.getEntryForFile(file);
+    
+
+#### iOS
+
+IOS にコルドバと同じ使用しない `CordovaResourceApi` アンドロイドとして概念。IOS、上ファイル
プラグインを使用して Url をファイルシステムのパスに変換する必要があります。
+
+    // Get a CDVFilesystem URL object from a URL string
+    CDVFilesystemURL* url = [CDVFilesystemURL fileSystemURLWithString:cdvfileURL];
+    // Get a path for the URL object, or nil if it cannot be mapped to a file
+    NSString* path = [filePlugin filesystemPathForURL:url];
+    
+    
+    // Get a CDVFilesystem URL object for a device path, or
+    // nil if it cannot be represented as a cdvfile URL.
+    CDVFilesystemURL* url = [filePlugin fileSystemURLforLocalPath:path];
+    // Get the string representation of the URL object
+    NSString* cdvfileURL = [url absoluteString];
+    
+
+あなたのプラグインは、ファイルを作成し、認証オブジェクトを返す場合ファイルのプラグインを使用:
+
+    // Get a CDVFilesystem URL object for a device path, or
+    // nil if it cannot be represented as a cdvfile URL.
+    CDVFilesystemURL* url = [filePlugin fileSystemURLforLocalPath:path];
+    // Get a structure to return to JavaScript
+    NSDictionary* entry = [filePlugin makeEntryForLocalURL:url]
+    
+
+#### Java スクリプトの設定
+
+Java スクリプトの設定を取得するには `cdvfile://` 認証または DirectoryEntry
オブジェクトから URL を単に呼び出す `.toURL()` に:
+
+    var cdvfileURL = entry.toURL();
+    
+
+プラグインハンドラーの応答で返された FileEntry 構造体の実際のエントリ
オブジェクトを変換するハンドラーのコードする必要がありますファイル
プラグインをインポートし、新しいオブジェクトを作成します。
+
+    // create appropriate Entry object
+    var entry;
+    if (entryStruct.isDirectory) {
+        entry = new DirectoryEntry(entryStruct.name, entryStruct.fullPath, new FileSystem(entryStruct.filesystemName));
+    } else {
+        entry = new FileEntry(entryStruct.name, entryStruct.fullPath, new FileSystem(entryStruct.filesystemName));
+    }
\ No newline at end of file


Mime
View raw message