Contributors

@pwlin (source repo), @Gillardo, @TankOs, @Rovi23, @josemanuelbd, @ielcoro, @keturn, @conform, @guyc, @J3r0M3D3V, @WuglyakBolgoink, @lincolnthree, @rocco, @FrankFenton, @MHolmes91, @souly1, @diogodias86, @Arxi, @vzharkov, @lp1bp, @stalniy, @liugogal, @lcaprini, @jcdickman, @jankoester, @Evolution36

A File Opener Plugin for Cordova (The E36 Version)

This plugin will open a file on your device file system with its default application.

Current Version: 4.0.0

Requirements

Android 4 or higher / iOS 6 or higher / WP8
Cordova 3.0 or higher

Installation

cordova plugin add cordova-plugin-file-opener2-e36

Usage

cordova.plugins.fileOpener2.open(
    filePath, 
    fileMIMEType, 
    {
        error : function(){ }, 
        success : function(){ } 
    } 
);

Updates

This plugin was re-released because the version by pwlin did not have support to open files writable and the plugin did not receive any updates. We wanted this plugin to be available on npm again and have the ability for the community to improve upon the plugin as well.

Version 4.0.0

Android Oreo open files with write permissions
Default support library 27.0.1
Added root path for sdcard support
Fix problem with errors not throwing the error callback in windows

Examples

Open an APK install dialog:

cordova.plugins.fileOpener2.open(
    '/sdcard/Download/gmail.apk', 
    'application/vnd.android.package-archive'
);

Open a PDF document with the default PDF reader and optional callback object:

cordova.plugins.fileOpener2.open(
    '/sdcard/Download/starwars.pdf', // You can also use a Cordova-style file uri: cdvfile://localhost/persistent/Download/starwars.pdf
    'application/pdf', 
    { 
        error : function(e) { 
            console.log('Error status: ' + e.status + ' - Error message: ' + e.message);
        },
        success : function () {
            console.log('file opened successfully'); 				
        }
    }
);

Open a system modal to open PDF document with one of the already installed app and optional callback object:

cordova.plugins.fileOpener2.showOpenWithDialog(
    '/sdcard/Download/starwars.pdf', // You can also use a Cordova-style file uri: cdvfile://localhost/persistent/Download/starwars.pdf
    'application/pdf', 
    { 
        error : function(e) { 
            console.log('Error status: ' + e.status + ' - Error message: ' + e.message);
        },
        success : function () {
            console.log('file opened successfully'); 				
        }
    }
);

Notes

For properly opening any file, you must already have a suitable reader for that particular file type installed on your device. Otherwise this will not work.
It is reported that in iOS, you might need to remove <preference name="iosPersistentFileLocation" value="Library" /> from your config.xml
If you are wondering what MIME-type should you pass as the second argument to open function, here is a list of all known MIME-types

Android APK installation limitation

The following limitations apply when opening an APK file for installation:

On Android 8+, your application must have the ACTION_INSTALL_PACKAGE permission. You can add it by adding this to your app's config.xml file:

    <platform name="android">
        <config-file parent="/manifest" target="AndroidManifest.xml" xmlns:android="http://schemas.android.com/apk/res/android">
            <uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
        </config-file>
    </platform>

Before Android 7, you can only install APKs from the "external" partition. For example, you can install from cordova.file.externalDataDirectory, but not from cordova.file.dataDirectory. Android 7+ does not have this limitation.

Additional Android Functions

The following functions are available in Android platform:

`.uninstall(packageId, callbackContext)`

Uninstall a package with its id.

cordova.plugins.fileOpener2.uninstall('com.zynga.FarmVille2CountryEscape', {
    error : function(e) {
        console.log('Error status: ' + e.status + ' - Error message: ' + e.message);    
    },
    success : function() {
        console.log('Uninstall intent activity started.');
    }
});

`.appIsInstalled(packageId, callbackContext)`

Check if an app is already installed.

cordova.plugins.fileOpener2.appIsInstalled('com.adobe.reader', {
    success : function(res) {
        if (res.status === 0) {
            console.log('Adobe Reader is not installed.');
        } else {
            console.log('Adobe Reader is installed.')
        }
    }
});

LICENSE

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

JimmyWon1028/cordova-plugin-file-opener2