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

@ -127,10 +127,10 @@ export function InstanceCheck(opts: CordovaCheckOptions = {}) {
if (opts.sync) { if (opts.sync) {
return; return;
} else if (opts.observable) { } else if (opts.observable) {
return new Observable<any>(() => {}); return new Observable<any>(() => { });
} }
return getPromise(() => {}); return getPromise(() => { });
} }
} }
@ -290,10 +290,10 @@ export function CordovaProperty(target: any, key: string) {
export function InstanceProperty(target: any, key: string) { export function InstanceProperty(target: any, key: string) {
Object.defineProperty(target, key, { Object.defineProperty(target, key, {
enumerable: true, enumerable: true,
get: function(){ get: function() {
return this._objectInstance[key]; return this._objectInstance[key];
}, },
set: function(value){ set: function(value) {
this._objectInstance[key] = value; this._objectInstance[key] = value;
} }
}); });

View File

@ -21,7 +21,7 @@ export class IonicNativePlugin {
/** /**
* Returns the original plugin object * Returns the original plugin object
*/ */
static getPlugin(): any {} static getPlugin(): any { }
/** /**
* Returns the plugin's name * Returns the plugin's name

View File

@ -150,7 +150,7 @@ function wrapPromise(pluginObj: any, methodName: string, args: any[], opts: any
return p; return p;
} }
function wrapOtherPromise(pluginObj: any, methodName: string, args: any[], opts: any= {}) { function wrapOtherPromise(pluginObj: any, methodName: string, args: any[], opts: any = {}) {
return getPromise((resolve, reject) => { return getPromise((resolve, reject) => {
const pluginResult = callCordovaPlugin(pluginObj, methodName, args, opts); const pluginResult = callCordovaPlugin(pluginObj, methodName, args, opts);
if (pluginResult) { if (pluginResult) {
@ -225,7 +225,7 @@ export function overrideFunction(pluginObj: any, methodName: string, args: any[]
if (availabilityCheck === true) { if (availabilityCheck === true) {
const pluginInstance = getPlugin(pluginObj.constructor.getPluginRef()); const pluginInstance = getPlugin(pluginObj.constructor.getPluginRef());
pluginInstance[methodName] = observer.next.bind(observer); pluginInstance[methodName] = observer.next.bind(observer);
return () => pluginInstance[methodName] = () => {}; return () => pluginInstance[methodName] = () => { };
} else { } else {
observer.error(availabilityCheck); observer.error(availabilityCheck);
observer.complete(); observer.complete();

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)
* }); * });
* *
@ -156,7 +156,7 @@ export class AndroidFingerprintAuth extends IonicNativePlugin {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
encrypt(options: AFAAuthOptions): Promise<AFAEncryptResponse> {return; } encrypt(options: AFAAuthOptions): Promise<AFAEncryptResponse> { return; }
/** /**
* Opens a native dialog fragment to use the device hardware fingerprint scanner to authenticate against fingerprints registered for the device. * Opens a native dialog fragment to use the device hardware fingerprint scanner to authenticate against fingerprints registered for the device.
@ -164,19 +164,19 @@ export class AndroidFingerprintAuth extends IonicNativePlugin {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
decrypt(options: AFAAuthOptions): Promise<AFADecryptOptions> {return; } decrypt(options: AFAAuthOptions): Promise<AFADecryptOptions> { return; }
/** /**
* Check if service is available * Check if service is available
* @returns {Promise<any>} Returns a Promise that resolves if fingerprint auth is available on the device * @returns {Promise<any>} Returns a Promise that resolves if fingerprint auth is available on the device
*/ */
@Cordova() @Cordova()
isAvailable(): Promise<{isAvailable: boolean}> { return; } isAvailable(): Promise<{ isAvailable: boolean }> { return; }
/** /**
* Delete the cipher used for encryption and decryption by username * Delete the cipher used for encryption and decryption by username
* @returns {Promise<any>} Returns a Promise that resolves if the cipher was successfully deleted * @returns {Promise<any>} Returns a Promise that resolves if the cipher was successfully deleted
*/ */
@Cordova() @Cordova()
delete(options: {clientId: string; username: string; }): Promise<{deleted: boolean}> { return; } delete(options: { clientId: string; username: string; }): Promise<{ deleted: boolean }> { return; }
} }

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({
@ -28,7 +25,7 @@ import { Injectable } from '@angular/core';
plugin: 'https://github.com/appodeal/appodeal-cordova-plugin', plugin: 'https://github.com/appodeal/appodeal-cordova-plugin',
pluginRef: 'Appodeal', pluginRef: 'Appodeal',
repo: 'https://github.com/appodeal/appodeal-cordova-plugin.git', repo: 'https://github.com/appodeal/appodeal-cordova-plugin.git',
platforms: [ 'iOS', 'Android' ] platforms: ['iOS', 'Android']
}) })
@Injectable() @Injectable()
export class Appodeal extends IonicNativePlugin { export class Appodeal extends IonicNativePlugin {
@ -49,7 +46,7 @@ export class Appodeal extends IonicNativePlugin {
* @param {number} adType * @param {number} adType
*/ */
@Cordova() @Cordova()
initialize(appKey: string, adType: number): void {}; initialize(appKey: string, adType: number): void { };
/** /**
* check if SDK has been initialized * check if SDK has been initialized
@ -76,21 +73,21 @@ export class Appodeal extends IonicNativePlugin {
showWithPlacement( showWithPlacement(
adType: number, adType: number,
placement: any placement: any
): Promise<any> { return; }; ): Promise<any> { return; };
/** /**
* hide ad of specified type * hide ad of specified type
* @param {number} adType * @param {number} adType
*/ */
@Cordova() @Cordova()
hide(adType: number): void {}; hide(adType: number): void { };
/** /**
* confirm use of ads of specified type * confirm use of ads of specified type
* @param {number} adType * @param {number} adType
*/ */
@Cordova() @Cordova()
confirm(adType: number): void {}; confirm(adType: number): void { };
/** /**
* check if ad of specified type has been loaded * check if ad of specified type has been loaded
@ -114,69 +111,69 @@ export class Appodeal extends IonicNativePlugin {
* @param autoCache * @param autoCache
*/ */
@Cordova() @Cordova()
setAutoCache(adType: number, autoCache: any): void {}; setAutoCache(adType: number, autoCache: any): void { };
/** /**
* forcefully cache an ad by type * forcefully cache an ad by type
* @param {number} adType * @param {number} adType
*/ */
@Cordova() @Cordova()
cache(adType: number): void {}; cache(adType: number): void { };
/** /**
* *
* @param {boolean} set * @param {boolean} set
*/ */
@Cordova() @Cordova()
setOnLoadedTriggerBoth(set: boolean): void {}; setOnLoadedTriggerBoth(set: boolean): void { };
/** /**
* enable or disable Smart Banners * enable or disable Smart Banners
* @param {boolean} enabled * @param {boolean} enabled
*/ */
@Cordova() @Cordova()
setSmartBanners(enabled: boolean): void {}; setSmartBanners(enabled: boolean): void { };
/** /**
* enable or disable banner backgrounds * enable or disable banner backgrounds
* @param {boolean} enabled * @param {boolean} enabled
*/ */
@Cordova() @Cordova()
setBannerBackground(enabled: boolean): void {}; setBannerBackground(enabled: boolean): void { };
/** /**
* enable or disable banner animations * enable or disable banner animations
* @param {boolean} enabled * @param {boolean} enabled
*/ */
@Cordova() @Cordova()
setBannerAnimation(enabled: boolean): void {}; setBannerAnimation(enabled: boolean): void { };
/** /**
* *
* @param value * @param value
*/ */
@Cordova() @Cordova()
set728x90Banners(value: any): void {}; set728x90Banners(value: any): void { };
/** /**
* enable or disable logging * enable or disable logging
* @param {boolean} logging * @param {boolean} logging
*/ */
@Cordova() @Cordova()
setLogging(logging: boolean): void {}; setLogging(logging: boolean): void { };
/** /**
* enable or disable testing mode * enable or disable testing mode
* @param {boolean} testing * @param {boolean} testing
*/ */
@Cordova() @Cordova()
setTesting(testing: boolean): void {}; setTesting(testing: boolean): void { };
/** /**
* reset device ID * reset device ID
*/ */
@Cordova() @Cordova()
resetUUID(): void {}; resetUUID(): void { };
/** /**
* get version of Appdeal SDK * get version of Appdeal SDK
@ -190,7 +187,7 @@ export class Appodeal extends IonicNativePlugin {
* @param {number} adType * @param {number} adType
*/ */
@Cordova() @Cordova()
disableNetwork(network?: string, adType?: number): void {}; disableNetwork(network?: string, adType?: number): void { };
/** /**
* *
@ -198,54 +195,54 @@ export class Appodeal extends IonicNativePlugin {
* @param {number} adType * @param {number} adType
*/ */
@Cordova() @Cordova()
disableNetworkType(network?: string, adType?: number): void {}; disableNetworkType(network?: string, adType?: number): void { };
/** /**
* disable Location permissions for Appodeal SDK * disable Location permissions for Appodeal SDK
*/ */
@Cordova() @Cordova()
disableLocationPermissionCheck(): void {}; disableLocationPermissionCheck(): void { };
/** /**
* disable Storage permissions for Appodeal SDK * disable Storage permissions for Appodeal SDK
*/ */
@Cordova() @Cordova()
disableWriteExternalStoragePermissionCheck(): void {}; disableWriteExternalStoragePermissionCheck(): void { };
/** /**
* enable event listeners * enable event listeners
* @param {boolean} enabled * @param {boolean} enabled
*/ */
@Cordova() @Cordova()
enableInterstitialCallbacks(enabled: boolean): void {}; enableInterstitialCallbacks(enabled: boolean): void { };
/** /**
* enable event listeners * enable event listeners
* @param {boolean} enabled * @param {boolean} enabled
*/ */
@Cordova() @Cordova()
enableSkippableVideoCallbacks(enabled: boolean): void {}; enableSkippableVideoCallbacks(enabled: boolean): void { };
/** /**
* enable event listeners * enable event listeners
* @param {boolean} enabled * @param {boolean} enabled
*/ */
@Cordova() @Cordova()
enableNonSkippableVideoCallbacks(enabled: boolean): void {}; enableNonSkippableVideoCallbacks(enabled: boolean): void { };
/** /**
* enable event listeners * enable event listeners
* @param {boolean} enabled * @param {boolean} enabled
*/ */
@Cordova() @Cordova()
enableBannerCallbacks(enabled: boolean): void {}; enableBannerCallbacks(enabled: boolean): void { };
/** /**
* enable event listeners * enable event listeners
* @param {boolean} enabled * @param {boolean} enabled
*/ */
@Cordova() @Cordova()
enableRewardedVideoCallbacks(enabled: boolean): void {}; enableRewardedVideoCallbacks(enabled: boolean): void { };
/** /**
* *
@ -253,7 +250,7 @@ export class Appodeal extends IonicNativePlugin {
* @param {boolean} value * @param {boolean} value
*/ */
@Cordova() @Cordova()
setCustomBooleanRule(name: string, value: boolean): void {}; setCustomBooleanRule(name: string, value: boolean): void { };
/** /**
* *
@ -261,7 +258,7 @@ export class Appodeal extends IonicNativePlugin {
* @param {number} value * @param {number} value
*/ */
@Cordova() @Cordova()
setCustomIntegerRule(name: string, value: number): void {}; setCustomIntegerRule(name: string, value: number): void { };
/** /**
* set rule with float value * set rule with float value
@ -269,7 +266,7 @@ export class Appodeal extends IonicNativePlugin {
* @param {number} value * @param {number} value
*/ */
@Cordova() @Cordova()
setCustomDoubleRule(name: string, value: number): void {}; setCustomDoubleRule(name: string, value: number): void { };
/** /**
* set rule with string value * set rule with string value
@ -277,77 +274,77 @@ export class Appodeal extends IonicNativePlugin {
* @param {string} value * @param {string} value
*/ */
@Cordova() @Cordova()
setCustomStringRule(name: string, value: string): void {}; setCustomStringRule(name: string, value: string): void { };
/** /**
* set ID preference in Appodeal for current user * set ID preference in Appodeal for current user
* @param id * @param id
*/ */
@Cordova() @Cordova()
setUserId(id: any): void {}; setUserId(id: any): void { };
/** /**
* set Email preference in Appodeal for current user * set Email preference in Appodeal for current user
* @param email * @param email
*/ */
@Cordova() @Cordova()
setEmail(email: any): void {}; setEmail(email: any): void { };
/** /**
* set Birthday preference in Appodeal for current user * set Birthday preference in Appodeal for current user
* @param birthday * @param birthday
*/ */
@Cordova() @Cordova()
setBirthday(birthday: any): void {}; setBirthday(birthday: any): void { };
/** /**
* et Age preference in Appodeal for current user * et Age preference in Appodeal for current user
* @param age * @param age
*/ */
@Cordova() @Cordova()
setAge(age: any): void {}; setAge(age: any): void { };
/** /**
* set Gender preference in Appodeal for current user * set Gender preference in Appodeal for current user
* @param gender * @param gender
*/ */
@Cordova() @Cordova()
setGender(gender: any): void {}; setGender(gender: any): void { };
/** /**
* set Occupation preference in Appodeal for current user * set Occupation preference in Appodeal for current user
* @param occupation * @param occupation
*/ */
@Cordova() @Cordova()
setOccupation(occupation: any): void {}; setOccupation(occupation: any): void { };
/** /**
* set Relation preference in Appodeal for current user * set Relation preference in Appodeal for current user
* @param relation * @param relation
*/ */
@Cordova() @Cordova()
setRelation(relation: any): void {}; setRelation(relation: any): void { };
/** /**
* set Smoking preference in Appodeal for current user * set Smoking preference in Appodeal for current user
* @param smoking * @param smoking
*/ */
@Cordova() @Cordova()
setSmoking(smoking: any): void {}; setSmoking(smoking: any): void { };
/** /**
* set Alcohol preference in Appodeal for current user * set Alcohol preference in Appodeal for current user
* @param alcohol * @param alcohol
*/ */
@Cordova() @Cordova()
setAlcohol(alcohol: any): void {}; setAlcohol(alcohol: any): void { };
/** /**
* set Interests preference in Appodeal for current user * set Interests preference in Appodeal for current user
* @param interests * @param interests
*/ */
@Cordova() @Cordova()
setInterests(interests: any): void {}; setInterests(interests: any): void { };
@Cordova({ @Cordova({
eventObservable: true, eventObservable: true,

View File

@ -448,13 +448,13 @@ export class BackgroundGeolocation extends IonicNativePlugin {
/** /**
* Display app settings to change permissions * Display app settings to change permissions
*/ */
@Cordova({sync: true}) @Cordova({ sync: true })
showAppSettings(): void { } showAppSettings(): void { }
/** /**
* Display device location settings * Display device location settings
*/ */
@Cordova({sync: true}) @Cordova({ sync: true })
showLocationSettings(): void { } showLocationSettings(): void { }
/** /**

View File

@ -148,7 +148,7 @@ export class BackgroundMode extends IonicNativePlugin {
platforms: ['Android'], platforms: ['Android'],
sync: true sync: true
}) })
moveToBackground(): void {} moveToBackground(): void { }
/** /**
* Android allows to programmatically move from background to foreground. * Android allows to programmatically move from background to foreground.
@ -157,7 +157,7 @@ export class BackgroundMode extends IonicNativePlugin {
platforms: ['Android'], platforms: ['Android'],
sync: true sync: true
}) })
moveToForeground(): void {} moveToForeground(): void { }
/** /**
* Override the back button on Android to go to background instead of closing the app. * Override the back button on Android to go to background instead of closing the app.
@ -166,7 +166,7 @@ export class BackgroundMode extends IonicNativePlugin {
platforms: ['Android'], platforms: ['Android'],
sync: true sync: true
}) })
overrideBackButton(): void {} overrideBackButton(): void { }
/** /**
* Exclude the app from the recent task list works on Android 5.0+. * Exclude the app from the recent task list works on Android 5.0+.
@ -175,7 +175,7 @@ export class BackgroundMode extends IonicNativePlugin {
platforms: ['Android'], platforms: ['Android'],
sync: true sync: true
}) })
excludeFromTaskList(): void {} excludeFromTaskList(): void { }
/** /**
* The method works async instead of isActive() or isEnabled(). * The method works async instead of isActive() or isEnabled().
@ -192,7 +192,7 @@ export class BackgroundMode extends IonicNativePlugin {
platforms: ['Android'], platforms: ['Android'],
sync: true sync: true
}) })
wakeUp(): void {} wakeUp(): void { }
/** /**
* Turn screen on and show app even locked * Turn screen on and show app even locked
@ -201,6 +201,6 @@ export class BackgroundMode extends IonicNativePlugin {
platforms: ['Android'], platforms: ['Android'],
sync: true sync: true
}) })
unlock(): void {} unlock(): void { }
} }

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

@ -40,7 +40,7 @@ export class Base64ToGallery extends IonicNativePlugin {
successIndex: 2, successIndex: 2,
errorIndex: 3 errorIndex: 3
}) })
base64ToGallery(data: string, options?: {prefix?: string; mediaScanner?: boolean}): Promise<any> { base64ToGallery(data: string, options?: { prefix?: string; mediaScanner?: boolean }): Promise<any> {
return; return;
} }

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
* } * }
* ``` * ```
* *
@ -230,7 +230,7 @@ export class BLE extends IonicNativePlugin {
clearFunction: 'stopScan', clearFunction: 'stopScan',
clearWithArgs: false clearWithArgs: false
}) })
startScanWithOptions(services: string[], options: {reportDuplicates?: boolean} | any): Observable<any> { return; } startScanWithOptions(services: string[], options: { reportDuplicates?: boolean } | any): Observable<any> { return; }
/** /**
* Stop a scan started by `startScan`. * Stop a scan started by `startScan`.
@ -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

@ -39,12 +39,12 @@ export interface CameraPreviewOptions {
} }
export interface CameraPreviewPictureOptions { export interface CameraPreviewPictureOptions {
/** The width in pixels, default 0 */ /** The width in pixels, default 0 */
width?: number; width?: number;
/** The height in pixels, default 0 */ /** The height in pixels, default 0 */
height?: number; height?: number;
/** The picture quality, 0 - 100, default 85 */ /** The picture quality, 0 - 100, default 85 */
quality?: number; quality?: number;
} }
/** /**
@ -251,10 +251,10 @@ export class CameraPreview extends IonicNativePlugin {
}) })
setZoom(zoom?: number): Promise<any> { return; } setZoom(zoom?: number): Promise<any> { return; }
/** /**
* Get the maximum zoom (Android) * Get the maximum zoom (Android)
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova() @Cordova()
getMaxZoom(): Promise<any> { return; } getMaxZoom(): Promise<any> { return; }

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

@ -145,16 +145,16 @@ export interface IContactName {
*/ */
export class ContactName implements IContactName { export class ContactName implements IContactName {
constructor(public formatted?: string, constructor(public formatted?: string,
public familyName?: string, public familyName?: string,
public givenName?: string, public givenName?: string,
public middleName?: string, public middleName?: string,
public honorificPrefix?: string, public honorificPrefix?: string,
public honorificSuffix?: string) {} public honorificSuffix?: string) { }
} }
export interface IContactField { export interface IContactField {
/** A string that indicates what type of field this is, home for example. */ /** A string that indicates what type of field this is, home for example. */
type?: string; type?: string;
/** The value of the field, such as a phone number or email address. */ /** The value of the field, such as a phone number or email address. */
value?: string; value?: string;
/** Set to true if this ContactField contains the user's preferred value. */ /** Set to true if this ContactField contains the user's preferred value. */
@ -166,15 +166,15 @@ export interface IContactField {
*/ */
export class ContactField implements IContactField { export class ContactField implements IContactField {
constructor(public type?: string, constructor(public type?: string,
public value?: string, public value?: string,
public pref?: boolean) {} public pref?: boolean) { }
} }
export interface IContactAddress { export interface IContactAddress {
/** Set to true if this ContactAddress contains the user's preferred value. */ /** Set to true if this ContactAddress contains the user's preferred value. */
pref?: boolean; pref?: boolean;
/** A string indicating what type of field this is, home for example. */ /** A string indicating what type of field this is, home for example. */
type?: string; type?: string;
/** The full address formatted for display. */ /** The full address formatted for display. */
formatted?: string; formatted?: string;
/** The full street address. */ /** The full street address. */
@ -194,20 +194,20 @@ export interface IContactAddress {
*/ */
export class ContactAddress implements IContactAddress { export class ContactAddress implements IContactAddress {
constructor(public pref?: boolean, constructor(public pref?: boolean,
public type?: string, public type?: string,
public formatted?: string, public formatted?: string,
public streetAddress?: string, public streetAddress?: string,
public locality?: string, public locality?: string,
public region?: string, public region?: string,
public postalCode?: string, public postalCode?: string,
public country?: string) {} public country?: string) { }
} }
export interface IContactOrganization { export interface IContactOrganization {
/** Set to true if this ContactOrganization contains the user's preferred value. */ /** Set to true if this ContactOrganization contains the user's preferred value. */
pref?: boolean; pref?: boolean;
/** A string that indicates what type of field this is, home for example. */ /** A string that indicates what type of field this is, home for example. */
type?: string; type?: string;
/** The name of the organization. */ /** The name of the organization. */
name?: string; name?: string;
/** The department the contract works for. */ /** The department the contract works for. */
@ -226,7 +226,7 @@ export class ContactOrganization implements IContactOrganization {
public department?: string, public department?: string,
public title?: string, public title?: string,
public pref?: boolean public pref?: boolean
) {} ) { }
} }
/** Search options to filter navigator.contacts. */ /** Search options to filter navigator.contacts. */
@ -248,9 +248,9 @@ export interface IContactFindOptions {
*/ */
export class ContactFindOptions implements IContactFindOptions { export class ContactFindOptions implements IContactFindOptions {
constructor(public filter?: string, constructor(public filter?: string,
public multiple?: boolean, public multiple?: boolean,
public desiredFields?: string[], public desiredFields?: string[],
public hasPhoneNumber?: boolean) {} public hasPhoneNumber?: boolean) { }
} }
/** /**

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) {
@ -38,6 +38,6 @@ export class CouchbaseLite extends IonicNativePlugin {
@Cordova({ @Cordova({
callbackStyle: 'node' callbackStyle: 'node'
}) })
getURL(): Promise<any> { return; } getURL(): Promise<any> { return; }
} }

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)
* ); * );
* ``` * ```
*/ */
@ -38,6 +38,6 @@ export class Crop extends IonicNativePlugin {
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'
}) })
crop(pathToImage: string, options?: {quality: number}): Promise<string> { return; } crop(pathToImage: string, options?: { quality: number }): Promise<string> { return; }
} }

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) { }
@ -41,7 +41,7 @@ export class FileOpener extends IonicNativePlugin {
successName: 'success', successName: 'success',
errorName: 'error' errorName: 'error'
}) })
open(filePath: string, fileMIMEType: string): Promise<any> {return; } open(filePath: string, fileMIMEType: string): Promise<any> { return; }
/** /**
* Uninstalls a package * Uninstalls a package
@ -53,7 +53,7 @@ export class FileOpener extends IonicNativePlugin {
successName: 'success', successName: 'success',
errorName: 'error' errorName: 'error'
}) })
uninstall(packageId: string): Promise<any> {return; } uninstall(packageId: string): Promise<any> { return; }
/** /**
* Check if an app is already installed * Check if an app is already installed
@ -65,6 +65,6 @@ export class FileOpener extends IonicNativePlugin {
successName: 'success', successName: 'success',
errorName: 'error' errorName: 'error'
}) })
appIsInstalled(packageId: string): Promise<any> {return; } appIsInstalled(packageId: string): Promise<any> { return; }
} }

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) { }
@ -39,6 +39,6 @@ export class FilePath extends IonicNativePlugin {
* @returns {Promise<string>} * @returns {Promise<string>}
*/ */
@Cordova() @Cordova()
resolveNativePath(path: string): Promise<string> {return; } resolveNativePath(path: string): Promise<string> { return; }
} }

View File

@ -34,7 +34,7 @@ export interface Entry {
* @param errorCallback A callback that is called when errors happen. * @param errorCallback A callback that is called when errors happen.
*/ */
getMetadata(successCallback: (metadata: Metadata) => void, getMetadata(successCallback: (metadata: Metadata) => void,
errorCallback?: (error: FileError) => void): void; errorCallback?: (error: FileError) => void): void;
/** /**
* Move an entry to a different location on the file system. It is an error to try to: * Move an entry to a different location on the file system. It is an error to try to:
* move a directory inside itself or to any child at any depth;move an entry into its parent if a name different from its current one isn't provided; * move a directory inside itself or to any child at any depth;move an entry into its parent if a name different from its current one isn't provided;
@ -49,9 +49,9 @@ export interface Entry {
* @param errorCallback A callback that is called when errors happen. * @param errorCallback A callback that is called when errors happen.
*/ */
moveTo(parent: DirectoryEntry, moveTo(parent: DirectoryEntry,
newName?: string, newName?: string,
successCallback?: (entry: Entry) => void, successCallback?: (entry: Entry) => void,
errorCallback?: (error: FileError) => void): void; errorCallback?: (error: FileError) => void): void;
/** /**
* Copy an entry to a different location on the file system. It is an error to try to: * Copy an entry to a different location on the file system. It is an error to try to:
* copy a directory inside itself or to any child at any depth; * copy a directory inside itself or to any child at any depth;
@ -68,9 +68,9 @@ export interface Entry {
* @param errorCallback A callback that is called when errors happen. * @param errorCallback A callback that is called when errors happen.
*/ */
copyTo(parent: DirectoryEntry, copyTo(parent: DirectoryEntry,
newName?: string, newName?: string,
successCallback?: (entry: Entry) => void, successCallback?: (entry: Entry) => void,
errorCallback?: (error: FileError) => void): void; errorCallback?: (error: FileError) => void): void;
/** /**
* Returns a URL that can be used as the src attribute of a <video> or <audio> tag. * Returns a URL that can be used as the src attribute of a <video> or <audio> tag.
* If that is not possible, construct a cdvfile:// URL. * If that is not possible, construct a cdvfile:// URL.
@ -88,14 +88,14 @@ export interface Entry {
* @param errorCallback A callback that is called when errors happen. * @param errorCallback A callback that is called when errors happen.
*/ */
remove(successCallback: () => void, remove(successCallback: () => void,
errorCallback?: (error: FileError) => void): void; errorCallback?: (error: FileError) => void): void;
/** /**
* Look up the parent DirectoryEntry containing this Entry. If this Entry is the root of its filesystem, its parent is itself. * Look up the parent DirectoryEntry containing this Entry. If this Entry is the root of its filesystem, its parent is itself.
* @param successCallback A callback that is called with the time of the last modification. * @param successCallback A callback that is called with the time of the last modification.
* @param errorCallback A callback that is called when errors happen. * @param errorCallback A callback that is called when errors happen.
*/ */
getParent(successCallback: (entry: Entry) => void, getParent(successCallback: (entry: Entry) => void,
errorCallback?: (error: FileError) => void): void; errorCallback?: (error: FileError) => void): void;
} }
/** This interface supplies information about the state of a file or directory. */ /** This interface supplies information about the state of a file or directory. */
@ -126,8 +126,8 @@ export interface DirectoryEntry extends Entry {
* @param errorCallback A callback that is called when errors happen. * @param errorCallback A callback that is called when errors happen.
*/ */
getFile(path: string, options?: Flags, getFile(path: string, options?: Flags,
successCallback?: (entry: FileEntry) => void, successCallback?: (entry: FileEntry) => void,
errorCallback?: (error: FileError) => void): void; errorCallback?: (error: FileError) => void): void;
/** /**
* Creates or looks up a directory. * Creates or looks up a directory.
* @param path Either an absolute path or a relative path from this DirectoryEntry * @param path Either an absolute path or a relative path from this DirectoryEntry
@ -142,8 +142,8 @@ export interface DirectoryEntry extends Entry {
* @param errorCallback A callback that is called when errors happen. * @param errorCallback A callback that is called when errors happen.
*/ */
getDirectory(path: string, options?: Flags, getDirectory(path: string, options?: Flags,
successCallback?: (entry: DirectoryEntry) => void, successCallback?: (entry: DirectoryEntry) => void,
errorCallback?: (error: FileError) => void): void; errorCallback?: (error: FileError) => void): void;
/** /**
* Deletes a directory and all of its contents, if any. In the event of an error (e.g. trying * Deletes a directory and all of its contents, if any. In the event of an error (e.g. trying
* to delete a directory that contains a file that cannot be removed), some of the contents * to delete a directory that contains a file that cannot be removed), some of the contents
@ -152,7 +152,7 @@ export interface DirectoryEntry extends Entry {
* @param errorCallback A callback that is called when errors happen. * @param errorCallback A callback that is called when errors happen.
*/ */
removeRecursively(successCallback: () => void, removeRecursively(successCallback: () => void,
errorCallback?: (error: FileError) => void): void; errorCallback?: (error: FileError) => void): void;
} }
export interface RemoveResult { export interface RemoveResult {
@ -196,7 +196,7 @@ export interface DirectoryReader {
* @param errorCallback A callback indicating that there was an error reading from the Directory. * @param errorCallback A callback indicating that there was an error reading from the Directory.
*/ */
readEntries(successCallback: (entries: Entry[]) => void, readEntries(successCallback: (entries: Entry[]) => void,
errorCallback?: (error: FileError) => void): void; errorCallback?: (error: FileError) => void): void;
} }
/** This interface represents a file on a file system. */ /** This interface represents a file on a file system. */
@ -207,14 +207,14 @@ export interface FileEntry extends Entry {
* @param errorCallback A callback that is called when errors happen. * @param errorCallback A callback that is called when errors happen.
*/ */
createWriter(successCallback: (writer: FileWriter) => void, createWriter(successCallback: (writer: FileWriter) => void,
errorCallback?: (error: FileError) => void): void; errorCallback?: (error: FileError) => void): void;
/** /**
* Returns a File that represents the current state of the file that this FileEntry represents. * Returns a File that represents the current state of the file that this FileEntry represents.
* @param successCallback A callback that is called with the File. * @param successCallback A callback that is called with the File.
* @param errorCallback A callback that is called when errors happen. * @param errorCallback A callback that is called when errors happen.
*/ */
file(successCallback: (file: File) => void, file(successCallback: (file: File) => void,
errorCallback?: (error: FileError) => void): void; errorCallback?: (error: FileError) => void): void;
} }
/** /**
@ -313,7 +313,7 @@ export declare var FileReader: {
LOADING: number; LOADING: number;
DONE: number; DONE: number;
new(): FileReader; new (): FileReader;
}; };
export interface FileError { export interface FileError {
@ -545,7 +545,7 @@ export class File extends IonicNativePlugin {
return this.resolveDirectoryUrl(path) return this.resolveDirectoryUrl(path)
.then((fse) => { .then((fse) => {
return this.getDirectory(fse, dirName, {create: false}); return this.getDirectory(fse, dirName, { create: false });
}) })
.then((de) => { .then((de) => {
return this.remove(de); return this.remove(de);
@ -562,7 +562,7 @@ export class File extends IonicNativePlugin {
* @returns {Promise<DirectoryEntry|Entry>} Returns a Promise that resolves to the new DirectoryEntry object or rejects with an error. * @returns {Promise<DirectoryEntry|Entry>} Returns a Promise that resolves to the new DirectoryEntry object or rejects with an error.
*/ */
@CordovaCheck() @CordovaCheck()
moveDir(path: string, dirName: string, newPath: string, newDirName: string): Promise<DirectoryEntry|Entry> { moveDir(path: string, dirName: string, newPath: string, newDirName: string): Promise<DirectoryEntry | Entry> {
newDirName = newDirName || dirName; newDirName = newDirName || dirName;
if ((/^\//.test(newDirName))) { if ((/^\//.test(newDirName))) {
@ -573,7 +573,7 @@ export class File extends IonicNativePlugin {
return this.resolveDirectoryUrl(path) return this.resolveDirectoryUrl(path)
.then((fse) => { .then((fse) => {
return this.getDirectory(fse, dirName, {create: false}); return this.getDirectory(fse, dirName, { create: false });
}) })
.then((srcde) => { .then((srcde) => {
return this.resolveDirectoryUrl(newPath) return this.resolveDirectoryUrl(newPath)
@ -602,7 +602,7 @@ export class File extends IonicNativePlugin {
return this.resolveDirectoryUrl(path) return this.resolveDirectoryUrl(path)
.then((fse) => { .then((fse) => {
return this.getDirectory(fse, dirName, {create: false}); return this.getDirectory(fse, dirName, { create: false });
}) })
.then((srcde) => { .then((srcde) => {
return this.resolveDirectoryUrl(newPath) return this.resolveDirectoryUrl(newPath)
@ -629,7 +629,7 @@ export class File extends IonicNativePlugin {
return this.resolveDirectoryUrl(path) return this.resolveDirectoryUrl(path)
.then((fse) => { .then((fse) => {
return this.getDirectory(fse, dirName, {create: false, exclusive: false}); return this.getDirectory(fse, dirName, { create: false, exclusive: false });
}) })
.then((de) => { .then((de) => {
let reader = de.createReader(); let reader = de.createReader();
@ -654,7 +654,7 @@ export class File extends IonicNativePlugin {
return this.resolveDirectoryUrl(path) return this.resolveDirectoryUrl(path)
.then((fse) => { .then((fse) => {
return this.getDirectory(fse, dirName, {create: false}); return this.getDirectory(fse, dirName, { create: false });
}) })
.then((de) => { .then((de) => {
return this.rimraf(de); return this.rimraf(de);
@ -737,7 +737,7 @@ export class File extends IonicNativePlugin {
return this.resolveDirectoryUrl(path) return this.resolveDirectoryUrl(path)
.then((fse) => { .then((fse) => {
return this.getFile(fse, fileName, {create: false}); return this.getFile(fse, fileName, { create: false });
}) })
.then((fe) => { .then((fe) => {
return this.remove(fe); return this.remove(fe);
@ -754,7 +754,7 @@ export class File extends IonicNativePlugin {
*/ */
@CordovaCheck() @CordovaCheck()
writeFile(path: string, fileName: string, writeFile(path: string, fileName: string,
text: string | Blob | ArrayBuffer, options: WriteOptions = {}): Promise<any> { text: string | Blob | ArrayBuffer, options: WriteOptions = {}): Promise<any> {
if ((/^\//.test(fileName))) { if ((/^\//.test(fileName))) {
const err = new FileError(5); const err = new FileError(5);
err.message = 'file-name cannot start with \/'; err.message = 'file-name cannot start with \/';
@ -829,7 +829,7 @@ export class File extends IonicNativePlugin {
return this.resolveDirectoryUrl(path) return this.resolveDirectoryUrl(path)
.then((directoryEntry: DirectoryEntry) => { .then((directoryEntry: DirectoryEntry) => {
return this.getFile(directoryEntry, file, {create: false}); return this.getFile(directoryEntry, file, { create: false });
}) })
.then((fileEntry: FileEntry) => { .then((fileEntry: FileEntry) => {
let reader = new FileReader(); let reader = new FileReader();
@ -840,7 +840,7 @@ export class File extends IonicNativePlugin {
} else if (reader.error !== undefined || reader.error !== null) { } else if (reader.error !== undefined || reader.error !== null) {
reject(reader.error); reject(reader.error);
} else { } else {
reject({code: null, message: 'READER_ONLOADEND_ERR'}); reject({ code: null, message: 'READER_ONLOADEND_ERR' });
} }
}; };
fileEntry.file(file => { fileEntry.file(file => {
@ -871,7 +871,7 @@ export class File extends IonicNativePlugin {
return this.resolveDirectoryUrl(path) return this.resolveDirectoryUrl(path)
.then((directoryEntry: DirectoryEntry) => { .then((directoryEntry: DirectoryEntry) => {
return this.getFile(directoryEntry, file, {create: false}); return this.getFile(directoryEntry, file, { create: false });
}) })
.then((fileEntry: FileEntry) => { .then((fileEntry: FileEntry) => {
let reader = new FileReader(); let reader = new FileReader();
@ -882,7 +882,7 @@ export class File extends IonicNativePlugin {
} else if (reader.error !== undefined || reader.error !== null) { } else if (reader.error !== undefined || reader.error !== null) {
reject(reader.error); reject(reader.error);
} else { } else {
reject({code: null, message: 'READER_ONLOADEND_ERR'}); reject({ code: null, message: 'READER_ONLOADEND_ERR' });
} }
}; };
@ -914,7 +914,7 @@ export class File extends IonicNativePlugin {
return this.resolveDirectoryUrl(path) return this.resolveDirectoryUrl(path)
.then((directoryEntry: DirectoryEntry) => { .then((directoryEntry: DirectoryEntry) => {
return this.getFile(directoryEntry, file, {create: false}); return this.getFile(directoryEntry, file, { create: false });
}) })
.then((fileEntry: FileEntry) => { .then((fileEntry: FileEntry) => {
let reader = new FileReader(); let reader = new FileReader();
@ -925,7 +925,7 @@ export class File extends IonicNativePlugin {
} else if (reader.error !== undefined || reader.error !== null) { } else if (reader.error !== undefined || reader.error !== null) {
reject(reader.error); reject(reader.error);
} else { } else {
reject({code: null, message: 'READER_ONLOADEND_ERR'}); reject({ code: null, message: 'READER_ONLOADEND_ERR' });
} }
}; };
@ -955,7 +955,7 @@ export class File extends IonicNativePlugin {
return this.resolveDirectoryUrl(path) return this.resolveDirectoryUrl(path)
.then((directoryEntry: DirectoryEntry) => { .then((directoryEntry: DirectoryEntry) => {
return this.getFile(directoryEntry, file, {create: false}); return this.getFile(directoryEntry, file, { create: false });
}) })
.then((fileEntry: FileEntry) => { .then((fileEntry: FileEntry) => {
let reader = new FileReader(); let reader = new FileReader();
@ -966,7 +966,7 @@ export class File extends IonicNativePlugin {
} else if (reader.error !== undefined || reader.error !== null) { } else if (reader.error !== undefined || reader.error !== null) {
reject(reader.error); reject(reader.error);
} else { } else {
reject({code: null, message: 'READER_ONLOADEND_ERR'}); reject({ code: null, message: 'READER_ONLOADEND_ERR' });
} }
}; };
@ -1001,7 +1001,7 @@ export class File extends IonicNativePlugin {
return this.resolveDirectoryUrl(path) return this.resolveDirectoryUrl(path)
.then((fse) => { .then((fse) => {
return this.getFile(fse, fileName, {create: false}); return this.getFile(fse, fileName, { create: false });
}) })
.then((srcfe) => { .then((srcfe) => {
return this.resolveDirectoryUrl(newPath) return this.resolveDirectoryUrl(newPath)
@ -1032,7 +1032,7 @@ export class File extends IonicNativePlugin {
return this.resolveDirectoryUrl(path) return this.resolveDirectoryUrl(path)
.then((fse) => { .then((fse) => {
return this.getFile(fse, fileName, {create: false}); return this.getFile(fse, fileName, { create: false });
}) })
.then((srcfe) => { .then((srcfe) => {
return this.resolveDirectoryUrl(newPath) return this.resolveDirectoryUrl(newPath)
@ -1048,7 +1048,7 @@ export class File extends IonicNativePlugin {
private fillErrorMessage(err: FileError): void { private fillErrorMessage(err: FileError): void {
try { try {
err.message = this.cordovaFileError[err.code]; err.message = this.cordovaFileError[err.code];
} catch (e) {} } catch (e) { }
} }
/** /**
@ -1144,7 +1144,7 @@ export class File extends IonicNativePlugin {
private remove(fe: Entry): Promise<RemoveResult> { private remove(fe: Entry): Promise<RemoveResult> {
return new Promise<RemoveResult>((resolve, reject) => { return new Promise<RemoveResult>((resolve, reject) => {
fe.remove(() => { fe.remove(() => {
resolve({success: true, fileRemoved: fe}); resolve({ success: true, fileRemoved: fe });
}, (err) => { }, (err) => {
this.fillErrorMessage(err); this.fillErrorMessage(err);
reject(err); reject(err);
@ -1200,7 +1200,7 @@ export class File extends IonicNativePlugin {
private rimraf(de: DirectoryEntry): Promise<RemoveResult> { private rimraf(de: DirectoryEntry): Promise<RemoveResult> {
return new Promise<RemoveResult>((resolve, reject) => { return new Promise<RemoveResult>((resolve, reject) => {
de.removeRecursively(() => { de.removeRecursively(() => {
resolve({success: true, fileRemoved: de}); resolve({ success: true, fileRemoved: de });
}, (err) => { }, (err) => {
this.fillErrorMessage(err); this.fillErrorMessage(err);
reject(err); reject(err);

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) { }
@ -68,10 +68,10 @@ export class Firebase extends IonicNativePlugin {
}) })
grantPermission(): Promise<any> { return; } grantPermission(): Promise<any> { return; }
/** /**
* Check permission to receive push notifications * Check permission to receive push notifications
* @return {Promise<any>} * @return {Promise<any>}
*/ */
@Cordova({ @Cordova({
platforms: ['iOS'] platforms: ['iOS']
}) })

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
* } * }
* } * }
@ -148,7 +148,7 @@ export class Geofence extends IonicNativePlugin {
return new Observable<any>((observer) => { return new Observable<any>((observer) => {
window && window.geofence && (window.geofence.onTransitionReceived = observer.next.bind(observer)); window && window.geofence && (window.geofence.onTransitionReceived = observer.next.bind(observer));
return () => window.geofence.onTransitionReceived = () => {}; return () => window.geofence.onTransitionReceived = () => { };
}); });
} }
@ -162,7 +162,7 @@ export class Geofence extends IonicNativePlugin {
return new Observable<any>((observer) => { return new Observable<any>((observer) => {
window && window.geofence && (window.geofence.onNotificationClicked = observer.next.bind(observer)); window && window.geofence && (window.geofence.onNotificationClicked = observer.next.bind(observer));
return () => window.geofence.onNotificationClicked = () => {}; return () => window.geofence.onNotificationClicked = () => { };
}); });
} }

View File

@ -74,7 +74,7 @@ export interface PositionError {
/** /**
* A message that can describe the error that occurred * A message that can describe the error that occurred
*/ */
message: string; message: string;
} }

View File

@ -42,12 +42,12 @@ export const GoogleMapsAnimation = {
* @hidden * @hidden
*/ */
export const GoogleMapsMapTypeId = { export const GoogleMapsMapTypeId = {
HYBRID: 'MAP_TYPE_HYBRID', HYBRID: 'MAP_TYPE_HYBRID',
NONE: 'MAP_TYPE_NONE', NONE: 'MAP_TYPE_NONE',
NORMAL: 'MAP_TYPE_NORMAL', NORMAL: 'MAP_TYPE_NORMAL',
ROADMAP: 'MAP_TYPE_ROADMAP', ROADMAP: 'MAP_TYPE_ROADMAP',
SATELLITE: 'MAP_TYPE_SATELLITE', SATELLITE: 'MAP_TYPE_SATELLITE',
TERAIN: 'MAP_TYPE_TERRAIN' TERAIN: 'MAP_TYPE_TERRAIN'
}; };
/** /**
@ -214,13 +214,13 @@ export class GoogleMap {
@InstanceCheck() @InstanceCheck()
addMarker(options: MarkerOptions): Promise<Marker | any> { addMarker(options: MarkerOptions): Promise<Marker | any> {
return new Promise<Marker>((resolve, reject) => { return new Promise<Marker>((resolve, reject) => {
this._objectInstance.addMarker(options, (marker: any) => { this._objectInstance.addMarker(options, (marker: any) => {
if (marker) { if (marker) {
resolve(new Marker(marker)); resolve(new Marker(marker));
} else { } else {
reject(); reject();
} }
}); });
}); });
} }
@ -230,13 +230,13 @@ export class GoogleMap {
@InstanceCheck() @InstanceCheck()
addCircle(options: CircleOptions): Promise<Circle | any> { addCircle(options: CircleOptions): Promise<Circle | any> {
return new Promise<Circle>((resolve, reject) => { return new Promise<Circle>((resolve, reject) => {
this._objectInstance.addCircle(options, (circle: any) => { this._objectInstance.addCircle(options, (circle: any) => {
if (circle) { if (circle) {
resolve(new Circle(circle)); resolve(new Circle(circle));
} else { } else {
reject(); reject();
} }
}); });
}); });
} }
@ -246,13 +246,13 @@ export class GoogleMap {
@InstanceCheck() @InstanceCheck()
addPolygon(options: PolygonOptions): Promise<Polygon | any> { addPolygon(options: PolygonOptions): Promise<Polygon | any> {
return new Promise<Polygon>((resolve, reject) => { return new Promise<Polygon>((resolve, reject) => {
this._objectInstance.addPolygon(options, (polygon: any) => { this._objectInstance.addPolygon(options, (polygon: any) => {
if (polygon) { if (polygon) {
resolve(new Polygon(polygon)); resolve(new Polygon(polygon));
} else { } else {
reject(); reject();
} }
}); });
}); });
} }
@ -262,13 +262,13 @@ export class GoogleMap {
@InstanceCheck() @InstanceCheck()
addPolyline(options: PolylineOptions): Promise<Polyline | any> { addPolyline(options: PolylineOptions): Promise<Polyline | any> {
return new Promise<Polyline>((resolve, reject) => { return new Promise<Polyline>((resolve, reject) => {
this._objectInstance.addPolyline(options, (polyline: any) => { this._objectInstance.addPolyline(options, (polyline: any) => {
if (polyline) { if (polyline) {
resolve(new Polyline(polyline)); resolve(new Polyline(polyline));
} else { } else {
reject(); reject();
} }
}); });
}); });
} }
@ -278,13 +278,13 @@ export class GoogleMap {
@InstanceCheck() @InstanceCheck()
addTileOverlay(options: TileOverlayOptions): Promise<TileOverlay | any> { addTileOverlay(options: TileOverlayOptions): Promise<TileOverlay | any> {
return new Promise<TileOverlay>((resolve, reject) => { return new Promise<TileOverlay>((resolve, reject) => {
this._objectInstance.addTileOverlay(options, (tileOverlay: any) => { this._objectInstance.addTileOverlay(options, (tileOverlay: any) => {
if (tileOverlay) { if (tileOverlay) {
resolve(new TileOverlay(tileOverlay)); resolve(new TileOverlay(tileOverlay));
} else { } else {
reject(); reject();
} }
}); });
}); });
} }
@ -294,13 +294,13 @@ export class GoogleMap {
@InstanceCheck() @InstanceCheck()
addGroundOverlay(options: GroundOverlayOptions): Promise<GroundOverlay | any> { addGroundOverlay(options: GroundOverlayOptions): Promise<GroundOverlay | any> {
return new Promise<GroundOverlay>((resolve, reject) => { return new Promise<GroundOverlay>((resolve, reject) => {
this._objectInstance.addGroundOverlay(options, (groundOverlay: any) => { this._objectInstance.addGroundOverlay(options, (groundOverlay: any) => {
if (groundOverlay) { if (groundOverlay) {
resolve(new GroundOverlay(groundOverlay)); resolve(new GroundOverlay(groundOverlay));
} else { } else {
reject(); reject();
} }
}); });
}); });
} }
@ -310,13 +310,13 @@ export class GoogleMap {
@InstanceCheck() @InstanceCheck()
addKmlOverlay(options: KmlOverlayOptions): Promise<KmlOverlay | any> { addKmlOverlay(options: KmlOverlayOptions): Promise<KmlOverlay | any> {
return new Promise<KmlOverlay>((resolve, reject) => { return new Promise<KmlOverlay>((resolve, reject) => {
this._objectInstance.addKmlOverlay(options, (kmlOverlay: any) => { this._objectInstance.addKmlOverlay(options, (kmlOverlay: any) => {
if (kmlOverlay) { if (kmlOverlay) {
resolve(new KmlOverlay(kmlOverlay)); resolve(new KmlOverlay(kmlOverlay));
} else { } else {
reject(); reject();
} }
}); });
}); });
} }
@ -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';
* *
* *
@ -89,7 +89,7 @@ export class Gyroscope extends IonicNativePlugin {
* @return {Observable<GyroscopeOrientation>} Returns an Observable that resolves GyroscopeOrientation * @return {Observable<GyroscopeOrientation>} Returns an Observable that resolves GyroscopeOrientation
*/ */
watch(options?: GyroscopeOptions): Observable<GyroscopeOrientation> { watch(options?: GyroscopeOptions): Observable<GyroscopeOrientation> {
return new Observable<GyroscopeOrientation> ( return new Observable<GyroscopeOrientation>(
(observer: any) => { (observer: any) => {
let watchId = navigator.gyroscope.watch(observer.next.bind(observer), observer.next.bind(observer), options); let watchId = navigator.gyroscope.watch(observer.next.bind(observer), observer.next.bind(observer), options);
return () => navigator.gyroscope.clearWatch(watchId); return () => navigator.gyroscope.clearWatch(watchId);

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

@ -434,7 +434,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<void>} Returns a promise which is resolved as soon as the * @returns {Promise<void>} Returns a promise which is resolved as soon as the
* native layer acknowledged the request and started to send events. * native layer acknowledged the request and started to send events.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
onDomDelegateReady(): Promise<void> { return; } onDomDelegateReady(): Promise<void> { return; }
/** /**
@ -442,7 +442,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<boolean>} Returns a promise which is resolved with a {Boolean} * @returns {Promise<boolean>} Returns a promise which is resolved with a {Boolean}
* indicating whether bluetooth is active. * indicating whether bluetooth is active.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
isBluetoothEnabled(): Promise<boolean> { return; } isBluetoothEnabled(): Promise<boolean> { return; }
/** /**
@ -451,7 +451,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<void>} Returns a promise which is resolved when Bluetooth * @returns {Promise<void>} Returns a promise which is resolved when Bluetooth
* could be enabled. If not, the promise will be rejected with an error. * could be enabled. If not, the promise will be rejected with an error.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
enableBluetooth(): Promise<void> { return; } enableBluetooth(): Promise<void> { return; }
/** /**
@ -460,7 +460,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<void>} Returns a promise which is resolved when Bluetooth * @returns {Promise<void>} Returns a promise which is resolved when Bluetooth
* could be enabled. If not, the promise will be rejected with an error. * could be enabled. If not, the promise will be rejected with an error.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
disableBluetooth(): Promise<void> { return; } disableBluetooth(): Promise<void> { return; }
/** /**
@ -480,7 +480,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<string>} Returns a promise which is resolved as soon as the * @returns {Promise<string>} Returns a promise which is resolved as soon as the
* native layer acknowledged the dispatch of the monitoring request. * native layer acknowledged the dispatch of the monitoring request.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
startMonitoringForRegion(region: BeaconRegion): Promise<string> { return; } startMonitoringForRegion(region: BeaconRegion): Promise<string> { return; }
/** /**
@ -497,7 +497,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<void>} Returns a promise which is resolved as soon as the * @returns {Promise<void>} Returns a promise which is resolved as soon as the
* native layer acknowledged the dispatch of the request to stop monitoring. * native layer acknowledged the dispatch of the request to stop monitoring.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
stopMonitoringForRegion(region: BeaconRegion): Promise<void> { return; } stopMonitoringForRegion(region: BeaconRegion): Promise<void> { return; }
/** /**
@ -513,7 +513,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<void>} Returns a promise which is resolved as soon as the * @returns {Promise<void>} Returns a promise which is resolved as soon as the
* native layer acknowledged the dispatch of the request to stop monitoring. * native layer acknowledged the dispatch of the request to stop monitoring.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
requestStateForRegion(region: Region): Promise<void> { return; } requestStateForRegion(region: Region): Promise<void> { return; }
@ -531,7 +531,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<void>} Returns a promise which is resolved as soon as the * @returns {Promise<void>} Returns a promise which is resolved as soon as the
* native layer acknowledged the dispatch of the monitoring request. * native layer acknowledged the dispatch of the monitoring request.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
startRangingBeaconsInRegion(region: BeaconRegion): Promise<void> { return; } startRangingBeaconsInRegion(region: BeaconRegion): Promise<void> { return; }
/** /**
@ -548,7 +548,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<void>} Returns a promise which is resolved as soon as the * @returns {Promise<void>} Returns a promise which is resolved as soon as the
* native layer acknowledged the dispatch of the request to stop monitoring. * native layer acknowledged the dispatch of the request to stop monitoring.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
stopRangingBeaconsInRegion(region: BeaconRegion): Promise<void> { return; } stopRangingBeaconsInRegion(region: BeaconRegion): Promise<void> { return; }
/** /**
@ -557,7 +557,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<IBeaconPluginResult>} Returns a promise which is resolved with the * @returns {Promise<IBeaconPluginResult>} Returns a promise which is resolved with the
* requested authorization status. * requested authorization status.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
getAuthorizationStatus(): Promise<IBeaconPluginResult> { return; } getAuthorizationStatus(): Promise<IBeaconPluginResult> { return; }
/** /**
@ -569,7 +569,7 @@ export class IBeacon extends IonicNativePlugin {
* If you are using this plugin on Android devices only, you will never have to use this, nor {@code requestAlwaysAuthorization} * If you are using this plugin on Android devices only, you will never have to use this, nor {@code requestAlwaysAuthorization}
* @returns {Promise<void>} Returns a promise that is resolved when the request dialog is shown. * @returns {Promise<void>} Returns a promise that is resolved when the request dialog is shown.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
requestWhenInUseAuthorization(): Promise<void> { return; } requestWhenInUseAuthorization(): Promise<void> { return; }
@ -579,7 +579,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<void>} Returns a promise which is resolved when the native layer * @returns {Promise<void>} Returns a promise which is resolved when the native layer
* shows the request dialog. * shows the request dialog.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
requestAlwaysAuthorization(): Promise<void> { return; } requestAlwaysAuthorization(): Promise<void> { return; }
/** /**
@ -587,7 +587,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<Region[]>} Returns a promise which is resolved with an {Array} * @returns {Promise<Region[]>} Returns a promise which is resolved with an {Array}
* of {Region} instances that are being monitored by the native layer. * of {Region} instances that are being monitored by the native layer.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
getMonitoredRegions(): Promise<Region[]> { return; } getMonitoredRegions(): Promise<Region[]> { return; }
/** /**
@ -595,7 +595,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<Region[]>} Returns a promise which is resolved with an {Array} * @returns {Promise<Region[]>} Returns a promise which is resolved with an {Array}
* of {Region} instances that are being ranged by the native layer. * of {Region} instances that are being ranged by the native layer.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
getRangedRegions(): Promise<Region[]> { return; } getRangedRegions(): Promise<Region[]> { return; }
/** /**
@ -603,7 +603,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<boolean>} Returns a promise which is resolved with a {Boolean} * @returns {Promise<boolean>} Returns a promise which is resolved with a {Boolean}
* indicating whether ranging is available or not. * indicating whether ranging is available or not.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
isRangingAvailable(): Promise<boolean> { return; } isRangingAvailable(): Promise<boolean> { return; }
/** /**
@ -615,7 +615,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<boolean>} Returns a promise which is resolved with a {Boolean} * @returns {Promise<boolean>} Returns a promise which is resolved with a {Boolean}
* indicating whether the region type is supported or not. * indicating whether the region type is supported or not.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
isMonitoringAvailableForClass(region: Region): Promise<boolean> { return; } isMonitoringAvailableForClass(region: Region): Promise<boolean> { return; }
/** /**
@ -635,7 +635,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<void>} Returns a promise which is resolved as soon as the * @returns {Promise<void>} Returns a promise which is resolved as soon as the
* native layer acknowledged the dispatch of the advertising request. * native layer acknowledged the dispatch of the advertising request.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
startAdvertising(region: Region, measuredPower: number): Promise<void> { return; } startAdvertising(region: Region, measuredPower: number): Promise<void> { return; }
/** /**
@ -646,7 +646,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<void>} Returns a promise which is resolved as soon as the * @returns {Promise<void>} Returns a promise which is resolved as soon as the
* native layer acknowledged the dispatch of the request to stop advertising. * native layer acknowledged the dispatch of the request to stop advertising.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
stopAdvertising(region: Region): Promise<void> { return; } stopAdvertising(region: Region): Promise<void> { return; }
/** /**
@ -654,7 +654,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<void>} Returns a promise which is resolved with a {Boolean} * @returns {Promise<void>} Returns a promise which is resolved with a {Boolean}
* indicating whether advertising is available or not. * indicating whether advertising is available or not.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
isAdvertisingAvailable(): Promise<boolean> { return; } isAdvertisingAvailable(): Promise<boolean> { return; }
/** /**
@ -662,7 +662,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<void>} Returns a promise which is resolved with a {Boolean} * @returns {Promise<void>} Returns a promise which is resolved with a {Boolean}
* indicating whether advertising is active. * indicating whether advertising is active.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
isAdvertising(): Promise<boolean> { return; } isAdvertising(): Promise<boolean> { return; }
/** /**
@ -672,7 +672,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<void>} Returns a promise which is resolved as soon as the * @returns {Promise<void>} Returns a promise which is resolved as soon as the
* native layer has set the logging level accordingly. * native layer has set the logging level accordingly.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
disableDebugLogs(): Promise<void> { return; } disableDebugLogs(): Promise<void> { return; }
/** /**
@ -683,7 +683,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<void>} Returns a promise which is resolved as soon as the * @returns {Promise<void>} Returns a promise which is resolved as soon as the
* native layer has set the flag to enabled. * native layer has set the flag to enabled.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
enableDebugNotifications(): Promise<void> { return; } enableDebugNotifications(): Promise<void> { return; }
/** /**
@ -693,7 +693,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<void>} Returns a promise which is resolved as soon as the * @returns {Promise<void>} Returns a promise which is resolved as soon as the
* native layer has set the flag to disabled. * native layer has set the flag to disabled.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
disableDebugNotifications(): Promise<void> { return; } disableDebugNotifications(): Promise<void> { return; }
/** /**
@ -703,7 +703,7 @@ export class IBeacon extends IonicNativePlugin {
* @returns {Promise<void>} Returns a promise which is resolved as soon as the * @returns {Promise<void>} Returns a promise which is resolved as soon as the
* native layer has set the logging level accordingly. * native layer has set the logging level accordingly.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
enableDebugLogs(): Promise<void> { return; } enableDebugLogs(): Promise<void> { return; }
/** /**
@ -716,7 +716,7 @@ export class IBeacon extends IonicNativePlugin {
* message received by the native layer for appending. The returned message * message received by the native layer for appending. The returned message
* is expected to be equivalent to the one provided in the original call. * is expected to be equivalent to the one provided in the original call.
*/ */
@Cordova({otherPromise: true}) @Cordova({ otherPromise: true })
appendToDeviceLog(message: string): Promise<void> { return; } appendToDeviceLog(message: string): Promise<void> { return; }
} }

View File

@ -2,39 +2,39 @@ import { Injectable } from '@angular/core';
import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core'; import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
export interface ImageResizerOptions { export interface ImageResizerOptions {
/** /**
* The URI for the image on the device to get scaled * The URI for the image on the device to get scaled
*/ */
uri: string; uri: string;
/** /**
* The width of the new image * The width of the new image
*/ */
width: number; width: number;
/** /**
* The height of the new image * The height of the new image
*/ */
height: number; height: number;
/** /**
* The name of the folder the image should be put * The name of the folder the image should be put
* (Android only) * (Android only)
*/ */
folderName?: string; folderName?: string;
/** /**
* *
* Quality given as Number for the quality of the new image * Quality given as Number for the quality of the new image
* (Android and iOS only) * (Android and iOS only)
*/ */
quality?: number; quality?: number;
/** /**
* A custom name for the file. Default name is a timestamp * A custom name for the file. Default name is a timestamp
* (Android and Windows only) * (Android and Windows only)
*/ */
fileName?: string; fileName?: string;
} }
/** /**

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')
@ -81,7 +81,7 @@ export class InAppPurchase extends IonicNativePlugin {
@Cordova({ @Cordova({
otherPromise: true otherPromise: true
}) })
buy(productId: string): Promise<{transactionId: string, receipt: string, signature: string, productType: string}> { return; } buy(productId: string): Promise<{ transactionId: string, receipt: string, signature: string, productType: string }> { return; }
/** /**
* Same as buy, but for subscription based products. * Same as buy, but for subscription based products.
@ -91,7 +91,7 @@ export class InAppPurchase extends IonicNativePlugin {
@Cordova({ @Cordova({
otherPromise: true otherPromise: true
}) })
subscribe(productId: string): Promise<{transactionId: string, receipt: string, signature: string, productType: string}> { return; } subscribe(productId: string): Promise<{ transactionId: string, receipt: string, signature: string, productType: string }> { return; }
/** /**
* Call this function after purchasing a "consumable" product to mark it as consumed. On Android, you must consume products that you want to let the user purchase multiple times. If you will not consume the product after a purchase, the next time you will attempt to purchase it you will get the error message: * Call this function after purchasing a "consumable" product to mark it as consumed. On Android, you must consume products that you want to let the user purchase multiple times. If you will not consume the product after a purchase, the next time you will attempt to purchase it you will get the error message:

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) { }
@ -37,7 +37,7 @@ export class Instagram extends IonicNativePlugin {
@Cordova({ @Cordova({
callbackStyle: 'node' callbackStyle: 'node'
}) })
isInstalled(): Promise<boolean|string> { return; } isInstalled(): Promise<boolean | string> { return; }
/** /**
* Share an image on Instagram * Share an image on 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) { }
@ -75,11 +75,11 @@ export class JinsMeme extends IonicNativePlugin {
observable: true observable: true
}) })
connect(target: string): Observable<any> { connect(target: string): Observable<any> {
return new Observable<any>((observer: any) => { return new Observable<any>((observer: any) => {
let data = cordova.plugins.JinsMemePlugin.connect(target, observer.next.bind(observer), observer.complete.bind(observer), observer.error.bind(observer)); let data = cordova.plugins.JinsMemePlugin.connect(target, observer.next.bind(observer), observer.complete.bind(observer), observer.error.bind(observer));
return () => console.log(data); return () => console.log(data);
}); });
} }
/** /**
* Set auto connection mode. * Set auto connection mode.
*@param {Boolean} flag *@param {Boolean} flag
@ -109,10 +109,10 @@ export class JinsMeme extends IonicNativePlugin {
clearWithArgs: true clearWithArgs: true
}) })
startDataReport(): Observable<any> { return; } startDataReport(): Observable<any> { return; }
/** /**
* Stops receiving data. * Stops receiving data.
*@returns {Promise<any>} *@returns {Promise<any>}
*/ */
@Cordova() @Cordova()
stopDataReport(): Promise<any> { return; } stopDataReport(): Promise<any> { return; }
/** /**

View File

@ -34,7 +34,7 @@ export class Keyboard extends IonicNativePlugin {
* Hide the keyboard accessory bar with the next, previous and done buttons. * Hide the keyboard accessory bar with the next, previous and done buttons.
* @param hide {boolean} * @param hide {boolean}
*/ */
@Cordova({sync: true}) @Cordova({ sync: true })
hideKeyboardAccessoryBar(hide: boolean): void { } hideKeyboardAccessoryBar(hide: boolean): void { }
/** /**

View File

@ -56,7 +56,7 @@ export class Keychain extends IonicNativePlugin {
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'
}) })
set(key: string, value: string|number|boolean, useTouchID?: boolean): Promise<any> { return; } set(key: string, value: string | number | boolean, useTouchID?: boolean): Promise<any> { return; }
/** /**
* Gets a JSON value for a key * Gets a JSON value for a key

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) { }
@ -115,14 +115,14 @@ export class MusicControls extends IonicNativePlugin {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
create(options: MusicControlsOptions): Promise<any> {return; } create(options: MusicControlsOptions): Promise<any> { return; }
/** /**
* Destroy the media controller * Destroy the media controller
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
destroy(): Promise<any> {return; } destroy(): Promise<any> { return; }
/** /**
* Subscribe to the events of the media controller * Subscribe to the events of the media controller
@ -131,25 +131,25 @@ export class MusicControls extends IonicNativePlugin {
@Cordova({ @Cordova({
observable: true observable: true
}) })
subscribe(): Observable<any> {return; } subscribe(): Observable<any> { return; }
/** /**
* Start listening for events, this enables the Observable from the subscribe method * Start listening for events, this enables the Observable from the subscribe method
*/ */
@Cordova({sync: true}) @Cordova({ sync: true })
listen(): void {} listen(): void { }
/** /**
* Toggle play/pause: * Toggle play/pause:
* @param isPlaying {boolean} * @param isPlaying {boolean}
*/ */
@Cordova() @Cordova()
updateIsPlaying(isPlaying: boolean): void {} updateIsPlaying(isPlaying: boolean): void { }
/** /**
* Toggle dismissable: * Toggle dismissable:
* @param dismissable {boolean} * @param dismissable {boolean}
*/ */
@Cordova() @Cordova()
updateDismissable(dismissable: boolean): void {} updateDismissable(dismissable: boolean): void { }
} }

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) { }
@ -91,7 +91,7 @@ export class NativePageTransitions extends IonicNativePlugin {
* @param options {NativeTransitionOptions} Options for the transition * @param options {NativeTransitionOptions} Options for the transition
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova({platforms: ['iOS', 'Android']}) @Cordova({ platforms: ['iOS', 'Android'] })
fade(options: NativeTransitionOptions): Promise<any> { return; } fade(options: NativeTransitionOptions): Promise<any> { return; }
@ -100,7 +100,7 @@ export class NativePageTransitions extends IonicNativePlugin {
* @param options {NativeTransitionOptions} Options for the transition * @param options {NativeTransitionOptions} Options for the transition
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova({platforms: ['iOS', 'Android']}) @Cordova({ platforms: ['iOS', 'Android'] })
drawer(options: NativeTransitionOptions): Promise<any> { return; } drawer(options: NativeTransitionOptions): Promise<any> { return; }
@ -110,7 +110,7 @@ export class NativePageTransitions extends IonicNativePlugin {
* @param options {NativeTransitionOptions} Options for the transition * @param options {NativeTransitionOptions} Options for the transition
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova({platforms: ['iOS']}) @Cordova({ platforms: ['iOS'] })
curl(options: NativeTransitionOptions): Promise<any> { return; } curl(options: NativeTransitionOptions): Promise<any> { return; }
/** /**

View File

@ -43,7 +43,7 @@ export class NativeStorage extends IonicNativePlugin {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
setItem(reference: string, value: any): Promise<any> {return; } setItem(reference: string, value: any): Promise<any> { return; }
/** /**
* Gets a stored item * Gets a stored item
@ -51,7 +51,7 @@ export class NativeStorage extends IonicNativePlugin {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
getItem(reference: string): Promise<any> {return; } getItem(reference: string): Promise<any> { return; }
/** /**
* Removes a single stored item * Removes a single stored item
@ -59,13 +59,13 @@ export class NativeStorage extends IonicNativePlugin {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
remove(reference: string): Promise<any> {return; } remove(reference: string): Promise<any> { return; }
/** /**
* Removes all stored values. * Removes all stored values.
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
clear(): Promise<any> {return; } clear(): Promise<any> { return; }
} }

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) { }
@ -34,9 +34,9 @@ declare let window: any;
pluginRef: 'nfc', pluginRef: 'nfc',
repo: 'https://github.com/chariotsolutions/phonegap-nfc' repo: 'https://github.com/chariotsolutions/phonegap-nfc'
}) })
/** /**
*@{ NFC } class methods *@{ NFC } class methods
*/ */
@Injectable() @Injectable()
export class NFC extends IonicNativePlugin { export class NFC extends IonicNativePlugin {
/** /**
@ -52,7 +52,7 @@ export class NFC extends IonicNativePlugin {
clearFunction: 'removeNdefListener', clearFunction: 'removeNdefListener',
clearWithArgs: true clearWithArgs: true
}) })
addNdefListener(onSuccess?: Function, onFailure?: Function): Observable<any> {return; } addNdefListener(onSuccess?: Function, onFailure?: Function): Observable<any> { return; }
/** /**
* Registers an event listener for tags matching any tag type. * Registers an event listener for tags matching any tag type.
@ -67,7 +67,7 @@ export class NFC extends IonicNativePlugin {
clearFunction: 'removeTagDiscoveredListener', clearFunction: 'removeTagDiscoveredListener',
clearWithArgs: true clearWithArgs: true
}) })
addTagDiscoveredListener(onSuccess?: Function, onFailure?: Function): Observable<any> {return; } addTagDiscoveredListener(onSuccess?: Function, onFailure?: Function): Observable<any> { return; }
/** /**
* Registers an event listener for NDEF tags matching a specified MIME type. * Registers an event listener for NDEF tags matching a specified MIME type.
@ -83,7 +83,7 @@ export class NFC extends IonicNativePlugin {
clearFunction: 'removeMimeTypeListener', clearFunction: 'removeMimeTypeListener',
clearWithArgs: true clearWithArgs: true
}) })
addMimeTypeListener(mimeType: string, onSuccess?: Function, onFailure?: Function): Observable<any> {return; } addMimeTypeListener(mimeType: string, onSuccess?: Function, onFailure?: Function): Observable<any> { return; }
/** /**
* Registers an event listener for formatable NDEF tags. * Registers an event listener for formatable NDEF tags.
@ -96,7 +96,7 @@ export class NFC extends IonicNativePlugin {
successIndex: 0, successIndex: 0,
errorIndex: 3 errorIndex: 3
}) })
addNdefFormatableListener(onSuccess?: Function, onFailure?: Function): Observable<any> {return; } addNdefFormatableListener(onSuccess?: Function, onFailure?: Function): Observable<any> { return; }
/** /**
* Writes an NdefMessage(array of ndef records) to a NFC tag. * Writes an NdefMessage(array of ndef records) to a NFC tag.
@ -104,13 +104,13 @@ export class NFC extends IonicNativePlugin {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
write(message: any[]): Promise<any> {return; } write(message: any[]): Promise<any> { return; }
/** /**
* Makes a NFC tag read only. **Warning** this is permanent. * Makes a NFC tag read only. **Warning** this is permanent.
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
makeReadyOnly(): Promise<any> {return; } makeReadyOnly(): Promise<any> { return; }
/** /**
* Shares an NDEF Message(array of ndef records) via peer-to-peer. * Shares an NDEF Message(array of ndef records) via peer-to-peer.
@ -118,20 +118,20 @@ export class NFC extends IonicNativePlugin {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
share(message: any[]): Promise<any> {return; } share(message: any[]): Promise<any> { return; }
/** /**
* Stop sharing NDEF data via peer-to-peer. * Stop sharing NDEF data via peer-to-peer.
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
unshare(): Promise<any> {return; } unshare(): Promise<any> { return; }
/** /**
* Erase a NDEF tag * Erase a NDEF tag
*/ */
@Cordova() @Cordova()
erase(): Promise<any> {return; } erase(): Promise<any> { return; }
/** /**
* Send a file to another device via NFC handover. * Send a file to another device via NFC handover.
@ -139,28 +139,28 @@ export class NFC extends IonicNativePlugin {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
handover(uris: string[]): Promise<any> {return; } handover(uris: string[]): Promise<any> { return; }
/** /**
* Stop sharing NDEF data via NFC handover. * Stop sharing NDEF data via NFC handover.
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
stopHandover(): Promise<any> {return; } stopHandover(): Promise<any> { return; }
/** /**
* Opens the device's NFC settings. * Opens the device's NFC settings.
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
showSettings(): Promise<any> {return; } showSettings(): Promise<any> { return; }
/** /**
* Check if NFC is available and enabled on this device. * Check if NFC is available and enabled on this device.
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
enabled(): Promise<any> {return; } enabled(): Promise<any> { return; }
/** /**
* @{ NFC } class utility methods * @{ NFC } class utility methods
* for use with * for use with
@ -171,14 +171,14 @@ export class NFC extends IonicNativePlugin {
* @returns {string} * @returns {string}
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
bytesToString(bytes: number[]): string {return; } bytesToString(bytes: number[]): string { return; }
/** /**
* Convert string to byte array. * Convert string to byte array.
* @param str {string} * @param str {string}
* @returns {number[]} * @returns {number[]}
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
stringToBytes(str: string): number[] {return; }; stringToBytes(str: string): number[] { return; };
/** /**
* Convert byte array to hex string * Convert byte array to hex string
* *
@ -186,7 +186,7 @@ export class NFC extends IonicNativePlugin {
* @returns {string} * @returns {string}
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
bytesToHexString(bytes: number[]): string {return; }; bytesToHexString(bytes: number[]): string { return; };
} }
/** /**

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({
@ -77,7 +77,7 @@ export class PayPal extends IonicNativePlugin {
* @returns {Promise<string>} * @returns {Promise<string>}
*/ */
@Cordova() @Cordova()
version(): Promise<string> {return; } version(): Promise<string> { return; }
/** /**
* You must preconnect to PayPal to prepare the device for processing payments. * You must preconnect to PayPal to prepare the device for processing payments.
@ -89,7 +89,7 @@ export class PayPal extends IonicNativePlugin {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
init(clientIdsForEnvironments: PayPalEnvironment): Promise<any> {return; } init(clientIdsForEnvironments: PayPalEnvironment): Promise<any> { return; }
/** /**
* You must preconnect to PayPal to prepare the device for processing payments. * You must preconnect to PayPal to prepare the device for processing payments.
@ -101,7 +101,7 @@ export class PayPal extends IonicNativePlugin {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
prepareToRender(environment: string, configuration: PayPalConfiguration): Promise<any> {return; } prepareToRender(environment: string, configuration: PayPalConfiguration): Promise<any> { return; }
/** /**
* Start PayPal UI to collect payment from the user. * Start PayPal UI to collect payment from the user.
@ -112,7 +112,7 @@ export class PayPal extends IonicNativePlugin {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
renderSinglePaymentUI(payment: PayPalPayment): Promise<any> {return; } renderSinglePaymentUI(payment: PayPalPayment): Promise<any> { return; }
/** /**
* Once a user has consented to future payments, when the user subsequently initiates a PayPal payment * Once a user has consented to future payments, when the user subsequently initiates a PayPal payment
@ -125,14 +125,14 @@ export class PayPal extends IonicNativePlugin {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
clientMetadataID(): Promise<any> {return; } clientMetadataID(): Promise<any> { return; }
/** /**
* Please Read Docs on Future Payments at https://github.com/paypal/PayPal-iOS-SDK#future-payments * Please Read Docs on Future Payments at https://github.com/paypal/PayPal-iOS-SDK#future-payments
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
renderFuturePaymentUI(): Promise<any> {return; } renderFuturePaymentUI(): Promise<any> { return; }
/** /**
* Please Read Docs on Profile Sharing at https://github.com/paypal/PayPal-iOS-SDK#profile-sharing * Please Read Docs on Profile Sharing at https://github.com/paypal/PayPal-iOS-SDK#profile-sharing
@ -142,7 +142,7 @@ export class PayPal extends IonicNativePlugin {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
renderProfileSharingUI(scopes: string[]): Promise<any> {return; } renderProfileSharingUI(scopes: string[]): Promise<any> { return; }
} }
export interface PayPalEnvironment { export interface PayPalEnvironment {

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()
@ -69,13 +69,13 @@ export class Pedometer extends IonicNativePlugin {
@Cordova() @Cordova()
isFloorCountingAvailable(): Promise<boolean> { return; } isFloorCountingAvailable(): Promise<boolean> { return; }
/** /**
* Starts the delivery of recent pedestrian-related data to your Cordova app. * Starts the delivery of recent pedestrian-related data to your Cordova app.
* *
* When the app is suspended, the delivery of updates stops temporarily. * When the app is suspended, the delivery of updates stops temporarily.
* Upon returning to foreground or background execution, the pedometer object begins updates again. * Upon returning to foreground or background execution, the pedometer object begins updates again.
* @return {Observable<IPedometerData>} Returns a Observable that recieves repeatly data from pedometer in background. * @return {Observable<IPedometerData>} Returns a Observable that recieves repeatly data from pedometer in background.
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
clearFunction: 'stopPedometerUpdates' clearFunction: 'stopPedometerUpdates'

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'));
* *
* ``` * ```
*/ */
@ -57,8 +57,8 @@ export class PhotoLibrary extends IonicNativePlugin {
*/ */
@CordovaFiniteObservable({ @CordovaFiniteObservable({
callbackOrder: 'reverse', callbackOrder: 'reverse',
resultFinalPredicate: (result: {isLastChunk: boolean}) => { return result.isLastChunk; }, resultFinalPredicate: (result: { isLastChunk: boolean }) => { return result.isLastChunk; },
resultTransform: (result: {library: LibraryItem[]}) => { return result.library; }, resultTransform: (result: { library: LibraryItem[] }) => { return result.library; },
}) })
getLibrary(options?: GetLibraryOptions): Observable<LibraryItem[]> { return; } getLibrary(options?: GetLibraryOptions): Observable<LibraryItem[]> { return; }

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) { }
@ -33,21 +33,21 @@ export class PowerManagement extends IonicNativePlugin {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
acquire(): Promise<any> {return; } acquire(): Promise<any> { return; }
/** /**
* This acquires a partial wakelock, allowing the screen to be dimmed. * This acquires a partial wakelock, allowing the screen to be dimmed.
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
dim(): Promise<any> {return; } dim(): Promise<any> { return; }
/** /**
* Release the wakelock. It's important to do this when you're finished with the wakelock, to avoid unnecessary battery drain. * Release the wakelock. It's important to do this when you're finished with the wakelock, to avoid unnecessary battery drain.
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
release(): Promise<any> {return; } release(): Promise<any> { return; }
/** /**
* By default, the plugin will automatically release a wakelock when your app is paused (e.g. when the screen is turned off, or the user switches to another app). * By default, the plugin will automatically release a wakelock when your app is paused (e.g. when the screen is turned off, or the user switches to another app).
@ -56,5 +56,5 @@ export class PowerManagement extends IonicNativePlugin {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
setReleaseOnPause(set: boolean): Promise<any> {return; } setReleaseOnPause(set: boolean): Promise<any> { return; }
} }

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

@ -8,7 +8,7 @@ declare var cordova: any;
*/ */
export class SecureStorageObject { export class SecureStorageObject {
constructor(private _objectInstance?: any) {} constructor(private _objectInstance?: any) { }
/** /**
* Gets a stored item * Gets a stored item

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

@ -38,6 +38,6 @@ export class Shake extends IonicNativePlugin {
successIndex: 0, successIndex: 0,
errorIndex: 2 errorIndex: 2
}) })
startWatch(sensitivity?: number): Observable<any> {return; } startWatch(sensitivity?: number): Observable<any> { return; }
} }

View File

@ -73,7 +73,7 @@ export class SMS extends IonicNativePlugin {
phoneNumber: string | string[], phoneNumber: string | string[],
message: string, message: string,
options?: SmsOptions options?: SmsOptions
): Promise<any> { return; } ): Promise<any> { return; }
/** /**
* This function lets you know if the app has permission to send SMS * This function lets you know if the app has permission to send SMS

View File

@ -47,7 +47,7 @@ export class SocialSharing extends IonicNativePlugin {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
share(message?: string, subject?: string, file?: string|string[], url?: string): Promise<any> { return; } share(message?: string, subject?: string, file?: string | string[], url?: string): Promise<any> { return; }
/** /**
* Shares using the share sheet with additional options and returns a result object or an error message (requires plugin version 5.1.0+) * Shares using the share sheet with additional options and returns a result object or an error message (requires plugin version 5.1.0+)
@ -57,7 +57,7 @@ export class SocialSharing extends IonicNativePlugin {
@Cordova({ @Cordova({
platforms: ['iOS', 'Android'] platforms: ['iOS', 'Android']
}) })
shareWithOptions(options: { message?: string, subject?: string, files?: string|string[], url?: string, chooserTitle?: string }): Promise<any> { return; } shareWithOptions(options: { message?: string, subject?: string, files?: string | string[], url?: string, chooserTitle?: string }): Promise<any> { return; }
/** /**
* Checks if you can share via a specific app. * Checks if you can share via a specific app.
@ -194,7 +194,7 @@ export class SocialSharing extends IonicNativePlugin {
successIndex: 6, successIndex: 6,
errorIndex: 7 errorIndex: 7
}) })
shareViaEmail(message: string, subject: string, to: string[], cc?: string[], bcc?: string[], files?: string|string[]): Promise<any> { return; } shareViaEmail(message: string, subject: string, to: string[], cc?: string[], bcc?: string[], files?: string | string[]): Promise<any> { return; }
/** /**
* Share via AppName * Share via AppName

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

@ -46,7 +46,7 @@ export class SpinnerDialog extends IonicNativePlugin {
@Cordova({ @Cordova({
sync: true sync: true
}) })
show(title?: string, message?: string, cancelCallback?: any, iOSOptions?: SpinnerDialogIOSOptions): void {} show(title?: string, message?: string, cancelCallback?: any, iOSOptions?: SpinnerDialogIOSOptions): void { }
/** /**
* Hides the spinner dialog if visible * Hides the spinner dialog if visible
@ -54,6 +54,6 @@ export class SpinnerDialog extends IonicNativePlugin {
@Cordova({ @Cordova({
sync: true sync: true
}) })
hide(): void {} hide(): void { }
} }

View File

@ -33,7 +33,7 @@ export class SplashScreen extends IonicNativePlugin {
@Cordova({ @Cordova({
sync: true sync: true
}) })
show(): void {} show(): void { }
/** /**
* Hides the splashscreen * Hides the splashscreen
@ -41,6 +41,6 @@ export class SplashScreen extends IonicNativePlugin {
@Cordova({ @Cordova({
sync: true sync: true
}) })
hide(): void {} hide(): void { }
} }

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

@ -198,7 +198,7 @@ export class SQLite extends IonicNativePlugin {
@CordovaCheck() @CordovaCheck()
create(config: SQLiteDatabaseConfig): Promise<SQLiteObject> { create(config: SQLiteDatabaseConfig): Promise<SQLiteObject> {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
sqlitePlugin.openDatabase(config, db => resolve(new SQLiteObject(db)), reject); sqlitePlugin.openDatabase(config, db => resolve(new SQLiteObject(db)), reject);
}); });
} }

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) { }
@ -54,7 +54,7 @@ export class StreamingMedia extends IonicNativePlugin {
* @param videoUrl {string} The URL of the video * @param videoUrl {string} The URL of the video
* @param options {StreamingVideoOptions} Options * @param options {StreamingVideoOptions} Options
*/ */
@Cordova({sync: true}) @Cordova({ sync: true })
playVideo(videoUrl: string, options?: StreamingVideoOptions): void { } playVideo(videoUrl: string, options?: StreamingVideoOptions): void { }
/** /**
@ -62,25 +62,25 @@ export class StreamingMedia extends IonicNativePlugin {
* @param audioUrl {string} The URL of the audio stream * @param audioUrl {string} The URL of the audio stream
* @param options {StreamingAudioOptions} Options * @param options {StreamingAudioOptions} Options
*/ */
@Cordova({sync: true}) @Cordova({ sync: true })
playAudio(audioUrl: string, options?: StreamingAudioOptions): void { } playAudio(audioUrl: string, options?: StreamingAudioOptions): void { }
/** /**
* Stops streaming audio * Stops streaming audio
*/ */
@Cordova({sync: true}) @Cordova({ sync: true })
stopAudio(): void { } stopAudio(): void { }
/** /**
* Pauses streaming audio * Pauses streaming audio
*/ */
@Cordova({sync: true, platforms: ['iOS']}) @Cordova({ sync: true, platforms: ['iOS'] })
pauseAudio(): void { } pauseAudio(): void { }
/** /**
* Resumes streaming audio * Resumes streaming audio
*/ */
@Cordova({sync: true, platforms: ['iOS']}) @Cordova({ sync: true, platforms: ['iOS'] })
resumeAudio(): void { } resumeAudio(): void { }
} }

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

@ -2,12 +2,12 @@ import { Injectable } from '@angular/core';
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core'; import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';
export interface TTSOptions { export interface TTSOptions {
/** text to speak */ /** text to speak */
text: string; text: string;
/** a string like 'en-US', 'zh-CN', etc */ /** a string like 'en-US', 'zh-CN', etc */
locale?: string; locale?: string;
/** speed rate, 0 ~ 1 */ /** speed rate, 0 ~ 1 */
rate?: number; rate?: number;
} }
/** /**
@ -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

@ -87,13 +87,13 @@ export class ThemeableBrowserObject {
* Displays an browser window that was opened hidden. Calling this has no effect * Displays an browser window that was opened hidden. Calling this has no effect
* if the browser was already visible. * if the browser was already visible.
*/ */
@CordovaInstance({sync: true}) @CordovaInstance({ sync: true })
show(): void { } show(): void { }
/** /**
* Closes the browser window. * Closes the browser window.
*/ */
@CordovaInstance({sync: true}) @CordovaInstance({ sync: true })
close(): void { } close(): void { }
/** /**
@ -108,7 +108,7 @@ export class ThemeableBrowserObject {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@CordovaInstance() @CordovaInstance()
executeScript(script: {file?: string, code?: string}): Promise<any> {return; } executeScript(script: { file?: string, code?: string }): Promise<any> { return; }
/** /**
* Injects CSS into the browser window. * Injects CSS into the browser window.
@ -116,7 +116,7 @@ export class ThemeableBrowserObject {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@CordovaInstance() @CordovaInstance()
insertCss(css: {file?: string, code?: string}): Promise<any> {return; } insertCss(css: { file?: string, code?: string }): Promise<any> { return; }
/** /**
* A method that allows you to listen to events happening in the browser. * A method that allows you to listen to events happening in the browser.
@ -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

@ -66,18 +66,18 @@ export class TwitterConnect extends IonicNativePlugin {
* @returns {Promise<TwitterConnectResponse>} returns a promise that resolves if logged in and rejects if failed to login * @returns {Promise<TwitterConnectResponse>} returns a promise that resolves if logged in and rejects if failed to login
*/ */
@Cordova() @Cordova()
login(): Promise<TwitterConnectResponse> {return; } login(): Promise<TwitterConnectResponse> { return; }
/** /**
* Logs out * Logs out
* @returns {Promise<any>} returns a promise that resolves if logged out and rejects if failed to logout * @returns {Promise<any>} returns a promise that resolves if logged out and rejects if failed to logout
*/ */
@Cordova() @Cordova()
logout(): Promise<any> {return; } logout(): Promise<any> { return; }
/** /**
* Returns user's profile information * Returns user's profile information
* @returns {Promise<any>} returns a promise that resolves if user profile is successfully retrieved and rejects if request fails * @returns {Promise<any>} returns a promise that resolves if user profile is successfully retrieved and rejects if request fails
*/ */
@Cordova() @Cordova()
showUser(): Promise<any> {return; } showUser(): Promise<any> { return; }
} }

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

@ -5,10 +5,10 @@ import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
* Options for the video playback using the `play` function. * Options for the video playback using the `play` function.
*/ */
export interface VideoOptions { export interface VideoOptions {
/** /**
* Set the initial volume of the video playback, where 0.0 is 0% volume and 1.0 is 100%. * Set the initial volume of the video playback, where 0.0 is 0% volume and 1.0 is 100%.
* For example: for a volume of 30% set the value to 0.3. * For example: for a volume of 30% set the value to 0.3.
*/ */
volume?: number; volume?: number;
/** /**
* There are to options for the scaling mode. SCALE_TO_FIT which is default and SCALE_TO_FIT_WITH_CROPPING. * There are to options for the scaling mode. SCALE_TO_FIT which is default and SCALE_TO_FIT_WITH_CROPPING.
@ -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) { }
@ -31,6 +31,6 @@ export class YoutubeVideoPlayer extends IonicNativePlugin {
* Plays a YouTube video * Plays a YouTube video
* @param videoId {string} Video ID * @param videoId {string} Video ID
*/ */
@Cordova({sync: true}) @Cordova({ sync: true })
openVideo(videoId: string): void { } openVideo(videoId: string): void { }
} }

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) { }
@ -42,6 +42,6 @@ export class Zip extends IonicNativePlugin {
successIndex: 2, successIndex: 2,
errorIndex: 4 errorIndex: 4
}) })
unzip(sourceZip: string, destUrl: string, onProgress?: Function): Promise<number> {return; } unzip(sourceZip: string, destUrl: string, onProgress?: Function): Promise<number> { return; }
} }