refactor(docs): read the description (#1631)

* refactor(docs): read the description

- Added missing platforms
- Unified GitHub links
- Added missing installVariables

* Update index.ts

* Update index.ts

* Update index.ts

* Update index.ts
This commit is contained in:
Daniel Sogl 2017-06-01 19:05:47 +02:00 committed by Ibby Hadeed
parent 985193bebd
commit 52dcd808b6
40 changed files with 67 additions and 45 deletions

View File

@ -101,8 +101,9 @@ export interface AlipayOrder {
plugin: 'cordova-alipay-base',
pluginRef: 'Alipay.Base',
repo: 'https://github.com/xueron/cordova-alipay-base',
platforms: ['Android', 'iOS'],
install: 'ionic cordova plugin add https://github.com/xueron/cordova-alipay-base --variable APP_ID=your_app_id'
install: 'ionic cordova plugin add https://github.com/xueron/cordova-alipay-base --variable APP_ID=your_app_id',
installVariables: ['APP_ID'],
platforms: ['Android', 'iOS']
})
@Injectable()
export class Alipay extends IonicNativePlugin {

View File

@ -24,7 +24,7 @@ import { Injectable } from '@angular/core';
*/
@Plugin({
pluginName: 'AppMinimize',
plugin: 'https://github.com/tomloprod/cordova-plugin-appminimize.git',
plugin: 'cordova-plugin-appminimize',
pluginRef: 'plugins.appMinimize',
repo: 'https://github.com/tomloprod/cordova-plugin-appminimize',
platforms: ['Android']

View File

@ -25,7 +25,7 @@ import { Injectable } from '@angular/core';
plugin: 'cordova-plugin-app-preferences',
pluginRef: 'plugins.appPreferences',
repo: 'https://github.com/apla/me.apla.cordova.app-preferences',
platforms: ['Android', 'BlackBerry 10', 'Browser', 'iOS', 'OS X', 'Windows 8', 'Windows Phone']
platforms: ['Android', 'BlackBerry 10', 'Browser', 'iOS', 'macOS', 'Windows 8', 'Windows Phone']
})
@Injectable()
export class AppPreferences extends IonicNativePlugin {

View File

@ -22,9 +22,9 @@ import { Injectable } from '@angular/core';
*/
@Plugin({
pluginName: 'Appodeal',
plugin: 'https://github.com/appodeal/appodeal-cordova-plugin',
plugin: 'https://github.com/appodeal/appodeal-cordova-plugin.git',
pluginRef: 'Appodeal',
repo: 'https://github.com/appodeal/appodeal-cordova-plugin.git',
repo: 'https://github.com/appodeal/appodeal-cordova-plugin',
platforms: ['iOS', 'Android']
})
@Injectable()

View File

@ -23,7 +23,7 @@ import { Injectable } from '@angular/core';
*/
@Plugin({
pluginName: 'CouchbaseLite',
plugin: 'https://github.com/couchbaselabs/Couchbase-Lite-PhoneGap-Plugin',
plugin: 'https://github.com/couchbaselabs/Couchbase-Lite-PhoneGap-Plugin.git',
pluginRef: 'cblite',
repo: 'https://github.com/couchbaselabs/Couchbase-Lite-PhoneGap-Plugin',
platforms: ['Android', 'iOS']

View File

@ -78,9 +78,9 @@ export interface DeeplinkMatch {
plugin: 'ionic-plugin-deeplinks',
pluginRef: 'IonicDeeplink',
repo: 'https://github.com/ionic-team/ionic-plugin-deeplinks',
platforms: ['iOS', 'Android', 'Browser'],
install: 'ionic cordova plugin add ionic-plugin-deeplinks --variable URL_SCHEME=myapp --variable DEEPLINK_SCHEME=https --variable DEEPLINK_HOST=example.com --variable ANDROID_PATH_PREFIX=/',
installVariables: ['URL_SCHEME', 'DEEPLINK_SCHEME', 'DEEPLINK_HOST', 'ANDROID_PATH_PREFIX']
installVariables: ['URL_SCHEME', 'DEEPLINK_SCHEME', 'DEEPLINK_HOST', 'ANDROID_PATH_PREFIX'],
platforms: ['iOS', 'Android', 'Browser']
})
@Injectable()
export class Deeplinks extends IonicNativePlugin {

View File

@ -45,8 +45,8 @@ export interface DialogsPromptCallback {
pluginName: 'Dialogs',
plugin: 'cordova-plugin-dialogs',
pluginRef: 'navigator.notification',
repo: 'https://github.com/apache/cordova-plugin-dialogs.git',
platforms: ['Android', 'BlackBerry 10', 'Firefox OS', 'iOS', 'Ubuntu', 'Windows', 'Windows Phone']
repo: 'https://github.com/apache/cordova-plugin-dialogs',
platforms: ['Amazon Fire OS', 'Android', 'BlackBerry 10', 'Browser', 'Firefox OS', 'iOS', 'Tizen', 'Windows Phone 7', 'Windows Phone 8', 'Windows']
})
@Injectable()
export class Dialogs extends IonicNativePlugin {

View File

@ -23,7 +23,7 @@ import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
pluginName: 'Flashlight',
plugin: 'cordova-plugin-flashlight',
pluginRef: 'window.plugins.flashlight',
repo: 'https://github.com/EddyVerbruggen/Flashlight-PhoneGap-Plugin.git',
repo: 'https://github.com/EddyVerbruggen/Flashlight-PhoneGap-Plugin',
platforms: ['Android', 'iOS', 'Windows Phone 8']
})
@Injectable()

View File

@ -211,7 +211,7 @@ export class FlurryAnalyticsObject {
pluginName: 'FlurryAnalytics',
plugin: 'cordova-plugin-flurryanalytics',
pluginRef: 'FlurryAnalytics',
repo: 'https://github.com/blakgeek/cordova-plugin-flurryanalytics.git',
repo: 'https://github.com/blakgeek/cordova-plugin-flurryanalytics',
platforms: ['Android', 'iOS', 'Browser']
})
@Injectable()

View File

@ -79,7 +79,7 @@ declare const window: any;
pluginName: 'Geofence',
plugin: 'cordova-plugin-geofence',
pluginRef: 'geofence',
repo: 'https://github.com/cowbell/cordova-plugin-geofence/',
repo: 'https://github.com/cowbell/cordova-plugin-geofence',
platforms: ['Android', 'iOS', 'Windows Phone 8', 'Windows Phone']
})
@Injectable()

