Return-Path: X-Original-To: apmail-cordova-commits-archive@www.apache.org Delivered-To: apmail-cordova-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id AC7E611214 for ; Wed, 23 Apr 2014 19:00:05 +0000 (UTC) Received: (qmail 3228 invoked by uid 500); 23 Apr 2014 18:57:31 -0000 Delivered-To: apmail-cordova-commits-archive@cordova.apache.org Received: (qmail 2371 invoked by uid 500); 23 Apr 2014 18:57:08 -0000 Mailing-List: contact commits-help@cordova.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cordova.apache.org Delivered-To: mailing list commits@cordova.apache.org Received: (qmail 2007 invoked by uid 99); 23 Apr 2014 18:56:59 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 23 Apr 2014 18:56:59 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 899C998F25B; Wed, 23 Apr 2014 18:56:58 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: ian@apache.org To: commits@cordova.apache.org Date: Wed, 23 Apr 2014 18:57:31 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [35/37] git commit: Add docs about the extraFileSystems Add docs about the extraFileSystems 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/master Commit: 75ca074a3610b4ce23a9111e05e4db3c79e18856 Parents: e0b096b Author: Andrew Grieve Authored: Thu Apr 17 09:12:59 2014 -0400 Committer: Andrew Grieve 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 tag in `config.xml` which names the +filesystems to be installed. By default, all file-system roots are enabled. + + + + +### 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