LocalFileSystem

This object provides a way to obtain root file systems.

Methods

  • requestFileSystem: Requests a filesystem. (Function)
  • resolveLocalFileSystemURI: Retrieve a DirectoryEntry or FileEntry using local URI. (Function)

Constants

  • LocalFileSystem.PERSISTENT: Used for storage that should not be removed by the user agent without application or user permission.
  • LocalFileSystem.TEMPORARY: Used for storage with no guarantee of persistence.

Details

The LocalFileSystem object methods are defined on the window object.

Supported Platforms

  • Android
  • BlackBerry WebWorks (OS 5.0 and higher)
  • iOS
  • Windows Phone 7 and 8
  • Windows 8

Request File System Quick Example

function onSuccess(fileSystem) {
	console.log(fileSystem.name);
}

// request the persistent file system
window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, onError);

Resolve Local File System URI Quick Example

function onSuccess(fileEntry) {
	console.log(fileEntry.name);
}

window.resolveLocalFileSystemURI("file:///example.txt", onSuccess, onError);

Full Example

<!DOCTYPE html>
<html>
  <head>
    <title>Local File System Example</title>

    <script type="text/javascript" charset="utf-8" src="cordova-2.5.0.js"></script>
    <script type="text/javascript" charset="utf-8">

    // Wait for Cordova to load
    //
    document.addEventListener("deviceready", onDeviceReady, false);

    // Cordova is ready
    //
    function onDeviceReady() {
		window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onFileSystemSuccess, fail);
		window.resolveLocalFileSystemURI("file:///example.txt", onResolveSuccess, fail);
    }

	function onFileSystemSuccess(fileSystem) {
		console.log(fileSystem.name);
	}

	function onResolveSuccess(fileEntry) {
		console.log(fileEntry.name);
	}
	
	function fail(evt) {
		console.log(evt.target.error.code);
	}
	
    </script>
  </head>
  <body>
    <h1>Example</h1>
    <p>Local File System</p>
  </body>
</html>