diff options
| author | PliablePixels <pliablepixels@gmail.com> | 2015-06-24 18:47:42 -0400 |
|---|---|---|
| committer | PliablePixels <pliablepixels@gmail.com> | 2015-06-24 18:47:42 -0400 |
| commit | 855a0e8ddc273b58066530a1b55a946021dfc56e (patch) | |
| tree | 26550033e855a31a265fc2da4da3df0cc2733dc1 /plugins/org.apache.cordova.file/docs/localfilesystem/localfilesystem.md | |
| parent | d442629aa825aab6bc55ab6be19e3aba060867fe (diff) | |
Cleaned up code, commented, preparing for HTTPS via CordovaHTTP
Diffstat (limited to 'plugins/org.apache.cordova.file/docs/localfilesystem/localfilesystem.md')
| -rw-r--r-- | plugins/org.apache.cordova.file/docs/localfilesystem/localfilesystem.md | 110 |
1 files changed, 110 insertions, 0 deletions
diff --git a/plugins/org.apache.cordova.file/docs/localfilesystem/localfilesystem.md b/plugins/org.apache.cordova.file/docs/localfilesystem/localfilesystem.md new file mode 100644 index 00000000..2b933c94 --- /dev/null +++ b/plugins/org.apache.cordova.file/docs/localfilesystem/localfilesystem.md @@ -0,0 +1,110 @@ +--- +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. +--- + +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-x.x.x.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(evt) { + console.log(evt.target.error.code); + } + + </script> + </head> + <body> + <h1>Example</h1> + <p>Local File System</p> + </body> + </html> |