Help prepare for 2025 → Answer 8 simple questions on our Fall Survey
Open Survey
Provides access to the top-level Folders instances that are accessible from the application. Use these as entry points to access the FileSystem.

Summary ​

Functions ​

currentApp ​

currentApp(): Folder
Gets the root folder for the current application. This Folder is private for the application and not accessible from Users/External apps. iOS - this folder is read-only and contains the app and all its resources.
Returns Folder

documents ​

documents(): Folder
Gets the Documents folder available for the current application. This Folder is private for the application and not accessible from Users/External apps.
Returns Folder

externalDocuments ​

externalDocuments(): Folder
Gets the Documents folder available for the current application on an external storage. This Folder is private for the application and not accessible from Users/External apps. On android this requires READ_EXTERNAL_STORAGE/WRITE_EXTERNAL_STORAGE permissions There is no external storage on iOS os it is the same as `documents()`
Returns Folder

temp ​

temp(): Folder
Gets the Temporary (Caches) folder available for the current application. This Folder is private for the application and not accessible from Users/External apps.
Returns Folder
Previous
inputType
Next
path