breautek commented on code in PR #532:
URL:
https://github.com/apache/cordova-plugin-file/pull/532#discussion_r939595126
##########
README.md:
##########
@@ -125,53 +128,53 @@ 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 | N/A | N/A | N/A | Yes |
-| `appname.app/` | applicationDirectory
| bundle | r | N/A | N/A | N/A | Yes |
-| `www/` | -
| - | r | 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.
+| :--------------------------------------------- | :--------------------------
| :-------------------- | :--: | :---------: | :-------: | :--: | :-----: |
+| `/var/mobile/Applications/<UUID>/` | applicationStorageDirectory
| - | r | N/A | N/A | N/A | Yes |
+| `appname.app/` | applicationDirectory
| bundle | r | N/A | N/A | N/A | Yes |
+| `www/` | -
| - | r | 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.
+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.
+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
| assets | r | 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` | externalCacheDirectory
| cache-external | r/w | Yes | No\*\*| No |
-| `files` | externalDataDirectory
| files-external | r/w | Yes | No | No |
+| Device Path | `cordova.file.*`
| `AndroidExtraFileSystems` | r/w? | persistent? | OS clears |
private |
+| :---------------------------------------------- |
:---------------------------------- | :------------------------ | :-------: |
:---------: | :-------: | :-----: |
+| `file:///android_asset/` | applicationDirectory
| assets | r | 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 |
+| `<sdcard>/` | downloadDirectory
| sdcard | r/w\*\*\* | Yes | No |
No |
Review Comment:
```suggestion
| `<sdcard>/Downloads` |
downloadDirectory | sdcard | r/w | Yes
| No | No |
```
I think the download directory is generally located at `<sdcard>/Download`
but I think this should be confirmed. Additionally, the triple star indicator
is for a note on API 30 changes where the external root directory is no longer
a writable path, which I don't think applies to the Downloads folder.
Suggestion is to show changes, but it will likely screw up the textual
formatting of the table, so these changes might be better to be applied
manually rather then accepting the suggestion commit.
##########
README.md:
##########
@@ -125,53 +128,53 @@ 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 | N/A | N/A | N/A | Yes |
-| `appname.app/` | applicationDirectory
| bundle | r | N/A | N/A | N/A | Yes |
-| `www/` | -
| - | r | 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.
+| :--------------------------------------------- | :--------------------------
| :-------------------- | :--: | :---------: | :-------: | :--: | :-----: |
+| `/var/mobile/Applications/<UUID>/` | applicationStorageDirectory
| - | r | N/A | N/A | N/A | Yes |
+| `appname.app/` | applicationDirectory
| bundle | r | N/A | N/A | N/A | Yes |
+| `www/` | -
| - | r | 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.
+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.
+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
| assets | r | 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` | externalCacheDirectory
| cache-external | r/w | Yes | No\*\*| No |
-| `files` | externalDataDirectory
| files-external | r/w | Yes | No | No |
+| Device Path | `cordova.file.*`
| `AndroidExtraFileSystems` | r/w? | persistent? | OS clears |
private |
+| :---------------------------------------------- |
:---------------------------------- | :------------------------ | :-------: |
:---------: | :-------: | :-----: |
+| `file:///android_asset/` | applicationDirectory
| assets | r | 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 |
+| `<sdcard>/` | downloadDirectory
| sdcard | r/w\*\*\* | Yes | No |
No |
Review Comment:
```suggestion
| `<sdcard>/Downloads` |
downloadDirectory | sdcard | r/w | Yes
| No | No |
```
I think the download directory is generally located at `<sdcard>/Download`
but I think this should be confirmed. Additionally, the triple star indicator
is for a note on API 30 changes where the external root directory is no longer
a writable path, which I don't think applies to the Downloads folder.
Suggestion is to show changes, but it will likely screw up the textual
formatting of the table, so these changes might be better to be applied
manually rather then accepting the suggestion commit as is.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
