This repository has been archived on 2023-11-19. You can view files and clone it, but cannot push or open issues or pull requests.
goober-ionic/plugins/cordova-plugin-filepath/README.md

45 lines
1.1 KiB
Markdown
Raw Normal View History

2018-07-16 02:24:48 +00:00
# cordova-plugin-filepath
This plugin allows you to resolve the native filesystem path for Android content
URIs and is based on code in the [aFileChooser](https://github.com/iPaulPro/aFileChooser/blob/master/aFileChooser/src/com/ipaulpro/afilechooser/utils/FileUtils.java) library.
Original inspiration [from StackOverflow](http://stackoverflow.com/questions/20067508/get-real-path-from-uri-android-kitkat-new-storage-access-framework).
## Installation
```bash
$ cordova plugin add cordova-plugin-filepath
```
## Supported Platforms
* Android
## Usage
Once installed the plugin defines the `window.FilePath` object. To resolve a
file path:
```js
window.FilePath.resolveNativePath('content://...', successCallback, errorCallback);
```
##### successCallback
Returns the ``file://`` file path.
##### errorCallback
Returns the following object:
```js
{ code: <integer>, message: <string> }
```
Possible error codes are:
* ``-1`` - describes an invalid action
* ``0`` - ``file://`` path could not be resolved
* ``1`` - the native path links to a cloud file (e.g: from Google Drive app)
## LICENSE
Apache (see LICENSE.md)