This version of the documentation is outdated!
Click here for the latest released version.
File
This API is based on the W3C File API. An API to read, write and navigate file system hierarchies.
Objects
- DirectoryEntry
- DirectoryReader
- File
- FileEntry
- FileError
- FileReader
- FileSystem
- FileTransfer
- FileTransferError
- FileUploadOptions
- FileUploadResult
- FileWriter
- Flags
- LocalFileSystem
- Metadata
Permissions
Android
app/res/xml/config.xml
<plugin name="File" value="org.apache.cordova.FileUtils" />
<plugin name="FileTransfer" value="org.apache.cordova.FileTransfer" />
app/AndroidManifest.xml
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
Bada
No permissions are required.
BlackBerry WebWorks
www/plugins.xml
<plugin name="File" value="org.apache.cordova.file.FileManager" />
<plugin name="FileTransfer" value="org.apache.cordova.http.FileTransfer" />
www/config.xml
<feature id="blackberry.io.file" required="true" version="1.0.0.0" />
<feature id="blackberry.utils" required="true" version="1.0.0.0" />
<feature id="blackberry.io.dir" required="true" version="1.0.0.0" />
<rim:permissions>
<rim:permit>access_shared</rim:permit>
</rim:permissions>
iOS
config.xml
<plugin name="File" value="CDVFile" />
<plugin name="FileTransfer" value="CDVFileTransfer" />
webOS
No permissions are required.
Windows Phone
No permissions are required.