View File

@ -153,7 +153,7 @@ export interface GeolocationOptions {
plugin: 'cordova-plugin-geolocation',
pluginRef: 'navigator.geolocation',
repo: 'https://github.com/apache/cordova-plugin-geolocation',
platforms: ['Android', 'Firefox OS', 'iOS', 'Ubuntu', 'Windows', 'Windows Phone']
platforms: ['Amazon Fire OS', 'Android', 'BlackBerry 10', 'Firefox OS', 'iOS', 'Tizen', 'Windows', 'Windows Phone']
})
@Injectable()
export class Geolocation extends IonicNativePlugin {

View File

@ -23,9 +23,9 @@ import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
plugin: 'cordova-plugin-googleplus',
pluginRef: 'window.plugins.googleplus',
repo: 'https://github.com/EddyVerbruggen/cordova-plugin-googleplus',
platforms: ['Web', 'Android', 'iOS'],
install: 'ionic cordova plugin add cordova-plugin-googleplus --variable REVERSED_CLIENT_ID=myreversedclientid',
installVariables: ['REVERSED_CLIENT_ID']
installVariables: ['REVERSED_CLIENT_ID'],
platforms: ['Web', 'Android', 'iOS']
})
@Injectable()
export class GooglePlus extends IonicNativePlugin {

View File

@ -57,9 +57,11 @@ export interface ImagePickerOptions {
*/
@Plugin({
pluginName: 'ImagePicker',
plugin: 'https://github.com/Telerik-Verified-Plugins/ImagePicker',
plugin: 'https://github.com/Telerik-Verified-Plugins/ImagePicker.git',
pluginRef: 'window.imagePicker',
repo: 'https://github.com/Telerik-Verified-Plugins/ImagePicker',
install: 'ionic cordova plugin add https://github.com/Telerik-Verified-Plugins/ImagePicker.git --variable PHOTO_LIBRARY_USAGE_DESCRIPTION="your usage message"',
installVariables: ['PHOTO_LIBRARY_USAGE_DESCRIPTION'],
platforms: ['Android', 'iOS']
})
@Injectable()

View File

@ -29,7 +29,7 @@ import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
pluginName: 'Keychain',
plugin: 'cordova-plugin-ios-keychain',
pluginRef: 'window.Keychain',
repo: 'https://github.com/ionic-team/cordova-plugin-ios-keychain/',
repo: 'https://github.com/ionic-team/cordova-plugin-ios-keychain',
platforms: ['iOS']
})
@Injectable()

View File

