style(): unify docs and spacing (#1448)

* typo(barcode-scanner): fixe circle lint error

* typo(docs):  Unified the documentations

In some plugins the typescript markup was missing.
I also unified the console.log string from console.log("hello") to console.log('Hello') so any plugin page look the same.
This commit is contained in:
Daniel Sogl 2017-04-30 20:36:22 +02:00 committed by Ibby Hadeed
parent a7c9abc449
commit c6f9fa356f
90 changed files with 497 additions and 506 deletions

View File

@ -69,7 +69,7 @@ export interface AdMobFreeRewardVideoConfig {
* @description * @description
* *
* @usage * @usage
* ``` * ```typescript
* import { AdMobFree, AdMobFreeBannerConfig } from '@ionic-native/admob-free'; * import { AdMobFree, AdMobFreeBannerConfig } from '@ionic-native/admob-free';
* *
* *

View File

@ -67,7 +67,7 @@ export interface AlipayOrder {
* Requires Cordova plugin: `cordova-alipay-base`. For more info, please see the [Alipay plugin docs](https://github.com/xueron/cordova-alipay-base). * Requires Cordova plugin: `cordova-alipay-base`. For more info, please see the [Alipay plugin docs](https://github.com/xueron/cordova-alipay-base).
* *
* @usage * @usage
* ``` * ```typescript
* import { Alipay, AlipayOrder } from '@ionic-native/alipay'; * import { Alipay, AlipayOrder } from '@ionic-native/alipay';
* *
* constructor(private alipay: Alipay) { * constructor(private alipay: Alipay) {
@ -112,4 +112,3 @@ export class Alipay extends IonicNativePlugin {
@Cordova() @Cordova()
pay(order: AlipayOrder): Promise<any> { return; } pay(order: AlipayOrder): Promise<any> { return; }
} }

View File

@ -114,18 +114,18 @@ export interface AFAEncryptResponse {
* if(result.isAvailable){ * if(result.isAvailable){
* // it is available * // it is available
* *
* this.androidFingerprintAuth.encrypt({ clientId: "myAppName", username: "myUsername", password: "myPassword" }) * this.androidFingerprintAuth.encrypt({ clientId: 'myAppName', username: 'myUsername', password: 'myPassword' })
* .then(result => { * .then(result => {
* if (result.withFingerprint) { * if (result.withFingerprint) {
* console.log("Successfully encrypted credentials."); * console.log('Successfully encrypted credentials.');
* console.log("Encrypted credentials: " + result.token); * console.log('Encrypted credentials: ' + result.token);
* } else if (result.withBackup) { * } else if (result.withBackup) {
* console.log('Successfully authenticated with backup password!'); * console.log('Successfully authenticated with backup password!');
* } else console.log('Didn\'t authenticate!'); * } else console.log('Didn\'t authenticate!');
* }) * })
* .catch(error => { * .catch(error => {
* if (error === "Cancelled") { * if (error === 'Cancelled') {
* console.log("Fingerprint authentication cancelled"); * console.log('Fingerprint authentication cancelled');
* } else console.error(error) * } else console.error(error)
* }); * });
* *

View File

@ -19,7 +19,7 @@ import { Injectable } from '@angular/core';
* *
* Then use the following code: * Then use the following code:
* *
* ``` * ```typescript
* import { AppUpdate } from '@ionic-native/app-update'; * import { AppUpdate } from '@ionic-native/app-update';
* *
* constructor(private appUpdate: AppUpdate) { * constructor(private appUpdate: AppUpdate) {
@ -28,8 +28,6 @@ import { Injectable } from '@angular/core';
* this.appUpdate.checkAppUpdate(updateUrl); * this.appUpdate.checkAppUpdate(updateUrl);
* *
* } * }
*
*
* ``` * ```
* *
* The plugin will compare the app version and update it automatically if the API has a newer version to install. * The plugin will compare the app version and update it automatically if the API has a newer version to install.
@ -53,4 +51,3 @@ export class AppUpdate extends IonicNativePlugin {
}) })
checkAppUpdate(updateUrl: string): Promise<any> { return; } checkAppUpdate(updateUrl: string): Promise<any> { return; }
} }

View File

@ -8,7 +8,7 @@ import { Injectable } from '@angular/core';
* Plugin to serve ads through native Appodeal SDKs * Plugin to serve ads through native Appodeal SDKs
* *
* @usage * @usage
* ``` * ```typescript
* import { Appodeal } from '@ionic-native/appodeal'; * import { Appodeal } from '@ionic-native/appodeal';
* *
* constructor(private appodeal: Appodeal) { * constructor(private appodeal: Appodeal) {
@ -18,9 +18,6 @@ import { Injectable } from '@angular/core';
* appodeal.show(appodeal.AD_TYPES.REWARDED_VIDEO); * appodeal.show(appodeal.AD_TYPES.REWARDED_VIDEO);
* *
* } * }
*
*
*
* ``` * ```
*/ */
@Plugin({ @Plugin({

View File

@ -9,7 +9,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* This plugin adds turning on/off the device backlight. * This plugin adds turning on/off the device backlight.
* *
* @usage * @usage
* ``` * ```typescript
* import { Backlight } from '@ionic-native/backlight'; * import { Backlight } from '@ionic-native/backlight';
* *
* constructor(private backlight: Backlight) { } * constructor(private backlight: Backlight) { }

View File

@ -35,59 +35,59 @@ import { Observable } from 'rxjs/Observable';
* *
* ```typescript * ```typescript
* { * {
* "name": "Battery Demo", * 'name': 'Battery Demo',
* "id": "20:FF:D0:FF:D1:C0", * 'id': '20:FF:D0:FF:D1:C0',
* "advertising": [2,1,6,3,3,15,24,8,9,66,97,116,116,101,114,121], * 'advertising': [2,1,6,3,3,15,24,8,9,66,97,116,116,101,114,121],
* "rssi": -55 * 'rssi': -55
* } * }
* ``` * ```
* After connecting, the peripheral object also includes service, characteristic and descriptor information. * After connecting, the peripheral object also includes service, characteristic and descriptor information.
* *
* ```typescript * ```typescript
* { * {
* "name": "Battery Demo", * 'name': 'Battery Demo',
* "id": "20:FF:D0:FF:D1:C0", * 'id': '20:FF:D0:FF:D1:C0',
* "advertising": [2,1,6,3,3,15,24,8,9,66,97,116,116,101,114,121], * 'advertising': [2,1,6,3,3,15,24,8,9,66,97,116,116,101,114,121],
* "rssi": -55, * 'rssi': -55,
* "services": [ * 'services': [
* "1800", * '1800',
* "1801", * '1801',
* "180f" * '180f'
* ], * ],
* "characteristics": [ * 'characteristics': [
* { * {
* "service": "1800", * 'service': '1800',
* "characteristic": "2a00", * 'characteristic': '2a00',
* "properties": [ * 'properties': [
* "Read" * 'Read'
* ] * ]
* }, * },
* { * {
* "service": "1800", * 'service': '1800',
* "characteristic": "2a01", * 'characteristic': '2a01',
* "properties": [ * 'properties': [
* "Read" * 'Read'
* ] * ]
* }, * },
* { * {
* "service": "1801", * 'service': '1801',
* "characteristic": "2a05", * 'characteristic': '2a05',
* "properties": [ * 'properties': [
* "Read" * 'Read'
* ] * ]
* }, * },
* { * {
* "service": "180f", * 'service': '180f',
* "characteristic": "2a19", * 'characteristic': '2a19',
* "properties": [ * 'properties': [
* "Read" * 'Read'
* ], * ],
* "descriptors": [ * 'descriptors': [
* { * {
* "uuid": "2901" * 'uuid': '2901'
* }, * },
* { * {
* "uuid": "2904" * 'uuid': '2904'
* } * }
* ] * ]
* } * }
@ -104,10 +104,10 @@ import { Observable } from 'rxjs/Observable';
* *
* ```typescript * ```typescript
* { * {
* "name": "demo", * 'name': 'demo',
* "id": "00:1A:7D:DA:71:13", * 'id': '00:1A:7D:DA:71:13',
* "advertising": ArrayBuffer, * 'advertising': ArrayBuffer,
* "rssi": -37 * 'rssi': -37
* } * }
* ``` * ```
* *
@ -119,24 +119,24 @@ import { Observable } from 'rxjs/Observable';
* *
* ```typescript * ```typescript
* { * {
* "name": "demo", * 'name': 'demo',
* "id": "D8479A4F-7517-BCD3-91B5-3302B2F81802", * 'id': 'D8479A4F-7517-BCD3-91B5-3302B2F81802',
* "advertising": { * 'advertising': {
* "kCBAdvDataChannel": 37, * 'kCBAdvDataChannel': 37,
* "kCBAdvDataServiceData": { * 'kCBAdvDataServiceData': {
* "FED8": { * 'FED8': {
* "byteLength": 7 // data not shown * 'byteLength': 7 // data not shown
* } * }
* }, * },
* "kCBAdvDataLocalName": "demo", * 'kCBAdvDataLocalName': 'demo',
* "kCBAdvDataServiceUUIDs": ["FED8"], * 'kCBAdvDataServiceUUIDs': ['FED8'],
* "kCBAdvDataManufacturerData": { * 'kCBAdvDataManufacturerData': {
* "byteLength": 7 // data not shown * 'byteLength': 7 // data not shown
* }, * },
* "kCBAdvDataTxPowerLevel": 32, * 'kCBAdvDataTxPowerLevel': 32,
* "kCBAdvDataIsConnectable": true * 'kCBAdvDataIsConnectable': true
* }, * },
* "rssi": -53 * 'rssi': -53
* } * }
* ``` * ```
* *
@ -306,14 +306,14 @@ export class BLE extends IonicNativePlugin {
* // send 1 byte to switch a light on * // send 1 byte to switch a light on
* var data = new Uint8Array(1); * var data = new Uint8Array(1);
* data[0] = 1; * data[0] = 1;
* BLE.write(device_id, "FF10", "FF11", data.buffer); * BLE.write(device_id, 'FF10', 'FF11', data.buffer);
* *
* // send a 3 byte value with RGB color * // send a 3 byte value with RGB color
* var data = new Uint8Array(3); * var data = new Uint8Array(3);
* data[0] = 0xFF; // red * data[0] = 0xFF; // red
* data[0] = 0x00; // green * data[0] = 0x00; // green
* data[0] = 0xFF; // blue * data[0] = 0xFF; // blue
* BLE.write(device_id, "ccc0", "ccc1", data.buffer); * BLE.write(device_id, 'ccc0', 'ccc1', data.buffer);
* *
* // send a 32 bit integer * // send a 32 bit integer
* var data = new Uint32Array(1); * var data = new Uint32Array(1);
@ -357,7 +357,7 @@ export class BLE extends IonicNativePlugin {
* *
* @usage * @usage
* ``` * ```
* BLE.startNotification(device_id, "FF10", "FF11").subscribe(buffer => { * BLE.startNotification(device_id, 'FF10', 'FF11').subscribe(buffer => {
* console.log(String.fromCharCode.apply(null, new Uint8Array(buffer)); * console.log(String.fromCharCode.apply(null, new Uint8Array(buffer));
* }); * });
* ``` * ```

View File

@ -13,7 +13,7 @@ import { Observable } from 'rxjs/Observable';
* *
* *
* // Write a string * // Write a string
* this.bluetoothSerial.write("hello world").then(success, failure); * this.bluetoothSerial.write('hello world').then(success, failure);
* *
* // Array of int or bytes * // Array of int or bytes
* this.bluetoothSerial.write([186, 220, 222]).then(success, failure); * this.bluetoothSerial.write([186, 220, 222]).then(success, failure);

View File

@ -8,7 +8,7 @@ import { Observable } from 'rxjs/Observable';
* This plugin adds exchanging events between native code and your app. * This plugin adds exchanging events between native code and your app.
* *
* @usage * @usage
* ``` * ```typescript
* import { Broadcaster } from '@ionic-native/broadcaster'; * import { Broadcaster } from '@ionic-native/broadcaster';
* *
* constructor(private broadcaster: Broadcaster) { } * constructor(private broadcaster: Broadcaster) { }

View File

@ -7,7 +7,7 @@ import { Injectable } from '@angular/core';
* This plugin provides an interface to in-app browser tabs that exist on some mobile platforms, specifically [Custom Tabs](http://developer.android.com/tools/support-library/features.html#custom-tabs) on Android (including the [Chrome Custom Tabs](https://developer.chrome.com/multidevice/android/customtabs) implementation), and [SFSafariViewController](https://developer.apple.com/library/ios/documentation/SafariServices/Reference/SFSafariViewController_Ref/) on iOS. * This plugin provides an interface to in-app browser tabs that exist on some mobile platforms, specifically [Custom Tabs](http://developer.android.com/tools/support-library/features.html#custom-tabs) on Android (including the [Chrome Custom Tabs](https://developer.chrome.com/multidevice/android/customtabs) implementation), and [SFSafariViewController](https://developer.apple.com/library/ios/documentation/SafariServices/Reference/SFSafariViewController_Ref/) on iOS.
* *
* @usage * @usage
* ``` * ```typescript
* import { BrowserTab } from '@ionic-native/browser-tab'; * import { BrowserTab } from '@ionic-native/browser-tab';
* *
* constructor(private browserTab: BrowserTab) { * constructor(private browserTab: BrowserTab) {

View File

@ -59,7 +59,7 @@ export interface CalendarOptions {
* *
* *
* @usage * @usage
* ``` * ```typescript
* import { Calendar } from '@ionic-native/calendar'; * import { Calendar } from '@ionic-native/calendar';
* *
* constructor(private calendar: Calendar) { } * constructor(private calendar: Calendar) { }

View File

@ -6,7 +6,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* Call a number directly from your Cordova/Ionic application. * Call a number directly from your Cordova/Ionic application.
* *
* @usage * @usage
* ``` * ```typescript
* import { CallNumber } from '@ionic-native/call-number'; * import { CallNumber } from '@ionic-native/call-number';
* *
* constructor(private callNumber: CallNumber) { } * constructor(private callNumber: CallNumber) { }

View File

@ -133,7 +133,7 @@ export interface CardIOResponse {
* @name Card IO * @name Card IO
* @description * @description
* @usage * @usage
* ``` * ```typescript
* import { CardIO } from '@ionic-native/card-io'; * import { CardIO } from '@ionic-native/card-io';
* *
* constructor(private cardIO: CardIO) { } * constructor(private cardIO: CardIO) { }

View File

@ -8,7 +8,7 @@ import { Injectable } from '@angular/core';
* Plugin to install Couchbase Lite in your PhoneGap app on iOS or Android * Plugin to install Couchbase Lite in your PhoneGap app on iOS or Android
* *
* @usage * @usage
* ``` * ```typescript
* import { CouchbaseLite } from '@ionic-native/couchbase-lite'; * import { CouchbaseLite } from '@ionic-native/couchbase-lite';
* *
* constructor(private couchbase: CouchbaseLite) { * constructor(private couchbase: CouchbaseLite) {

View File

@ -5,7 +5,7 @@ import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
* @name Crop * @name Crop
* @description Crops images * @description Crops images
* @usage * @usage
* ``` * ```typescript
* import { Crop } from '@ionic-native/crop'; * import { Crop } from '@ionic-native/crop';
* *
* constructor(private crop: Crop) { } * constructor(private crop: Crop) { }
@ -14,8 +14,8 @@ import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
* *
* this.crop.crop('path/to/image.jpg', {quality: 75}) * this.crop.crop('path/to/image.jpg', {quality: 75})
* .then( * .then(
* newImage => console.log("new image path is: " + newImage), * newImage => console.log('new image path is: ' + newImage),
* error => console.error("Error cropping image", error) * error => console.error('Error cropping image', error)
* ); * );
* ``` * ```
*/ */

View File

@ -7,7 +7,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* Plugin that lets you provide haptic or acoustic feedback on Android devices. * Plugin that lets you provide haptic or acoustic feedback on Android devices.
* *
* @usage * @usage
* ``` * ```typescript
* import { DeviceFeedback } from '@ionic-native/device-feedback'; * import { DeviceFeedback } from '@ionic-native/device-feedback';
* *
* constructor(private deviceFeedback: DeviceFeedback) { } * constructor(private deviceFeedback: DeviceFeedback) { }

View File

@ -8,7 +8,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* Opens the file picker on Android for the user to select a file, returns a file URI. * Opens the file picker on Android for the user to select a file, returns a file URI.
* *
* @usage * @usage
* ``` * ```typescript
* import { FileChooser } from '@ionic-native/file-chooser'; * import { FileChooser } from '@ionic-native/file-chooser';
* *
* constructor(private fileChooser: FileChooser) { } * constructor(private fileChooser: FileChooser) { }

View File

@ -7,7 +7,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* This plugin will open a file on your device file system with its default application. * This plugin will open a file on your device file system with its default application.
* *
* @usage * @usage
* ``` * ```typescript
* import { FileOpener } from '@ionic-native/file-opener'; * import { FileOpener } from '@ionic-native/file-opener';
* *
* constructor(private fileOpener: FileOpener) { } * constructor(private fileOpener: FileOpener) { }

View File

@ -10,7 +10,7 @@ declare var window: any;
* This plugin allows you to resolve the native filesystem path for Android content URIs and is based on code in the aFileChooser library. * This plugin allows you to resolve the native filesystem path for Android content URIs and is based on code in the aFileChooser library.
* *
* @usage * @usage
* ``` * ```typescript
* import { FilePath } from '@ionic-native/file-path'; * import { FilePath } from '@ionic-native/file-path';
* *
* constructor(private filePath: FilePath) { } * constructor(private filePath: FilePath) { }

View File

@ -35,8 +35,8 @@ export interface FingerprintOptions {
* ... * ...
* *
* this.faio.show({ * this.faio.show({
* clientId: "Fingerprint-Demo", * clientId: 'Fingerprint-Demo',
* clientSecret: "password", //Only necessary for Android * clientSecret: 'password', //Only necessary for Android
* disableBackup:true //Only for Android(optional) * disableBackup:true //Only for Android(optional)
* }) * })
* .then((result: any) => console.log(result)) * .then((result: any) => console.log(result))

View File

@ -8,7 +8,7 @@ import { Observable } from 'rxjs/Observable';
* This plugin brings push notifications, analytics, event tracking, crash reporting and more from Google Firebase to your Cordova project! Android and iOS supported (including iOS 10). * This plugin brings push notifications, analytics, event tracking, crash reporting and more from Google Firebase to your Cordova project! Android and iOS supported (including iOS 10).
* *
* @usage * @usage
* ``` * ```typescript
* import { Firebase } from '@ionic-native/firebase'; * import { Firebase } from '@ionic-native/firebase';
* *
* constructor(private firebase: Firebase) { } * constructor(private firebase: Firebase) { }

View File

@ -17,7 +17,6 @@ import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
* *
* this.flashlight.switchOn(); * this.flashlight.switchOn();
* *
*
* ``` * ```
*/ */
@Plugin({ @Plugin({

View File

@ -78,7 +78,7 @@ export interface FlurryAnalyticsLocation {
* This plugin connects to Flurry Analytics SDK * This plugin connects to Flurry Analytics SDK
* *
* @usage * @usage
* ``` * ```typescript
* import { FlurryAnalytics } from 'ionic-native/flurry-analytics'; * import { FlurryAnalytics } from 'ionic-native/flurry-analytics';
* *
* constructor(private flurryAnalytics: FlurryAnalytics) { } * constructor(private flurryAnalytics: FlurryAnalytics) { }

View File

@ -9,7 +9,7 @@ declare var window: any;
* @description Monitors circular geofences around latitude/longitude coordinates, and sends a notification to the user when the boundary of a geofence is crossed. Notifications can be sent when the user enters and/or exits a geofence. * @description Monitors circular geofences around latitude/longitude coordinates, and sends a notification to the user when the boundary of a geofence is crossed. Notifications can be sent when the user enters and/or exits a geofence.
* Geofences persist after device reboot. Geofences will be monitored even when the app is not running. * Geofences persist after device reboot. Geofences will be monitored even when the app is not running.
* @usage * @usage
* ``` * ```typescript
* import { Geofence } from '@ionic-native/geofence'; * import { Geofence } from '@ionic-native/geofence';
* *
* ... * ...
@ -28,15 +28,15 @@ declare var window: any;
* private addGeofence() { * private addGeofence() {
* //options describing geofence * //options describing geofence
* let fence = { * let fence = {
* id: "69ca1b88-6fbe-4e80-a4d4-ff4d3748acdb", //any unique ID * id: '69ca1b88-6fbe-4e80-a4d4-ff4d3748acdb', //any unique ID
* latitude: 37.285951, //center of geofence radius * latitude: 37.285951, //center of geofence radius
* longitude: -121.936650, * longitude: -121.936650,
* radius: 100, //radius to edge of geofence * radius: 100, //radius to edge of geofence
* transitionType: 3, //see 'Transition Types' below * transitionType: 3, //see 'Transition Types' below
* notification: { //notification settings * notification: { //notification settings
* id: 1, //any unique ID * id: 1, //any unique ID
* title: "You crossed a fence", //notification title * title: 'You crossed a fence', //notification title
* text: "You just arrived to Gliwice city center.", //notification body * text: 'You just arrived to Gliwice city center.', //notification body
* openAppOnClick: true //open app when notification is tapped * openAppOnClick: true //open app when notification is tapped
* } * }
* } * }

View File

@ -370,7 +370,7 @@ export class GoogleMap {
* @name Google Maps * @name Google Maps
* @description This plugin uses the native Google Maps SDK * @description This plugin uses the native Google Maps SDK
* @usage * @usage
* ``` * ```typescript
* import { * import {
* GoogleMaps, * GoogleMaps,
* GoogleMap, * GoogleMap,

View File

@ -43,7 +43,7 @@ export interface GyroscopeOptions {
* @name Gyroscope * @name Gyroscope
* @description Read Gyroscope sensor data * @description Read Gyroscope sensor data
* @usage * @usage
* ``` * ```typescript
* import { Gyroscope, GyroscopeOrientation, GyroscopeOptions } from '@ionic-native/gyroscope'; * import { Gyroscope, GyroscopeOrientation, GyroscopeOptions } from '@ionic-native/gyroscope';
* *
* *

View File

@ -14,7 +14,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* *
* ... * ...
* *
* this.headerColor.tint("#becb29"); * this.headerColor.tint('#becb29');
* ``` * ```
*/ */
@Plugin({ @Plugin({

View File

@ -160,7 +160,7 @@ export interface HealthData {
* A plugin that abstracts fitness and health repositories like Apple HealthKit or Google Fit. * A plugin that abstracts fitness and health repositories like Apple HealthKit or Google Fit.
* *
* @usage * @usage
* ``` * ```typescript
* import { Health } from '@ionic-native/health'; * import { Health } from '@ionic-native/health';
* *
* *

View File

@ -30,7 +30,7 @@ export interface HTTPResponse {
* - SSL Pinning * - SSL Pinning
* *
* @usage * @usage
* ``` * ```typescript
* import { HTTP } from '@ionic-native/http'; * import { HTTP } from '@ionic-native/http';
* *
* constructor(private http: HTTP) { } * constructor(private http: HTTP) { }

View File

@ -8,7 +8,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* A lightweight Cordova plugin for in app purchases on iOS/Android. * A lightweight Cordova plugin for in app purchases on iOS/Android.
* *
* @usage * @usage
* ```ts * ```typescript
* import { InAppPurchase } from '@ionic-native/in-app-purchase'; * import { InAppPurchase } from '@ionic-native/in-app-purchase';
* *
* constructor(private iap: InAppPurchase) { } * constructor(private iap: InAppPurchase) { }
@ -44,7 +44,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* *
* @advanced * @advanced
* *
* ```ts * ```typescript
* // fist buy the product... * // fist buy the product...
* this.iap * this.iap
* .buy('consumable_prod1') * .buy('consumable_prod1')

View File

@ -6,7 +6,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* @description Share a photo with the instagram app * @description Share a photo with the instagram app
* *
* @usage * @usage
* ``` * ```typescript
* import { Instagram } from '@ionic-native/instagram'; * import { Instagram } from '@ionic-native/instagram';
* *
* constructor(private instagram: Instagram) { } * constructor(private instagram: Instagram) { }

View File

@ -40,7 +40,7 @@ export interface IntelSecurityDataOptions {
* For more information please visit the [API documentation](https://software.intel.com/en-us/app-security-api/api). * For more information please visit the [API documentation](https://software.intel.com/en-us/app-security-api/api).
* *
* @usage * @usage
* ``` * ```typescript
* import { IntelSecurity } from '@ionic-native/intel-security'; * import { IntelSecurity } from '@ionic-native/intel-security';
* ... * ...
* constructor(private intelSecurity: IntelSecurity) { } * constructor(private intelSecurity: IntelSecurity) { }

View File

@ -8,7 +8,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* Debug mode is when the app is built and installed locally via xcode / eclipse / the cordova cli etc, compared to release mode when the app was downloaded from the app / play store via an end user. * Debug mode is when the app is built and installed locally via xcode / eclipse / the cordova cli etc, compared to release mode when the app was downloaded from the app / play store via an end user.
* *
* @usage * @usage
* ``` * ```typescript
* import { IsDebug } from '@ionic-native/is-debug'; * import { IsDebug } from '@ionic-native/is-debug';
* *
* constructor(private isDebug: IsDebug) { } * constructor(private isDebug: IsDebug) { }

View File

@ -10,7 +10,7 @@ declare var cordova: any;
* Implementation of the JINS MEME SDK * Implementation of the JINS MEME SDK
* *
* @usage * @usage
* ``` * ```typescript
* import { JinsMeme } from '@ionic-native/jins-meme'; * import { JinsMeme } from '@ionic-native/jins-meme';
* *
* constructor(private jinsMeme: JinsMeme) { } * constructor(private jinsMeme: JinsMeme) { }

View File

@ -10,7 +10,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* On iOS, the plugin opens the app's storepage in the App Store and focuses the Review tab, where the user can leave a review by pressing "Write a review". * On iOS, the plugin opens the app's storepage in the App Store and focuses the Review tab, where the user can leave a review by pressing "Write a review".
* *
* @usage * @usage
* ``` * ```typescript
* import { LaunchReview } from '@ionic-native/launch-review'; * import { LaunchReview } from '@ionic-native/launch-review';
* *
* constructor(private launchReview: LaunchReview) { } * constructor(private launchReview: LaunchReview) { }

View File

@ -11,7 +11,7 @@ export type LinkedInLoginScopes = 'r_basicprofile' | 'r_emailaddress' | 'rw_comp
* Please see the [plugin's repo](https://github.com/zyramedia/cordova-plugin-linkedin#installation) for detailed installation steps. * Please see the [plugin's repo](https://github.com/zyramedia/cordova-plugin-linkedin#installation) for detailed installation steps.
* *
* @usage * @usage
* ``` * ```typescript
* import { LinkedIn } from '@ionic-native/linkedin'; * import { LinkedIn } from '@ionic-native/linkedin';
* *
* constructor(private linkedin: LinkedIn) { } * constructor(private linkedin: LinkedIn) { }

View File

@ -7,7 +7,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* This Cordova/Phonegap plugin for Android and iOS to request enabling/changing of Location Services by triggering a native dialog from within the app, avoiding the need for the user to leave your app to change location settings manually. * This Cordova/Phonegap plugin for Android and iOS to request enabling/changing of Location Services by triggering a native dialog from within the app, avoiding the need for the user to leave your app to change location settings manually.
* *
* @usage * @usage
* ``` * ```typescript
* import { LocationAccuracy } from '@ionic-native/location-accuracy'; * import { LocationAccuracy } from '@ionic-native/location-accuracy';
* *
* constructor(private locationAccuracy: LocationAccuracy) { } * constructor(private locationAccuracy: LocationAccuracy) { }

View File

@ -6,7 +6,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* Opens an app's page in the market place (Google Play, App Store) * Opens an app's page in the market place (Google Play, App Store)
* *
* @usage * @usage
* ``` * ```typescript
* import { Market } from '@ionic-native/market'; * import { Market } from '@ionic-native/market';
* *
* constructor(private market: Market) { } * constructor(private market: Market) { }

View File

@ -9,7 +9,7 @@ declare var mixpanel: any;
* Cordova Plugin that wraps Mixpanel SDK for Android and iOS * Cordova Plugin that wraps Mixpanel SDK for Android and iOS
* *
* @usage * @usage
* ``` * ```typescript
* import { Mixpanel, MixpanelPeople } from '@ionic-native/mixpanel'; * import { Mixpanel, MixpanelPeople } from '@ionic-native/mixpanel';
* *
* constructor(private mixpanel: Mixpanel, private mixpanelPeople: MixpanelPeople) { } * constructor(private mixpanel: Mixpanel, private mixpanelPeople: MixpanelPeople) { }

View File

@ -25,7 +25,7 @@ export interface MusicControlsOptions {
* Handle also headset event (plug, unplug, headset button). * Handle also headset event (plug, unplug, headset button).
* *
* @usage * @usage
* ``` * ```typescript
* import { MusicControls } from '@ionic-native/music-controls'; * import { MusicControls } from '@ionic-native/music-controls';
* *
* constructor(private musicControls: MusicControls) { } * constructor(private musicControls: MusicControls) { }

View File

@ -16,11 +16,11 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* ... * ...
* *
* this.nativeGeocoder.reverseGeocode(52.5072095, 13.1452818) * this.nativeGeocoder.reverseGeocode(52.5072095, 13.1452818)
* .then((result: NativeGeocoderReverseResult) => console.log("The address is " + result.street + " in " + result.countryCode)) * .then((result: NativeGeocoderReverseResult) => console.log('The address is ' + result.street + ' in ' + result.countryCode))
* .catch((error: any) => console.log(error)); * .catch((error: any) => console.log(error));
* *
* this.nativeGeocoder.forwardGeocode("Berlin") * this.nativeGeocoder.forwardGeocode('Berlin')
* .then((coordinates: NativeGeocoderForwardResult) => console.log("The coordinates are latitude=" + coordinates.latitude + " and longitude=" + coordinates.longitude)) * .then((coordinates: NativeGeocoderForwardResult) => console.log('The coordinates are latitude=' + coordinates.latitude + ' and longitude=' + coordinates.longitude))
* .catch((error: any) => console.log(error)); * .catch((error: any) => console.log(error));
* ``` * ```
* @interfaces * @interfaces

View File

@ -22,7 +22,7 @@ export interface NativeTransitionOptions {
* The Native Page Transitions plugin uses native hardware acceleration to animate your transitions between views. You have complete control over the type of transition, the duration, and direction. * The Native Page Transitions plugin uses native hardware acceleration to animate your transitions between views. You have complete control over the type of transition, the duration, and direction.
* *
* @usage * @usage
* ``` * ```typescript
* import { NativePageTransitions, NativeTransitionOptions } from '@ionic-native/native-page-transitions'; * import { NativePageTransitions, NativeTransitionOptions } from '@ionic-native/native-page-transitions';
* *
* constructor(private nativePageTransitions: NativePageTransitions) { } * constructor(private nativePageTransitions: NativePageTransitions) { }

View File

@ -16,7 +16,7 @@ declare let window: any;
* This plugin uses NDEF (NFC Data Exchange Format) for maximum compatibilty between NFC devices, tag types, and operating systems. * This plugin uses NDEF (NFC Data Exchange Format) for maximum compatibilty between NFC devices, tag types, and operating systems.
* *
* @usage * @usage
* ``` * ```typescript
* import { NFC, Ndef } from '@ionic-native/nfc'; * import { NFC, Ndef } from '@ionic-native/nfc';
* *
* constructor(private nfc: NFC, private ndef: Ndef) { } * constructor(private nfc: NFC, private ndef: Ndef) { }

View File

@ -6,7 +6,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* PayPal plugin for Cordova/Ionic Applications * PayPal plugin for Cordova/Ionic Applications
* *
* @usage * @usage
* ``` * ```typescript
* import { PayPal, PayPalPayment, PayPalConfiguration } from '@ionic-native/paypal'; * import { PayPal, PayPalPayment, PayPalConfiguration } from '@ionic-native/paypal';
* *
* constructor(private payPal: PayPal) { } * constructor(private payPal: PayPal) { }
@ -15,8 +15,8 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* *
* *
* this.payPal.init({ * this.payPal.init({
* PayPalEnvironmentProduction: "YOUR_PRODUCTION_CLIENT_ID", * PayPalEnvironmentProduction: 'YOUR_PRODUCTION_CLIENT_ID',
* PayPalEnvironmentSandbox: "YOUR_SANDBOX_CLIENT_ID" * PayPalEnvironmentSandbox: 'YOUR_SANDBOX_CLIENT_ID'
* }).then(() => { * }).then(() => {
* // Environments: PayPalEnvironmentNoNetwork, PayPalEnvironmentSandbox, PayPalEnvironmentProduction * // Environments: PayPalEnvironmentNoNetwork, PayPalEnvironmentSandbox, PayPalEnvironmentProduction
* this.payPal.prepareToRender('PayPalEnvironmentSandbox', new PayPalConfiguration({ * this.payPal.prepareToRender('PayPalEnvironmentSandbox', new PayPalConfiguration({

View File

@ -21,7 +21,7 @@ export interface IPedometerData {
* such as step counts and other information about the distance travelled. * such as step counts and other information about the distance travelled.
* *
* @usage * @usage
* ``` * ```typescript
* import { Pedometer } from '@ionic-native/pedometer'; * import { Pedometer } from '@ionic-native/pedometer';
* *
* Pedometer.isDistanceAvailable() * Pedometer.isDistanceAvailable()

View File

@ -10,7 +10,7 @@ import { Injectable } from '@angular/core';
* cdvphotolibrary urls should be trusted by Angular. See plugin homepage to learn how. * cdvphotolibrary urls should be trusted by Angular. See plugin homepage to learn how.
* *
* @usage * @usage
* ``` * ```typescript
* import { PhotoLibrary } from '@ionic-native/photo-library'; * import { PhotoLibrary } from '@ionic-native/photo-library';
* *
* constructor(private photoLibrary: PhotoLibrary) { } * constructor(private photoLibrary: PhotoLibrary) { }
@ -32,10 +32,10 @@ import { Injectable } from '@angular/core';
* }); * });
* }, * },
* error: err => {}, * error: err => {},
* complete: () => { console.log("could not get photos"); } * complete: () => { console.log('could not get photos'); }
* }); * });
* }) * })
* .catch(err => console.log("permissions weren't granted")); * .catch(err => console.log('permissions weren't granted'));
* *
* ``` * ```
*/ */

View File

@ -133,7 +133,7 @@ export interface PinterestPin {
* Cordova plugin for Pinterest * Cordova plugin for Pinterest
* *
* @usage * @usage
* ``` * ```typescript
* import { Pinterest, PinterestUser, PinterestPin, PinterestBoard } from '@ionic-native/pinterest'; * import { Pinterest, PinterestUser, PinterestPin, PinterestBoard } from '@ionic-native/pinterest';
* *
* constructor(private pinterest: Pinterest) { } * constructor(private pinterest: Pinterest) { }

View File

@ -7,7 +7,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* It should be used for applications which keep running for a long time without any user interaction. * It should be used for applications which keep running for a long time without any user interaction.
* *
* @usage * @usage
* ``` * ```typescript
* import { PowerManagement } from '@ionic-native/power-management'; * import { PowerManagement } from '@ionic-native/power-management';
* *
* constructor(private powerManagement: PowerManagement) { } * constructor(private powerManagement: PowerManagement) { }

View File

@ -8,7 +8,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* This plugin adds Rollbar App monitoring to your application * This plugin adds Rollbar App monitoring to your application
* *
* @usage * @usage
* ``` * ```typescript
* import { Rollbar } from '@ionic-native/rollbar'; * import { Rollbar } from '@ionic-native/rollbar';
* *
* constructor(private rollbar: Rollbar) { } * constructor(private rollbar: Rollbar) { }

View File

@ -16,7 +16,7 @@ export interface SafariViewControllerOptions {
* @name Safari View Controller * @name Safari View Controller
* @description * @description
* @usage * @usage
* ``` * ```typescript
* import { SafariViewController } from '@ionic-native/safari-view-controller'; * import { SafariViewController } from '@ionic-native/safari-view-controller';
* *
* constructor(private safariViewController: SafariViewController) { } * constructor(private safariViewController: SafariViewController) { }

View File

@ -20,8 +20,7 @@ export interface SerialOpenOptions {
* This plugin provides functions for working with Serial connections * This plugin provides functions for working with Serial connections
* *
* @usage * @usage
* * ```typescript
* ```
* import { Serial } from '@ionic-native/serial'; * import { Serial } from '@ionic-native/serial';
* *
* constructor(private serial: Serial) { } * constructor(private serial: Serial) { }

View File

@ -50,7 +50,7 @@ export interface SpeechRecognitionListeningOptionsAndroid {
* This plugin does speech recognition using cloud services * This plugin does speech recognition using cloud services
* *
* @usage * @usage
* ``` * ```typescript
* import { SpeechRecognition } from '@ionic-native/speech-recognition'; * import { SpeechRecognition } from '@ionic-native/speech-recognition';
* *
* constructor(private speechRecognition: SpeechRecognition) { } * constructor(private speechRecognition: SpeechRecognition) { }

View File

@ -7,7 +7,7 @@ import { Injectable } from '@angular/core';
* This Cordova/Phonegap plugin can be used to import/export to/from a SQLite database using either SQL or JSON. * This Cordova/Phonegap plugin can be used to import/export to/from a SQLite database using either SQL or JSON.
* *
* @usage * @usage
* ``` * ```typescript
* import { SQLitePorter } from '@ionic-native/sqlite-porter'; * import { SQLitePorter } from '@ionic-native/sqlite-porter';
* *
* *
@ -15,7 +15,7 @@ import { Injectable } from '@angular/core';
* *
* ... * ...
* *
* let db = window.openDatabase("Test", "1.0", "TestDB", 1 * 1024); * let db = window.openDatabase('Test', '1.0', 'TestDB', 1 * 1024);
* // or we can use SQLite plugin * // or we can use SQLite plugin
* // we will assume that we injected SQLite into this component as sqlite * // we will assume that we injected SQLite into this component as sqlite
* this.sqlite.create({ * this.sqlite.create({
@ -28,8 +28,8 @@ import { Injectable } from '@angular/core';
* }); * });
* *
* *
* let sql = "CREATE TABLE Artist ([Id] PRIMARY KEY, [Title]);" + * let sql = 'CREATE TABLE Artist ([Id] PRIMARY KEY, [Title]);' +
* "INSERT INTO Artist(Id,Title) VALUES ('1','Fred');"; * 'INSERT INTO Artist(Id,Title) VALUES ("1","Fred");';
* *
* this.sqlitePorter.importSqlToDb(db, sql) * this.sqlitePorter.importSqlToDb(db, sql)
* .then(() => console.log('Imported')) * .then(() => console.log('Imported'))

View File

@ -10,7 +10,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* - read device's stepcounter data * - read device's stepcounter data
* *
* @usage * @usage
* ``` * ```typescript
* import { Stepcounter } from '@ionic-native/stepcounter'; * import { Stepcounter } from '@ionic-native/stepcounter';
* *
* constructor(private stepcounter: Stepcounter) { } * constructor(private stepcounter: Stepcounter) { }

View File

@ -22,7 +22,7 @@ export interface StreamingAudioOptions {
* This plugin allows you to stream audio and video in a fullscreen, native player on iOS and Android. * This plugin allows you to stream audio and video in a fullscreen, native player on iOS and Android.
* *
* @usage * @usage
* ``` * ```typescript
* import { StreamingMedia, StreamingVideoOptions } from '@ionic-native/streaming-media'; * import { StreamingMedia, StreamingVideoOptions } from '@ionic-native/streaming-media';
* *
* constructor(private streamingMedia: StreamingMedia) { } * constructor(private streamingMedia: StreamingMedia) { }

View File

@ -85,7 +85,7 @@ export interface StripeBankAccountParams {
* A plugin that allows you to use Stripe's Native SDKs for Android and iOS. * A plugin that allows you to use Stripe's Native SDKs for Android and iOS.
* *
* @usage * @usage
* ``` * ```typescript
* import { Stripe } from '@ionic-native/stripe'; * import { Stripe } from '@ionic-native/stripe';
* *
* constructor(private stripe: Stripe) { } * constructor(private stripe: Stripe) { }

View File

@ -7,7 +7,7 @@ import { Injectable } from '@angular/core';
* An Ionic plugin to use Taptic Engine API on iPHone 7, 7 Plus or newer. * An Ionic plugin to use Taptic Engine API on iPHone 7, 7 Plus or newer.
* *
* @usage * @usage
* ```ts * ```typescript
* import { TapticEngine } from '@ionic-native/taptic-engine'; * import { TapticEngine } from '@ionic-native/taptic-engine';
* *
* ... * ...

View File

@ -16,7 +16,7 @@ export interface TTSOptions {
* Text to Speech plugin * Text to Speech plugin
* *
* @usage * @usage
* ``` * ```typescript
* import { TextToSpeech } from '@ionic-native/text-to-speech'; * import { TextToSpeech } from '@ionic-native/text-to-speech';
* *
* constructor(private tts: TextToSpeech) { } * constructor(private tts: TextToSpeech) { }

View File

@ -140,7 +140,7 @@ export class ThemeableBrowserObject {
* In-app browser that allows styling. * In-app browser that allows styling.
* *
* @usage * @usage
* ``` * ```typescript
* import { ThemeableBrowser, ThemeableBrowserOptions, ThemeableBrowserObject } from '@ionic-native/themeable-browser'; * import { ThemeableBrowser, ThemeableBrowserOptions, ThemeableBrowserObject } from '@ionic-native/themeable-browser';
* *
* constructor(private themeableBrowser: ThemeableBrowser) { } * constructor(private themeableBrowser: ThemeableBrowser) { }

View File

@ -63,22 +63,22 @@ export interface ThreeDeeTouchForceTouch {
* @description * @description
* @usage * @usage
* Please do refer to the original plugin's repo for detailed usage. The usage example here might not be sufficient. * Please do refer to the original plugin's repo for detailed usage. The usage example here might not be sufficient.
* ``` * ```typescript
* import { ThreeDeeTouch, ThreeDeeTouchQuickAction, ThreeDeeTouchForceTouch } from '@ionic-native/three-dee-touch'; * import { ThreeDeeTouch, ThreeDeeTouchQuickAction, ThreeDeeTouchForceTouch } from '@ionic-native/three-dee-touch';
* *
* constructor(private threeDeeTouch: ThreeDeeTouch) { } * constructor(private threeDeeTouch: ThreeDeeTouch) { }
* *
* ... * ...
* *
* this.threeDeeTouch.isAvailable().then(isAvailable => console.log("3D Touch available? " + isAvailable)); * this.threeDeeTouch.isAvailable().then(isAvailable => console.log('3D Touch available? ' + isAvailable));
* *
* this.threeDeeTouch.watchForceTouches() * this.threeDeeTouch.watchForceTouches()
* .subscribe( * .subscribe(
* (data: ThreeDeeTouchForceTouch) => { * (data: ThreeDeeTouchForceTouch) => {
* console.log("Force touch %" + data.force); * console.log('Force touch %' + data.force);
* console.log("Force touch timestamp: " + data.timestamp); * console.log('Force touch timestamp: ' + data.timestamp);
* console.log("Force touch x: " + data.x); * console.log('Force touch x: ' + data.x);
* console.log("Force touch y: " + data.y); * console.log('Force touch y: ' + data.y);
* } * }
* ); * );
* *

View File

@ -51,7 +51,7 @@ export interface ToastOptions {
* *
* ... * ...
* *
* this.toast.show("I'm a toast", '5000', 'center').subscribe( * this.toast.show('I'm a toast', '5000', 'center').subscribe(
* toast => { * toast => {
* console.log(toast); * console.log(toast);
* } * }

View File

@ -7,7 +7,7 @@ import { Injectable } from '@angular/core';
* This plugin produces a unique, cross-install, app-specific device id. * This plugin produces a unique, cross-install, app-specific device id.
* *
* @usage * @usage
* ``` * ```typescript
* import { UniqueDeviceID } from '@ionic-native/unique-device-id'; * import { UniqueDeviceID } from '@ionic-native/unique-device-id';
* *
* constructor(private uniqueDeviceID: UniqueDeviceID) { } * constructor(private uniqueDeviceID: UniqueDeviceID) { }

View File

@ -124,7 +124,7 @@ export interface VideoInfo {
* @description Edit videos using native device APIs * @description Edit videos using native device APIs
* *
* @usage * @usage
* ``` * ```typescript
* import { VideoEditor } from '@ionic-native/video-editor'; * import { VideoEditor } from '@ionic-native/video-editor';
* *
* constructor(private videoEditor: VideoEditor) { } * constructor(private videoEditor: VideoEditor) { }

View File

@ -33,7 +33,7 @@ export interface VideoOptions {
* ... * ...
* *
* // Playing a video. * // Playing a video.
* this.videoPlayer.play("file:///android_asset/www/movie.mp4").then(() => { * this.videoPlayer.play('file:///android_asset/www/movie.mp4').then(() => {
* console.log('video completed'); * console.log('video completed');
* }).catch(err => { * }).catch(err => {
* console.log(err); * console.log(err);

View File

@ -6,7 +6,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* Plays YouTube videos in Native YouTube App * Plays YouTube videos in Native YouTube App
* *
* @usage * @usage
* ``` * ```typescript
* import { YoutubeVideoPlayer } from '@ionic-native/youtube-video-player'; * import { YoutubeVideoPlayer } from '@ionic-native/youtube-video-player';
* *
* constructor(private youtube: YoutubeVideoPlayer) { } * constructor(private youtube: YoutubeVideoPlayer) { }

View File

@ -43,7 +43,7 @@ export interface ZBarOptions {
* Requires Cordova plugin: `cordova-plugin-cszbar`. For more info, please see the [zBar plugin docs](https://github.com/tjwoon/csZBar). * Requires Cordova plugin: `cordova-plugin-cszbar`. For more info, please see the [zBar plugin docs](https://github.com/tjwoon/csZBar).
* *
* @usage * @usage
* ``` * ```typescript
* import { ZBar, ZBarOptions } from '@ionic-native/z-bar'; * import { ZBar, ZBarOptions } from '@ionic-native/z-bar';
* *
* constructor(private zbar: ZBar) { } * constructor(private zbar: ZBar) { }
@ -51,7 +51,7 @@ export interface ZBarOptions {
* ... * ...
* *
* let ZBarOptions = { * let ZBarOptions = {
* flash: "off", * flash: 'off',
* drawSight: false * drawSight: false
* }; * };
* *

View File

@ -7,7 +7,7 @@ import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
* A Cordova plugin to unzip files in Android and iOS. * A Cordova plugin to unzip files in Android and iOS.
* *
* @usage * @usage
* ``` * ```typescript
* import { Zip } from '@ionic-native/zip'; * import { Zip } from '@ionic-native/zip';
* *
* constructor(private zip: Zip) { } * constructor(private zip: Zip) { }