license: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
This object provides a way to obtain root file systems.
requestFileSystem: Requests a filesystem. (Function)
resolveLocalFileSystemURI: Retrieve a DirectoryEntry
or FileEntry
using local URI. (Function)
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.
The LocalFileSystem
object methods are defined on the window
object.
function onSuccess(fileSystem) { console.log(fileSystem.name); } // request the persistent file system window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, onError);
function onSuccess(fileEntry) { console.log(fileEntry.name); } window.resolveLocalFileSystemURI("file:///example.txt", onSuccess, onError);
<!DOCTYPE html> <html> <head> <title>Local File System Example</title> <script type="text/javascript" charset="utf-8" src="cordova.js"></script> <script type="text/javascript" charset="utf-8"> // Wait for device API libraries to load // document.addEventListener("deviceready", onDeviceReady, false); // device APIs are available // 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(error) { console.log(error.code); } </script> </head> <body> <h1>Example</h1> <p>Local File System</p> </body> </html>
Request a file system in which to store application data.
window.requestFileSystem(type, size, successCallback, errorCallback)
function onSuccess(fileSystem) { console.log(fileSystem.name); } // request the persistent file system window.requestFileSystem(LocalFileSystem.PERSISTENT, 0, onSuccess, onError);