Skip to content

Commit

Permalink
docs(types): explain FilesystemDirectory types (#2663)
Browse files Browse the repository at this point in the history
  • Loading branch information
jcesarmobile committed Mar 30, 2020
1 parent 2be4a92 commit 6a6cd8b
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions core/src/core-plugin-definitions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -590,22 +590,40 @@ export interface FilesystemPlugin extends Plugin {
export enum FilesystemDirectory {
/**
* The Documents directory
* On iOS it's the app's documents directory.
* Use this directory to store user-generated content.
* On Android it's the Public Documents folder, so it's accessible from other apps.
* It's not accesible on Android 10 and newer.
*/
Documents = 'DOCUMENTS',
/**
* The Data directory
* On iOS it will use the Documents directory
* On Android it's the directory holding application files.
* Files will be deleted when the application is uninstalled.
*/
Data = 'DATA',
/**
* The Cache directory
* Can be deleted in cases of low memory, so use this directory to write app-specific files
* that your app can re-create easily.
*/
Cache = 'CACHE',
/**
* The external directory (Android only)
* The external directory
* On iOS it will use the Documents directory
* On Android it's the directory on the primary shared/external
* storage device where the application can place persistent files it owns.
* These files are internal to the applications, and not typically visible
* to the user as media.
* Files will be deleted when the application is uninstalled.
*/
External = 'EXTERNAL',
/**
* The external storage directory (Android only)
* The external storage directory
* On iOS it will use the Documents directory
* On Android it's the primary shared/external storage directory.
* It's not accesible on Android 10 and newer.
*/
ExternalStorage = 'EXTERNAL_STORAGE'
}
Expand Down

0 comments on commit 6a6cd8b

Please sign in to comment.