AppAvailability for iOS and Android

Version 0.3.1

A Plugin for Cordova / PhoneGap by ohh2ahh

Description
Installation 2. Automatically (Command-line Interface) 2. PhoneGap Build
Usage 3. iOS 3. Android 3. Old approach
Some URI Schemes / Package Names
License

1. Description

This plugin allows you to check if an app is installed on the user's device. It requires an URI Scheme (e.g. twitter://) on iOS or a Package Name (e.g com.twitter.android) on Android.

Ready for the Command-line Interface of Cordova / PhoneGap 3.0 and later
Works with PhoneGap Build (more information)

Supported Platforms

iOS
Android

2. Installation

The Cordova CLI is the recommended way to install AppAvailability, see The Command-line Interface.

Automatically (Command-line Interface)

Simply run this command to add AppAvailability to your project:

$ cordova plugin add https://github.com/ohh2ahh/AppAvailability.git

Don't forget to prepare and compile your project:

$ cordova build

You don't have to reference the JavaScript in your index.html.

PhoneGap Build

AppAvailability works with PhoneGap build too. You can implement the latest version of the plugin by adding the following xml to your config.xml:

<gap:plugin name="com.ohh2ahh.plugins.appavailability" />

Or if you want to use an exact version of AppAvailability:

<gap:plugin name="com.ohh2ahh.plugins.appavailability" version="0.3.1" />

There is no need to reference the JavaScript in your index.html.

3. Usage

❗ The code changed in version 0.3.0 and supports now success and error callbacks! But you can still use the old approach, which is described below.

iOS

appAvailability.check(
    'twitter://', // URI Scheme
    function() {  // Success callback
        console.log('Twitter is available');
    },
    function() {  // Error callback
        console.log('Twitter is not available');
    }
);

Android

appAvailability.check(
    'com.twitter.android', // URI Scheme
    function() {           // Success callback
        console.log('Twitter is available');
    },
    function() {           // Error callback
        console.log('Twitter is not available');
    }
);

Old approach (< 0.3.0)

The only thing you have to do is replacing appAvailability.check with appAvailability.checkBool:

appAvailability.checkBool('twitter://', function(availability) {
    // availability is either true or false
    if(availability) { console.log('Twitter is available'); }
});

4. Some URI Schemes / Package Names

How do I get the URI Scheme / Package Name?

Twitter:

iOS: twitter:// (more Schemes)
Android: com.twitter.android

Facebook:

iOS: fb:// (and many more as fb://profile)
Android: com.facebook.katana

WhatsApp:

iOS: whatsapp:// (only since v. 2.10.1, more information)
Android: com.whatsapp

5. 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.

mrichie/AppAvailability