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/07/14 21:30:01 UTC
git commit: CB-7057 Docs update: elaborate on what directories are for
Repository: cordova-plugin-file
Updated Branches:
refs/heads/master f51331fcd -> 8b832d41b
CB-7057 Docs update: elaborate on what directories are for
close #59
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/8b832d41
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/tree/8b832d41
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/diff/8b832d41
Branch: refs/heads/master
Commit: 8b832d41ba39ba6807cf41ef079d7e93346e7677
Parents: f51331f
Author: Kerri Shotts <ke...@gmail.com>
Authored: Mon Jun 30 20:06:37 2014 -0500
Committer: Andrew Grieve <ag...@chromium.org>
Committed: Mon Jul 14 15:29:57 2014 -0400
----------------------------------------------------------------------
doc/index.md | 181 +++++++++++++++++++++++++++++++++++++++---------------
1 file changed, 132 insertions(+), 49 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/blob/8b832d41/doc/index.md
----------------------------------------------------------------------
diff --git a/doc/index.md b/doc/index.md
index a6dc97e..0b4d3cb 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -62,27 +62,103 @@ As of v1.2.0, URLs to important file-system directories are provided.
Each URL is in the form _file:///path/to/spot/_, and can be converted to a
`DirectoryEntry` using `window.resolveLocalFileSystemURL()`.
-`cordova.file.applicationDirectory` - Read-only directory where the application is installed. (_iOS_, _Android_)
+* `cordova.file.applicationDirectory` - Read-only directory where the application
+ is installed. (_iOS_, _Android_)
-`cordova.file.applicationStorageDirectory` - Root of app's private writable storage. (_iOS_, _Android_)
+* `cordova.file.applicationStorageDirectory` - Root directory of the application's
+ sandbox; on iOS this location is read-only (but specific subdirectories [like
+ `/Documents`] are read-write). All data contained within is private to the app. (
+ _iOS_, _Android_)
-`cordova.file.dataDirectory` - Where to put app-specific data files. (_iOS_, _Android_)
+* `cordova.file.dataDirectory` - Persistent and private data storage within the
+ application's sandbox using internal memory (on Android, if you need to use
+ external memory, use `.externalDataDirectory`). On iOS, this directory is not
+ synced with iCloud (use `.syncedDataDirectory`). (_iOS_, _Android_)
-`cordova.file.cacheDirectory` - Cached files that should survive app restarts. Apps should not rely on the OS to delete files in here. (_iOS_, _Android_)
+* `cordova.file.cacheDirectory` - Directory for cached data files or any files
+ that your app can re-create easily. The OS may delete these files when the device
+ runs low on storage, nevertheless, apps should not rely on the OS to delete files
+ in here. (_iOS_, _Android_)
-`cordova.file.externalApplicationStorageDirectory` - Application space on external storage. (_iOS_, _Android_)
+* `cordova.file.externalApplicationStorageDirectory` - Application space on
+ external storage. (_Android_)
-`cordova.file.externalDataDirectory` - Where to put app-specific data files on external storage. (_Android_)
+* `cordova.file.externalDataDirectory` - Where to put app-specific data files on
+ external storage. (_Android_)
-`cordova.file.externalCacheDirectory` - Application cache on external storage. (_Android_)
+* `cordova.file.externalCacheDirectory` - Application cache on external storage.
+ (_Android_)
-`cordova.file.externalRootDirectory` - External storage (SD card) root. (_Android_)
+* `cordova.file.externalRootDirectory` - External storage (SD card) root. (_Android_)
-`cordova.file.tempDirectory` - Temp directory that the OS can clear at will. (_iOS_)
+* `cordova.file.tempDirectory` - Temp directory that the OS can clear at will. Do not
+ rely on the OS to clear this directory; your app should always remove files as
+ applicable. (_iOS_)
-`cordova.file.syncedDataDirectory` - Holds app-specific files that should be synced (e.g. to iCloud). (_iOS_)
+* `cordova.file.syncedDataDirectory` - Holds app-specific files that should be synced
+ (e.g. to iCloud). (_iOS_)
-`cordova.file.documentsDirectory` - Files private to the app, but that are meaningful to other applciations (e.g. Office files). (_iOS_)
+* `cordova.file.documentsDirectory` - Files private to the app, but that are meaningful
+ to other application (e.g. Office files). (_iOS_)
+
+## File System Layouts
+
+Although technically an implementation detail, it can be very useful to know how
+the `cordova.file.*` properties map to physical paths on a real device.
+
+### iOS File System Layout
+
+| Device Path | `cordova.file.*` | `iosExtraFileSystems` | r/w? | persistent? | OS clears | sync | private |
+|:-----------------------------------------------|:----------------------------|:----------------------|:----:|:-----------:|:---------:|:----:|:-------:|
+| `/var/mobile/Applications/<UUID>/` | applicationStorageDirectory | - | r/o | N/A | N/A | N/A | Yes |
+| `appname.app/` | applicationDirectory | bundle | r/o | N/A | N/A | N/A | Yes |
+| `www/` | - | - | r/o | N/A | N/A | N/A | Yes |
+| `Documents/` | documentsDirectory | documents | r/w | Yes | No | Yes | Yes |
+| `NoCloud/` | - | documents-nosync | r/w | Yes | No | No | Yes |
+| `Library` | - | library | r/w | Yes | No | Yes? | Yes |
+| `NoCloud/` | dataDirectory | library-nosync | r/w | Yes | No | No | Yes |
+| `Cloud/` | syncedDataDirectory | - | r/w | Yes | No | Yes | Yes |
+| `Caches/` | cacheDirectory | cache | r/w | Yes* | Yes\*\*\*| No | Yes |
+| `tmp/` | tempDirectory | - | r/w | No\*\* | Yes\*\*\*| No | Yes |
+
+
+ \* Files persist across app restarts and upgrades, but this directory can
+ be cleared whenever the OS desires. Your app should be able to recreate any
+ content that might be deleted.
+
+\*\* Files may persist across app restarts, but do not rely on this behavior. Files
+ are not guaranteed to persist across updates. Your app should remove files from
+ this directory when it is applicable, as the OS does not guarantee when (or even
+ if) these files are removed.
+
+\*\*\* The OS may clear the contents of this directory whenever it feels it is
+ necessary, but do not rely on this. You should clear this directory as
+ appropriate for your application.
+
+### Android File System Layout
+
+| Device Path | `cordova.file.*` | `AndroidExtraFileSystems` | r/w? | persistent? | OS clears | private |
+|:------------------------------------------------|:----------------------------|:--------------------------|:----:|:-----------:|:---------:|:-------:|
+| `file:///android_asset/` | applicationDirectory | | r/o | N/A | N/A | Yes |
+| `/data/data/<app-id>/` | applicationStorageDirectory | - | r/w | N/A | N/A | Yes |
+| `cache` | cacheDirectory | cache | r/w | Yes | Yes\* | Yes |
+| `files` | dataDirectory | files | r/w | Yes | No | Yes |
+| `Documents` | | documents | r/w | Yes | No | Yes |
+| `<sdcard>/` | externalRootDirectory | sdcard | r/w | Yes | No | No |
+| `Android/data/<app-id>/` | externalApplicationStorageDirectory | - | r/w | Yes | No | No |
+| `cache` | externalCacheDirectry | cache-external | r/w | Yes | No\*\*| No |
+| `files` | externalDataDirectory | files-external | r/w | Yes | No | No |
+
+\* The OS may periodically clear this directory, but do not rely on this behavior. Clear
+ the contents of this directory as appropriate for your application. Should a user
+ purge the cache manually, the contents of this directory are removed.
+
+\*\* The OS does not clear this directory automatically; you are responsible for managing
+ the contents yourself. Should the user purge the cache manually, the contents of the
+ directory are removed.
+
+**Note**: If external storage can't be mounted, the `cordova.file.external*`
+properties are `null`.
## Android Quirks
@@ -101,33 +177,38 @@ 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
+`/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:
+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" />
-Without this line, the File plugin will use "Compatibility" as the default. If
+Without this line, the File plugin will use `Compatibility` as the default. If
a preference tag is present, and is not one of these values, the application
will not start.
If your application has previously been shipped to users, using an older (pre-
1.0) version of this plugin, and has stored files in the persistent filesystem,
-then you should set the preference to "Compatibility". Switching the location to
+then you should set the preference to `Compatibility`. Switching the location to
"Internal" would mean that existing users who upgrade their application may be
unable to access their previously-stored files, depending on their device.
If your application is new, or has never previously stored files in the
-persistent filesystem, then the "internal" setting is generally recommended.
+persistent filesystem, then the `Internal` setting is generally recommended.
## iOS Quirks
+
+- `cordova.file.applicationStorageDirectory` is read-only; attempting to store
+ files within the root directory will fail. Use one of the other `cordova.file.*`
+ properties defined for iOS (only `applicationDirectory` and `applicationStorageDirectory` are
+ read-only).
- `FileReader.readAsText(blob, encoding)`
- The `encoding` parameter is not supported, and UTF-8 encoding is always in effect.
@@ -142,27 +223,27 @@ files, rather than producing complete documents for export, which is the
intended purpose of the directory.
It is now possible to choose whether to store files in the documents or library
-directory, with a preference in your application's config.xml file. To do this,
-add one of these two lines to config.xml:
+directory, with a preference in your application's `config.xml` file. To do this,
+add one of these two lines to `config.xml`:
<preference name="iosPersistentFileLocation" value="Library" />
<preference name="iosPersistentFileLocation" value="Compatibility" />
-Without this line, the File plugin will use "Compatibility" as the default. If
+Without this line, the File plugin will use `Compatibility` as the default. If
a preference tag is present, and is not one of these values, the application
will not start.
If your application has previously been shipped to users, using an older (pre-
1.0) version of this plugin, and has stored files in the persistent filesystem,
-then you should set the preference to "Compatibility". Switching the location to
-"Library" would mean that existing users who upgrade their application would be
+then you should set the preference to `Compatibility`. Switching the location to
+`Library` would mean that existing users who upgrade their application would be
unable to access their previously-stored files.
If your application is new, or has never previously stored files in the
-persistent filesystem, then the "Library" setting is generally recommended.
+persistent filesystem, then the `Library` setting is generally recommended.
-### Firefox OS Quirks
+## Firefox OS Quirks
The File System API is not natively supported by Firefox OS and is implemented
as a shim on top of indexedDB.
@@ -197,7 +278,7 @@ to use `entry.toURL()` instead.
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.
+file exists within either the `TEMPORARY` or `PERSISTENT` filesystems.
This has particularly been an issue with the File-Transfer plugin, which previously used
device-absolute-paths (and can still accept them). It has been updated to work correctly
@@ -215,18 +296,20 @@ which can be used to identify the file uniquely.
## List of Error Codes and Meanings
When an error is thrown, one of the following codes will be used.
-* 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
+| Code | Constant |
+|-----:|:------------------------------|
+| 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` |
## Configuring the Plugin (Optional)
@@ -239,21 +322,21 @@ 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). You must have the `android.permission.WRITE_EXTERNAL_STORAGE` permission to use this.
-* cache: The application's internal cache directory
-* cache-external: The application's external cache directory
-* root: The entire device filesystem
+* `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). You must have the `android.permission.WRITE_EXTERNAL_STORAGE` permission to use this.
+* `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
-* bundle: The application's bundle; the location of the app itself on disk (read-only)
-* root: The entire device filesystem
+* `library`: The application's Library directory
+* `documents`: The application's Documents directory
+* `cache`: The application's Cache directory
+* `bundle`: The application's bundle; the location of the app itself on disk (read-only)
+* `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.
+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.