From 80e7eedcae703ab07f77924493f70a765c433d01 Mon Sep 17 00:00:00 2001 From: Ibrahim Hadeed Date: Sun, 6 Mar 2016 15:39:09 -0500 Subject: [PATCH] docs(plugin): add docs and usage --- src/plugins/appavailability.ts | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/plugins/appavailability.ts b/src/plugins/appavailability.ts index 52cd1510..38480b99 100644 --- a/src/plugins/appavailability.ts +++ b/src/plugins/appavailability.ts @@ -1,6 +1,8 @@ import {Plugin, Cordova} from './plugin'; /** + * 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. + * * Requires Cordova plugin: cordova-plugin-appavailability. For more info, please see the [AppAvailability plugin docs](https://github.com/ohh2ahh/AppAvailability). * * ``` @@ -9,6 +11,19 @@ import {Plugin, Cordova} from './plugin'; * * @usage * ```js + * var app; + * + * if(device.platform === 'iOS') { + * app = 'twitter://'; + * }else if(device.platform === 'Android'){ + * app = 'com.twitter.android'; + * } + * + * AppAvailability.check(app) + * .then( + * yes => console.log(app + " is available"), + * no => console.log(app + " is NOT available") + * ); * ``` */ @Plugin({