cordova-plugin-file-opener2-av

A File Opener Plugin for Cordova — AVSoft fork of cordova-plugin-file-opener2, migrated to AndroidX.

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

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

Differences from the original plugin

• The Android FileProvider extends androidx.core.content.FileProvider instead of the legacy android.support.v4.content.FileProvider.
• The legacy com.android.support:support-v4 dependency was replaced with androidx.core:core, avoiding "Duplicate class" build errors on AndroidX projects.
• No extra plugins (cordova-plugin-androidx / cordova-plugin-androidx-adapter) are needed for AndroidX support.
• The APK install and package uninstall features were removed (fileOpener2.uninstall(), the ACTION_INSTALL_PACKAGE intent and the REQUEST_INSTALL_PACKAGES manifest permission). These were not used and Google Play restricts apps that declare REQUEST_INSTALL_PACKAGES, so removing them keeps the app compliant when deploying to the Play Store.

Installation

$ cordova plugin add https://github.com/AVSoft-Chile/cordova-plugin-file-opener2-av.git

Optional variables

The AndroidX core library version can be set at installation time. Default value is 1.15.0.

$ cordova plugin add https://github.com/AVSoft-Chile/cordova-plugin-file-opener2-av.git --variable ANDROIDX_CORE_VERSION="1.15.0"

The version is pinned instead of using a dynamic range (1.+) because newer releases (e.g. 1.19.0) require Android Gradle Plugin 9.1.0 and compileSdk 37, which may be newer than what your project uses.

Requirements

The following platforms and versions are supported by the latest release:

• Android 4.4+ / iOS 9+ / Windows / Electron
• Cordova CLI 7.0 or higher

fileOpener2.open(filePath, mimeType, options)

Opens a file

Supported Platforms

• Android 4.4+
• iOS 9+
• Windows
• Electron

Quick Example

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

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

Note on Electron: Do not forget to enable Node.js in your app by adding "nodeIntegration": true to platforms/electron/platform_www/cdv-electron-settings.json file, See Cordova-Electron documentation.

Market place installation

Install From Market: to install an APK from a market place, such as Google Play or the App Store, you can use an <a> tag in combination with the market:// protocol:

<a href="market://details?id=xxxx" target="_system">Install from Google Play</a>
<a href="itms-apps://itunes.apple.com/app/my-app/idxxxxxxxx?mt=8" target="_system">Install from App Store</a>

or in code:

window.open("[market:// or itms-apps:// link]","_system");

fileOpener2.showOpenWithDialog(filePath, mimeType, options)

Opens with system modal to open file with an already installed app.

Supported Platforms

• Android 4.4+
• iOS 9+

Quick Example

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

position array of coordinates from top-left device screen, use for iOS dialog positioning.

fileOpener2.appIsInstalled(packageId, callbackContext)

Check if an app is already installed.

Supported Platforms

• Android 4.4+

Quick Example

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.')
        }
    }
});

SD card limitation on Android

It is not always possible to open a file from the SD Card using this plugin on Android. This is because the underlying Android library used does not support serving files from secondary external storage devices. Whether or not your the SD card is treated as a secondary external device depends on your particular phone's set up.

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