@ -54,6 +54,7 @@ export type LinkedInLoginScopes = 'r_basicprofile' | 'r_emailaddress' | 'rw_comp
pluginRef: 'cordova.plugins.LinkedIn',
repo: 'https://github.com/zyra/cordova-plugin-linkedin',
install: 'ionic cordova plugin add cordova-plugin-linkedin --variable APP_ID=YOUR_APP_ID',
installVariables: ['APP_ID'],
platforms: ['Android', 'iOS']
})
@Injectable()

View File

@ -33,7 +33,8 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
pluginName: 'NativeAudio',
plugin: 'cordova-plugin-nativeaudio',
pluginRef: 'plugins.NativeAudio',
repo: 'https://github.com/floatinghotpot/cordova-plugin-nativeaudio'
repo: 'https://github.com/floatinghotpot/cordova-plugin-nativeaudio',
platforms: ['Android', 'iOS']
})
@Injectable()
export class NativeAudio extends IonicNativePlugin {

View File

@ -51,9 +51,9 @@ declare const navigator: any;
@Plugin({
pluginName: 'Network',
plugin: 'cordova-plugin-network-information',
pluginRef: 'navigator.connection',
repo: 'https://github.com/apache/cordova-plugin-network-information',
platforms: ['Amazon Fire OS', 'iOS', 'Android', 'BlackBerry 10', 'Windows Phone 7', 'Windows Phone 8', 'Windows', 'Firefox OS', 'Browser'],
pluginRef: 'navigator.connection'
platforms: ['Amazon Fire OS', 'iOS', 'Android', 'BlackBerry 10', 'Windows Phone 7', 'Windows Phone 8', 'Windows', 'Firefox OS', 'Browser']
})
@Injectable()
export class Network extends IonicNativePlugin {

View File

@ -32,7 +32,8 @@ declare let window: any;
pluginName: 'NFC',
plugin: 'phonegap-nfc',
pluginRef: 'nfc',
repo: 'https://github.com/chariotsolutions/phonegap-nfc'
repo: 'https://github.com/chariotsolutions/phonegap-nfc',
platforms: ['Android', 'Windows ', 'BlackBerry 7', 'BlackBerry 10']
})
/**
*@{ NFC } class methods

View File

@ -45,6 +45,7 @@ import { Injectable } from '@angular/core';
pluginRef: 'cordova.plugins.photoLibrary',
repo: 'https://github.com/terikon/cordova-plugin-photo-library',
install: 'ionic cordova plugin add cordova-plugin-photo-library --variable PHOTO_LIBRARY_USAGE_DESCRIPTION="To choose photos"',
installVariables: ['PHOTO_LIBRARY_USAGE_DESCRIPTION'],
platforms: ['Android', 'Browser', 'iOS']
})
@Injectable()

View File

@ -28,7 +28,8 @@ import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
pluginName: 'PinDialog',
plugin: 'cordova-plugin-pin-dialog',
pluginRef: 'plugins.pinDialog',
repo: 'https://github.com/Paldom/PinDialog'
repo: 'https://github.com/Paldom/PinDialog',
platforms: ['Android', 'iOS']
})
@Injectable()
export class PinDialog extends IonicNativePlugin {

View File

@ -24,7 +24,8 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
pluginName: 'PowerManagement',
plugin: 'cordova-plugin-powermanagement-orig',
pluginRef: 'powerManagement',
repo: 'https://github.com/Viras-/cordova-plugin-powermanagement'
repo: 'https://github.com/Viras-/cordova-plugin-powermanagement',
platforms: ['Android', 'iOS', 'WindowsPhone', 'Windows']
})
@Injectable()
export class PowerManagement extends IonicNativePlugin {

View File

@ -265,7 +265,8 @@ export type PushEvent = 'registration' | 'error' | 'notification';
pluginRef: 'PushNotification',
repo: 'https://github.com/phonegap/phonegap-plugin-push',
install: 'ionic cordova plugin add phonegap-plugin-push --variable SENDER_ID=XXXXXXXXX',
installVariables: ['SENDER_ID']
installVariables: ['SENDER_ID'],
platforms: ['Android', 'iOS', 'Browser', 'Windows ']
})
@Injectable()
export class Push extends IonicNativePlugin {

View File

@ -24,9 +24,9 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
plugin: 'resgrid-cordova-plugins-rollbar',
pluginRef: 'cordova.plugins.Rollbar',
repo: 'https://github.com/Resgrid/cordova-plugins-rollbar',
platforms: ['Android', 'iOS'],
install: 'ionic cordova plugin add resgrid-cordova-plugins-rollbar --variable ROLLBAR_ACCESS_TOKEN="YOUR_ROLLBAR_ACCEESS_TOKEN" --variable ROLLBAR_ENVIRONMENT="ROLLBAR_ENVIRONMENT"',
installVariables: ['ROLLBAR_ACCESS_TOKEN', 'ROLLBAR_ENVIRONMENT']
installVariables: ['ROLLBAR_ACCESS_TOKEN', 'ROLLBAR_ENVIRONMENT'],
platforms: ['Android', 'iOS']
})
@Injectable()
export class Rollbar extends IonicNativePlugin {

View File

@ -58,8 +58,8 @@ export interface SafariViewControllerOptions {
pluginName: 'SafariViewController',
plugin: 'cordova-plugin-safariviewcontroller',
pluginRef: 'SafariViewController',
platforms: ['iOS', 'Android'],
repo: 'https://github.com/EddyVerbruggen/cordova-plugin-safariviewcontroller'
repo: 'https://github.com/EddyVerbruggen/cordova-plugin-safariviewcontroller',
platforms: ['iOS', 'Android']
})
@Injectable()
export class SafariViewController extends IonicNativePlugin {

View File

@ -25,7 +25,8 @@ declare const navigator: any;
pluginName: 'Screenshot',
plugin: 'https://github.com/gitawego/cordova-screenshot.git',
pluginRef: 'navigator.screenshot',
repo: 'https://github.com/gitawego/cordova-screenshot.git'
repo: 'https://github.com/gitawego/cordova-screenshot',
platforms: ['Android', 'iOS']
})
@Injectable()
export class Screenshot extends IonicNativePlugin {

View File

@ -23,7 +23,8 @@ import { Observable } from 'rxjs/Observable';
pluginName: 'Shake',
plugin: 'cordova-plugin-shake',
pluginRef: 'shake',
repo: 'https://github.com/leecrossley/cordova-plugin-shake'
repo: 'https://github.com/leecrossley/cordova-plugin-shake',
platforms: ['iOS']
})
@Injectable()
export class Shake extends IonicNativePlugin {

View File

@ -22,7 +22,8 @@ import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
pluginName: 'SplashScreen',
plugin: 'cordova-plugin-splashscreen',
pluginRef: 'navigator.splashscreen',
repo: 'https://github.com/apache/cordova-plugin-splashscreen'
repo: 'https://github.com/apache/cordova-plugin-splashscreen',
platforms: ['Amazon Fire OS', 'Android', 'BlackBerry 10', 'iOS', 'Windows Phone 7 and 8', 'Windows', 'Browser']
})
@Injectable()
export class SplashScreen extends IonicNativePlugin {

View File

@ -146,7 +146,8 @@ export class SQLiteObject {
pluginName: 'SQLite',
pluginRef: 'sqlitePlugin',
plugin: 'cordova-sqlite-storage',
repo: 'https://github.com/litehelpers/Cordova-sqlite-storage'
repo: 'https://github.com/litehelpers/Cordova-sqlite-storage',
platforms: ['Android', 'iOS', 'macOS', 'Windows']
})
@Injectable()
export class SQLite extends IonicNativePlugin {

View File

@ -26,7 +26,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
*/
@Plugin({
pluginName: 'Stepcounter',
plugin: 'https://github.com/Slidee/cordova-plugin-stepcounter',
plugin: 'https://github.com/Slidee/cordova-plugin-stepcounter.git',
pluginRef: 'stepcounter',
repo: 'https://github.com/Slidee/cordova-plugin-stepcounter',
platforms: ['Android']

View File

@ -114,7 +114,8 @@ export interface StripeBankAccountParams {
pluginName: 'Stripe',
plugin: 'cordova-plugin-stripe',
pluginRef: 'cordova.plugins.stripe',
repo: 'https://github.com/zyramedia/cordova-plugin-stripe'
repo: 'https://github.com/zyramedia/cordova-plugin-stripe',
platforms: ['Android', 'iOS', 'Browser']
})
@Injectable()
export class Stripe extends IonicNativePlugin {

View File

@ -35,7 +35,8 @@ export interface TTSOptions {
pluginName: 'Text To Speech',
plugin: 'cordova-plugin-tts',
pluginRef: 'TTS',
repo: 'https://github.com/vilic/cordova-plugin-tts'
repo: 'https://github.com/vilic/cordova-plugin-tts',
platforms: ['Android', 'iOS', 'Windows Phone 8']
})
@Injectable()
export class TextToSpeech extends IonicNativePlugin {

View File

@ -223,7 +223,8 @@ export class ThemeableBrowserObject {
pluginName: 'ThemeableBrowser',
plugin: 'cordova-plugin-themeablebrowser',
pluginRef: 'cordova.ThemeableBrowser',
repo: 'https://github.com/initialxy/cordova-plugin-themeablebrowser'
repo: 'https://github.com/initialxy/cordova-plugin-themeablebrowser',
platforms: ['Amazon Fire OS', 'Android', 'Blackberry 10', 'Browser', 'FirefoxOS', 'iOS', 'Ubuntu', 'Windows', 'Windows Phone']
})
@Injectable()
export class ThemeableBrowser extends IonicNativePlugin {

View File

@ -176,7 +176,8 @@ export interface FileTransferError {
pluginName: 'FileTransfer',
plugin: 'cordova-plugin-file-transfer',
pluginRef: 'FileTransfer',
repo: 'https://github.com/apache/cordova-plugin-file-transfer'
repo: 'https://github.com/apache/cordova-plugin-file-transfer',
platforms: ['Amazon Fire OS', 'Android', 'iOS', 'Ubuntu', 'Windows', 'Windows Phone']
})
@Injectable()
export class Transfer extends IonicNativePlugin {

View File

@ -57,7 +57,8 @@ export interface TwitterConnectResponse {
pluginRef: 'TwitterConnect',
repo: 'https://github.com/ManifestWebDesign/twitter-connect-plugin',
install: 'ionic cordova plugin add twitter-connect-plugin --variable FABRIC_KEY=fabric_API_key',
installVariables: ['FABRIC_KEY']
installVariables: ['FABRIC_KEY'],
platforms: ['Android', 'iOS']
})
@Injectable()
export class TwitterConnect extends IonicNativePlugin {

View File

@ -24,7 +24,8 @@ import { Injectable } from '@angular/core';
pluginName: 'UniqueDeviceID',
plugin: 'cordova-plugin-uniquedeviceid',
pluginRef: 'window.plugins.uniqueDeviceID',
repo: 'https://github.com/Paldom/UniqueDeviceID'
repo: 'https://github.com/Paldom/UniqueDeviceID',
platforms: ['Android', 'iOS', 'Windows Phone 8']
})
@Injectable()
export class UniqueDeviceID extends IonicNativePlugin {

View File

@ -34,7 +34,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
*/
@Plugin({
pluginName: 'UserAgent',
plugin: 'https://github.com/LouisT/cordova-useragent',
plugin: 'https://github.com/LouisT/cordova-useragent.git',
pluginRef: 'plugins.useragent',
repo: 'https://github.com/LouisT/cordova-useragent',
platforms: ['Android', 'iOS']

View File

@ -45,7 +45,7 @@ export interface VideoOptions {
*/
@Plugin({
pluginName: 'VideoPlayer',
plugin: 'https://github.com/moust/cordova-plugin-videoplayer',
plugin: 'https://github.com/moust/cordova-plugin-videoplayer.git',
pluginRef: 'VideoPlayer',
repo: 'https://github.com/moust/cordova-plugin-videoplayer',
platforms: ['Android']

View File

@ -27,7 +27,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
*/
@Plugin({
pluginName: 'YoutubeVideoPlayer',
plugin: 'https://github.com/JonSmart/CordovaYoutubeVideoPlayer',
plugin: 'https://github.com/JonSmart/CordovaYoutubeVideoPlayer.git',
pluginRef: 'YoutubeVideoPlayer',
repo: 'https://github.com/JonSmart/CordovaYoutubeVideoPlayer',
platforms: ['Android', 'iOS']

View File

@ -55,7 +55,8 @@ export interface ZeroconfResult {
pluginName: 'Zeroconf',
plugin: 'cordova-plugin-zeroconf',
pluginRef: 'cordova.plugins.zeroconf',
repo: 'https://github.com/becvert/cordova-plugin-zeroconf'
repo: 'https://github.com/becvert/cordova-plugin-zeroconf',
platforms: ['Android', 'iOS']
})
@Injectable()
export class Zeroconf extends IonicNativePlugin {

View File

@ -27,6 +27,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
plugin: 'cordova-plugin-zip',
pluginRef: 'zip',
repo: 'https://github.com/MobileChromeApps/cordova-plugin-zip',
platforms: ['Android', 'iOS']
})
@Injectable()
export class Zip extends IonicNativePlugin {