You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ag...@apache.org on 2014/04/17 15:46:29 UTC
git commit: Add docs about the extraFileSystems
Repository: cordova-plugin-file
Updated Branches:
refs/heads/dev e0b096b07 -> 75ca074a3
Add docs about the extraFileSystems <preference>
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/75ca074a
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/tree/75ca074a
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/diff/75ca074a
Branch: refs/heads/dev
Commit: 75ca074a3610b4ce23a9111e05e4db3c79e18856
Parents: e0b096b
Author: Andrew Grieve <ag...@chromium.org>
Authored: Thu Apr 17 09:12:59 2014 -0400
Committer: Andrew Grieve <ag...@chromium.org>
Committed: Thu Apr 17 09:46:25 2014 -0400
----------------------------------------------------------------------
doc/index.md | 30 ++++++++++++++++++++++++++++++
1 file changed, 30 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/blob/75ca074a/doc/index.md
----------------------------------------------------------------------
diff --git a/doc/index.md b/doc/index.md
index 0b42623..744007d 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -39,6 +39,36 @@ on the subject. For an overview of other storage options, refer to Cordova's
\* _These platforms do not support `FileReader.readAsArrayBuffer` nor `FileWriter.write(blob)`._
+## Configuring the Plugin
+
+The set of available filesystems can be configured per-platform. Both iOS and
+Android recognize a <preference> tag in `config.xml` which names the
+filesystems to be installed. By default, all file-system roots are enabled.
+
+ <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" />
+
+### Android
+
+* files: The application's internal file storage directory
+* files-external: The application's external file storage directory
+* 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 Quirks
### Android Persistent storage location