github/awesome-cordova-plugins
github/awesome-cordova-plugins
2
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2025-03-04 00:13:06 +08:00
Code Issues Projects Releases Wiki Activity

Merge branch 'master' of github.com:driftyco/ionic-native

Browse Source
This commit is contained in:
Ibby Hadeed 2016-12-01 18:45:35 -05:00
commit a26b8879f3
88 changed files with 638 additions and 351 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/plugins/actionsheet.ts
View File

@ -52,7 +52,7 @@ export class ActionSheet {
/** /**
* Show a native ActionSheet component. See below for options. * Show a native ActionSheet component. See below for options.
* @param {options} Options See table below * @param {options} Options See table below
* @returns {Promise} Returns a Promise that resolves with the index of the * @returns {Promise<any>} Returns a Promise that resolves with the index of the
* button pressed (1 based, so 1, 2, 3, etc.) * button pressed (1 based, so 1, 2, 3, etc.)
*/ */
@Cordova() @Cordova()
@ -70,7 +70,7 @@ export class ActionSheet {
/** /**
* Progamtically hide the native ActionSheet * Progamtically hide the native ActionSheet
* @returns {Promise} Returns a Promise that resolves when the actionsheet is closed * @returns {Promise<any>} Returns a Promise that resolves when the actionsheet is closed
*/ */
@Cordova() @Cordova()
static hide(options?: any): Promise<any> { return; } static hide(options?: any): Promise<any> { return; }

5
src/plugins/admob.ts
View File

@ -35,6 +35,7 @@ export class AdMob {
/** /**
* *
* @param adIdOrOptions * @param adIdOrOptions
* @returns {Promise<any>} Returns a Promise that resolves when the banner is created
*/ */
@Cordova() @Cordova()
static createBanner(adIdOrOptions: any): Promise<any> { return; } static createBanner(adIdOrOptions: any): Promise<any> { return; }
@ -77,6 +78,7 @@ export class AdMob {
/** /**
* *
* @param adIdOrOptions * @param adIdOrOptions
* @returns {Promise<any>} Returns a Promise that resolves when interstitial is prepared
*/ */
@Cordova() @Cordova()
static prepareInterstitial(adIdOrOptions: any): Promise<any> { return; } static prepareInterstitial(adIdOrOptions: any): Promise<any> { return; }
@ -91,6 +93,7 @@ export class AdMob {
/** /**
* *
* @returns {Promise<any>} Returns a Promise that resolves when the interstitial is ready
*/ */
@Cordova() @Cordova()
static isInterstitialReady(): Promise<boolean> { return; } static isInterstitialReady(): Promise<boolean> { return; }
@ -98,6 +101,7 @@ export class AdMob {
/** /**
* Prepare a reward video ad * Prepare a reward video ad
* @param adIdOrOptions * @param adIdOrOptions
* @returns {Promise<any>} Returns a Promise that resolves when the ad is prepared
*/ */
@Cordova() @Cordova()
static prepareRewardVideoAd(adIdOrOptions: any): Promise<any> { return; } static prepareRewardVideoAd(adIdOrOptions: any): Promise<any> { return; }
@ -113,6 +117,7 @@ export class AdMob {
/** /**
* Sets the values for configuration and targeting * Sets the values for configuration and targeting
* @param options Returns a promise that resolves if the options are set successfully * @param options Returns a promise that resolves if the options are set successfully
* @returns {Promise<any>} Returns a Promise that resolves when the options have been set
*/ */
@Cordova() @Cordova()
static setOptions(options: any): Promise<any> { return; } static setOptions(options: any): Promise<any> { return; }

1
src/plugins/android-fingerprint-auth.ts
View File

@ -71,6 +71,7 @@ export class AndroidFingerprintAuth {
/** /**
* 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
*/ */
@Cordova() @Cordova()
static isAvailable(): Promise<{isAvailable: boolean}> {return; } static isAvailable(): Promise<{isAvailable: boolean}> {return; }

8
src/plugins/appversion.ts
View File

@ -28,28 +28,28 @@ import { Cordova, Plugin } from './plugin';
export class AppVersion { export class AppVersion {
/** /**
* Returns the name of the app * Returns the name of the app
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static getAppName(): Promise<any> { return; } static getAppName(): Promise<any> { return; }
/** /**
* Returns the package name of the app * Returns the package name of the app
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static getPackageName(): Promise<any> { return; } static getPackageName(): Promise<any> { return; }
/** /**
* Returns the build identifier of the app * Returns the build identifier of the app
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static getVersionCode(): Promise<any> { return; } static getVersionCode(): Promise<any> { return; }
/** /**
* Returns the version of the app * Returns the version of the app
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static getVersionNumber(): Promise<any> { return; } static getVersionNumber(): Promise<any> { return; }

12
src/plugins/background-geolocation.ts
View File

@ -346,12 +346,14 @@ export class BackgroundGeolocation {
/** /**
* Turn ON the background-geolocation system. * Turn ON the background-geolocation system.
* The user will be tracked whenever they suspend the app. * The user will be tracked whenever they suspend the app.
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static start(): Promise<any> { return; } static start(): Promise<any> { return; }
/** /**
* Turn OFF background-tracking * Turn OFF background-tracking
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static stop(): Promise<any> { return; } static stop(): Promise<any> { return; }
@ -372,6 +374,7 @@ export class BackgroundGeolocation {
/** /**
* Setup configuration * Setup configuration
* @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'
@ -381,6 +384,7 @@ export class BackgroundGeolocation {
/** /**
* Returns current stationaryLocation if available. null if not * Returns current stationaryLocation if available. null if not
* NOTE: IOS, WP only * NOTE: IOS, WP only
* @returns {Promise<Location>}
*/ */
@Cordova() @Cordova()
static getStationaryLocation(): Promise<Location> { return; } static getStationaryLocation(): Promise<Location> { return; }
@ -389,6 +393,7 @@ export class BackgroundGeolocation {
* Add a stationary-region listener. Whenever the devices enters "stationary-mode", * Add a stationary-region listener. Whenever the devices enters "stationary-mode",
* your #success callback will be executed with #location param containing #radius of region * your #success callback will be executed with #location param containing #radius of region
* NOTE: IOS, WP only * NOTE: IOS, WP only
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static onStationary(): Promise<any> { return; } static onStationary(): Promise<any> { return; }
@ -418,6 +423,7 @@ export class BackgroundGeolocation {
* If user enable or disable location services then success callback will be executed. * If user enable or disable location services then success callback will be executed.
* In case or error (SettingNotFoundException) fail callback will be executed. * In case or error (SettingNotFoundException) fail callback will be executed.
* NOTE: ANDROID only * NOTE: ANDROID only
* @returns {Promise<boolean>}
*/ */
@Cordova() @Cordova()
static watchLocationMode(): Promise<boolean> { return; } static watchLocationMode(): Promise<boolean> { return; }
@ -437,12 +443,14 @@ export class BackgroundGeolocation {
* or * or
* - option.debug is true * - option.debug is true
* NOTE: ANDROID only * NOTE: ANDROID only
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static getLocations(): Promise<any> { return; } static getLocations(): Promise<any> { return; }
/**
 /**

* Method will return locations, which has not been yet posted to server. NOTE: Locations does contain locationId.
 * Method will return locations, which has not been yet posted to server. NOTE: Locations does contain locationId.

* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static getValidLocations(): Promise<any> { return; } static getValidLocations(): Promise<any> { return; }
@ -450,6 +458,7 @@ export class BackgroundGeolocation {
/** /**
* Delete stored location by given locationId. * Delete stored location by given locationId.
* NOTE: ANDROID only * NOTE: ANDROID only
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static deleteLocation(locationId: number): Promise<any> { return; } static deleteLocation(locationId: number): Promise<any> { return; }
@ -457,6 +466,7 @@ export class BackgroundGeolocation {
/** /**
* Delete all stored locations. * Delete all stored locations.
* NOTE: ANDROID only * NOTE: ANDROID only
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static deleteAllLocations(): Promise<any> { return; } static deleteAllLocations(): Promise<any> { return; }
@ -474,6 +484,7 @@ export class BackgroundGeolocation {
* NOTE: iOS only * NOTE: iOS only
* *
* @param {number} See above.
 * @param {number} See above.

* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static switchMode(modeId: number): Promise<any> { return; } static switchMode(modeId: number): Promise<any> { return; }
@ -483,6 +494,7 @@ export class BackgroundGeolocation {
* @see https://github.com/mauron85/cordova-plugin-background-geolocation/tree/v2.2.1#debugging for more information.
 * @see https://github.com/mauron85/cordova-plugin-background-geolocation/tree/v2.2.1#debugging for more information.

* *
* @param {number} Limits the number of entries
 * @param {number} Limits the number of entries

* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static getLogEntries(limit: number): Promise<any> { return; } static getLogEntries(limit: number): Promise<any> { return; }

12
src/plugins/badge.ts
View File

@ -28,6 +28,7 @@ export class Badge {
/** /**
* Clear the badge of the app icon. * Clear the badge of the app icon.
* @returns {Promise<boolean>}
*/ */
@Cordova() @Cordova()
static clear(): Promise<boolean> { return; } static clear(): Promise<boolean> { return; }
@ -35,14 +36,14 @@ export class Badge {
/** /**
* Set the badge of the app icon. * Set the badge of the app icon.
* @param {number} badgeNumber The new badge number. * @param {number} badgeNumber The new badge number.
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static set(badgeNumber: number): Promise<any> { return; } static set(badgeNumber: number): Promise<any> { return; }
/** /**
* Get the badge of the app icon. * Get the badge of the app icon.
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static get(): Promise<any> { return; } static get(): Promise<any> { return; }
@ -50,7 +51,7 @@ export class Badge {
/** /**
* Increase the badge number. * Increase the badge number.
* @param {number} increaseBy Count to add to the current badge number * @param {number} increaseBy Count to add to the current badge number
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static increase(increaseBy: number): Promise<any> { return; } static increase(increaseBy: number): Promise<any> { return; }
@ -58,20 +59,21 @@ export class Badge {
/** /**
* Decrease the badge number. * Decrease the badge number.
* @param {number} decreaseBy Count to subtract from the current badge number * @param {number} decreaseBy Count to subtract from the current badge number
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static decrease(decreaseBy: number): Promise<any> { return; } static decrease(decreaseBy: number): Promise<any> { return; }
/** /**
* Determine if the app has permission to show badges. * Determine if the app has permission to show badges.
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static hasPermission(): Promise<any> { return; } static hasPermission(): Promise<any> { return; }
/** /**
* Register permission to set badge notifications * Register permission to set badge notifications
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static registerPermission(): Promise<any> { return; } static registerPermission(): Promise<any> { return; }

3
src/plugins/barcodescanner.ts
View File

@ -40,7 +40,7 @@ export class BarcodeScanner {
/** /**
* Open the barcode scanner. * Open the barcode scanner.
* @param options {Object} Optional options to pass to the scanner * @param options {Object} Optional options to pass to the scanner
* @return Returns a Promise that resolves with scanner data, or rejects with an error. * @returns {Promise<any>} Returns a Promise that resolves with scanner data, or rejects with an error.
*/ */
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'
@ -52,6 +52,7 @@ export class BarcodeScanner {
* NOTE: not well supported on Android * NOTE: not well supported on Android
* @param type {string} Type of encoding * @param type {string} Type of encoding
* @param data {any} Data to encode * @param data {any} Data to encode
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static encode(type: string, data: any): Promise<any> { return; } static encode(type: string, data: any): Promise<any> { return; }

2
src/plugins/base64togallery.ts
View File

@ -26,7 +26,7 @@ export class Base64ToGallery {
* Converts a base64 string to an image file in the device gallery * Converts a base64 string to an image file in the device gallery
* @param {string} data The actual base64 string that you want to save * @param {string} data The actual base64 string that you want to save
* @param {any} options (optional) An object with properties: prefix: string, mediaScanner: boolean. Prefix will be prepended to the filename. If true, mediaScanner runs Media Scanner on Android and saves to Camera Roll on iOS; if false, saves to Library folder on iOS. * @param {any} options (optional) An object with properties: prefix: string, mediaScanner: boolean. Prefix will be prepended to the filename. If true, mediaScanner runs Media Scanner on Android and saves to Camera Roll on iOS; if false, saves to Library folder on iOS.
* @returns {Promise} returns a promise that resolves when the image is saved. * @returns {Promise<any>} returns a promise that resolves when the image is saved.
*/ */
@Cordova({ @Cordova({
successIndex: 2, successIndex: 2,

2
src/plugins/batterystatus.ts
View File

@ -33,7 +33,7 @@ export class BatteryStatus {
/** /**
* Watch the change in battery level * Watch the change in battery level
* @returns {Observable} Returns an observable that pushes a status object * @returns {Observable<StatusObject>} Returns an observable that pushes a status object
*/ */
@Cordova({ @Cordova({
eventObservable: true, eventObservable: true,

16
src/plugins/ble.ts
View File

@ -178,7 +178,7 @@ export class BLE {
* ``` * ```
* @param {string[]} services List of service UUIDs to discover, or `[]` to find all devices * @param {string[]} services List of service UUIDs to discover, or `[]` to find all devices
* @param {number} seconds Number of seconds to run discovery * @param {number} seconds Number of seconds to run discovery
* @return Returns an Observable that notifies of each peripheral that is discovered during the specified time. * @returns {Observable<any>} Returns an Observable that notifies of each peripheral that is discovered during the specified time.
*/ */
@Cordova({ @Cordova({
observable: true observable: true
@ -199,7 +199,7 @@ export class BLE {
* }, 5000); * }, 5000);
* ``` * ```
* @param {string[]} services List of service UUIDs to discover, or `[]` to find all devices * @param {string[]} services List of service UUIDs to discover, or `[]` to find all devices
* @return Returns an Observable that notifies of each peripheral discovered. * @returns {Observable<any>} Returns an Observable that notifies of each peripheral discovered.
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -212,7 +212,7 @@ export class BLE {
* Scans for BLE devices. This function operates similarly to the `startScan` function, but allows you to specify extra options (like allowing duplicate device reports). * Scans for BLE devices. This function operates similarly to the `startScan` function, but allows you to specify extra options (like allowing duplicate device reports).
* @param {string[]} services List of service UUIDs to discover, or `[]` to find all devices * @param {string[]} services List of service UUIDs to discover, or `[]` to find all devices
* @param options {any} * @param options {any}
* @return Returns an Observable that notifies of each peripheral discovered. * @returns {Observable<any>} Returns an Observable that notifies of each peripheral discovered.
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -373,7 +373,7 @@ export class BLE {
* @param {string} deviceId UUID or MAC address of the peripheral * @param {string} deviceId UUID or MAC address of the peripheral
* @param {string} serviceUUID UUID of the BLE service * @param {string} serviceUUID UUID of the BLE service
* @param {string} characteristicUUID UUID of the BLE characteristic * @param {string} characteristicUUID UUID of the BLE characteristic
* @return Returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static stopNotification( static stopNotification(
@ -393,7 +393,7 @@ export class BLE {
* ); * );
* ``` * ```
* @param {string} deviceId UUID or MAC address of the peripheral * @param {string} deviceId UUID or MAC address of the peripheral
* @return Returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static isConnected(deviceId: string): Promise<any> { return; } static isConnected(deviceId: string): Promise<any> { return; }
@ -401,7 +401,7 @@ export class BLE {
/** /**
* Report if bluetooth is enabled. * Report if bluetooth is enabled.
* *
* @return {Promise<void>} Returns a Promise that resolves if Bluetooth is enabled, and rejects if disabled. * @returns {Promise<void>} Returns a Promise that resolves if Bluetooth is enabled, and rejects if disabled.
*/ */
@Cordova() @Cordova()
static isEnabled(): Promise<void> { return; } static isEnabled(): Promise<void> { return; }
@ -409,7 +409,7 @@ export class BLE {
/** /**
* Open System Bluetooth settings (Android only). * Open System Bluetooth settings (Android only).
* *
* @return Returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static showBluetoothSettings(): Promise<any> { return; } static showBluetoothSettings(): Promise<any> { return; }
@ -417,7 +417,7 @@ export class BLE {
/** /**
* Enable Bluetooth on the device (Android only). * Enable Bluetooth on the device (Android only).
* *
* @return Returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static enable(): Promise<any> { return; } static enable(): Promise<any> { return; }

34
src/plugins/bluetoothserial.ts
View File

@ -39,7 +39,7 @@ export class BluetoothSerial {
/** /**
* Connect to a Bluetooth device * Connect to a Bluetooth device
* @param {string} macAddress_or_uuid Identifier of the remote device * @param {string} macAddress_or_uuid Identifier of the remote device
* @returns {Observable} Subscribe to connect, unsubscribe to disconnect. * @returns {Observable<any>} Subscribe to connect, unsubscribe to disconnect.
*/ */
@Cordova({ @Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'], platforms: ['Android', 'iOS', 'Windows Phone'],
@ -51,7 +51,7 @@ export class BluetoothSerial {
/** /**
* Connect insecurely to a Bluetooth device * Connect insecurely to a Bluetooth device
* @param {string} macAddress Identifier of the remote device * @param {string} macAddress Identifier of the remote device
* @returns {Observable} Subscribe to connect, unsubscribe to disconnect. * @returns {Observable<any>} Subscribe to connect, unsubscribe to disconnect.
*/ */
@Cordova({ @Cordova({
platforms: ['Android'], platforms: ['Android'],
@ -63,7 +63,7 @@ export class BluetoothSerial {
/** /**
* Writes data to the serial port * Writes data to the serial port
* @param {any} data ArrayBuffer of data * @param {any} data ArrayBuffer of data
* @returns {Promise} returns a promise when data has been written * @returns {Promise<any>} returns a promise when data has been written
*/ */
@Cordova({ @Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'] platforms: ['Android', 'iOS', 'Windows Phone']
@ -72,7 +72,7 @@ export class BluetoothSerial {
/** /**
* Gets the number of bytes of data available * Gets the number of bytes of data available
* @returns {Promise} returns a promise that contains the available bytes * @returns {Promise<any>} returns a promise that contains the available bytes
*/ */
@Cordova({ @Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'] platforms: ['Android', 'iOS', 'Windows Phone']
@ -80,7 +80,7 @@ export class BluetoothSerial {
/** /**
* Reads data from the buffer * Reads data from the buffer
* @returns {Promise} returns a promise with data from the buffer * @returns {Promise<any>} returns a promise with data from the buffer
*/ */
@Cordova({ @Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'] platforms: ['Android', 'iOS', 'Windows Phone']
@ -90,7 +90,7 @@ export class BluetoothSerial {
/** /**
* Reads data from the buffer until it reaches a delimiter * Reads data from the buffer until it reaches a delimiter
* @param {string} delimiter string that you want to search until * @param {string} delimiter string that you want to search until
* @returns {Promise} returns a promise * @returns {Promise<any>} returns a promise
*/ */
@Cordova({ @Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'] platforms: ['Android', 'iOS', 'Windows Phone']
@ -100,7 +100,7 @@ export class BluetoothSerial {
/** /**
* Subscribe to be notified when data is received * Subscribe to be notified when data is received
* @param {string} delimiter the string you want to watch for * @param {string} delimiter the string you want to watch for
* @returns {Observable} returns an observable. * @returns {Observable<any>} returns an observable.
*/ */
@Cordova({ @Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'], platforms: ['Android', 'iOS', 'Windows Phone'],
@ -111,7 +111,7 @@ export class BluetoothSerial {
/** /**
* Subscribe to be notified when data is received * Subscribe to be notified when data is received
* @returns {Observable} returns an observable * @returns {Observable<any>} returns an observable
*/ */
@Cordova({ @Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'], platforms: ['Android', 'iOS', 'Windows Phone'],
@ -122,7 +122,7 @@ export class BluetoothSerial {
/** /**
* Clears data in buffer * Clears data in buffer
* @returns {Promise} returns a promise when completed * @returns {Promise<any>} returns a promise when completed
*/ */
@Cordova({ @Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'] platforms: ['Android', 'iOS', 'Windows Phone']
@ -131,7 +131,7 @@ export class BluetoothSerial {
/** /**
* Lists bonded devices * Lists bonded devices
* @returns {Promise} returns a promise * @returns {Promise<any>} returns a promise
*/ */
@Cordova({ @Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'] platforms: ['Android', 'iOS', 'Windows Phone']
@ -140,7 +140,7 @@ export class BluetoothSerial {
/** /**
* Reports if bluetooth is enabled * Reports if bluetooth is enabled
* @returns {Promise} returns a promise * @returns {Promise<any>} returns a promise
*/ */
@Cordova({ @Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'] platforms: ['Android', 'iOS', 'Windows Phone']
@ -149,7 +149,7 @@ export class BluetoothSerial {
/** /**
* Reports the connection status * Reports the connection status
* @returns {Promise} returns a promise * @returns {Promise<any>} returns a promise
*/ */
@Cordova({ @Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'] platforms: ['Android', 'iOS', 'Windows Phone']
@ -158,7 +158,7 @@ export class BluetoothSerial {
/** /**
* Reads the RSSI from the connected peripheral * Reads the RSSI from the connected peripheral
* @returns {Promise} returns a promise * @returns {Promise<any>} returns a promise
*/ */
@Cordova({ @Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'] platforms: ['Android', 'iOS', 'Windows Phone']
@ -167,7 +167,7 @@ export class BluetoothSerial {
/** /**
* Show the Bluetooth settings on the device * Show the Bluetooth settings on the device
* @returns {Promise} returns a promise * @returns {Promise<any>} returns a promise
*/ */
@Cordova({ @Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'] platforms: ['Android', 'iOS', 'Windows Phone']
@ -176,7 +176,7 @@ export class BluetoothSerial {
/** /**
* Enable Bluetooth on the device * Enable Bluetooth on the device
* @returns {Promise} returns a promise * @returns {Promise<any>} returns a promise
*/ */
@Cordova({ @Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'] platforms: ['Android', 'iOS', 'Windows Phone']
@ -185,7 +185,7 @@ export class BluetoothSerial {
/** /**
* Discover unpaired devices * Discover unpaired devices
* @returns {Promise} returns a promise * @returns {Promise<any>} returns a promise
*/ */
@Cordova({ @Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'] platforms: ['Android', 'iOS', 'Windows Phone']
@ -194,7 +194,7 @@ export class BluetoothSerial {
/** /**
* Subscribe to be notified on Bluetooth device discovery. Discovery process must be initiated with the `discoverUnpaired` function. * Subscribe to be notified on Bluetooth device discovery. Discovery process must be initiated with the `discoverUnpaired` function.
* @returns {Observable} Returns an observable * @returns {Observable<any>} Returns an observable
*/ */
@Cordova({ @Cordova({
platforms: ['Android', 'iOS', 'Windows Phone'], platforms: ['Android', 'iOS', 'Windows Phone'],

4
src/plugins/brightness.ts
View File

@ -30,7 +30,7 @@ export class Brightness {
* Sets the brightness of the display. * Sets the brightness of the display.
* *
* @param {value} Floating number between 0 and 1 in which case 1 means 100% brightness and 0 means 0% brightness. * @param {value} Floating number between 0 and 1 in which case 1 means 100% brightness and 0 means 0% brightness.
* @returns {Promise} Returns a Promise that resolves if setting brightness was successful. * @returns {Promise<any>} Returns a Promise that resolves if setting brightness was successful.
*/ */
@Cordova() @Cordova()
static setBrightness(value: number): Promise<any> { return; } static setBrightness(value: number): Promise<any> { return; }
@ -38,7 +38,7 @@ export class Brightness {
/** /**
* Reads the current brightness of the device display. * Reads the current brightness of the device display.
* *
* @returns {Promise} Returns a Promise that resolves with the * @returns {Promise<any>} Returns a Promise that resolves with the
* brightness value of the device display (floating number between 0 and 1). * brightness value of the device display (floating number between 0 and 1).
*/ */
@Cordova() @Cordova()

22
src/plugins/calendar.ts
View File

@ -99,7 +99,7 @@ export class Calendar {
* Create a calendar. (iOS only) * Create a calendar. (iOS only)
* *
* @param {string | Object} nameOrOptions either a string name or a options object. If string, provide the calendar name. IF an object, provide a calendar name as a string and a calendar color in hex format as a string * @param {string | Object} nameOrOptions either a string name or a options object. If string, provide the calendar name. IF an object, provide a calendar name as a string and a calendar color in hex format as a string
* @return {Promise} Returns a Promise * @returns {Promise<any>} Returns a Promise
*/ */
@Cordova() @Cordova()
static createCalendar( static createCalendar(
@ -109,7 +109,7 @@ export class Calendar {
/** /**
* Delete a calendar. (iOS only) * Delete a calendar. (iOS only)
* @param {string} name Name of the calendar to delete. * @param {string} name Name of the calendar to delete.
* @return Returns a Promise * @returns {Promise<any>} Returns a Promise
*/ */
@Cordova() @Cordova()
static deleteCalendar(name: string): Promise<any> { return; } static deleteCalendar(name: string): Promise<any> { return; }
@ -150,7 +150,7 @@ export class Calendar {
* @param {string} [notes] The event notes * @param {string} [notes] The event notes
* @param {Date} [startDate] The event start date * @param {Date} [startDate] The event start date
* @param {Date} [endDate] The event end date * @param {Date} [endDate] The event end date
* @return Returns a Promise * @returns {Promise<any>} Returns a Promise
*/ */
@Cordova() @Cordova()
static createEvent( static createEvent(
@ -170,7 +170,7 @@ export class Calendar {
* @param {Date} [startDate] The event start date * @param {Date} [startDate] The event start date
* @param {Date} [endDate] The event end date * @param {Date} [endDate] The event end date
* @param {CalendarOptions} [options] Additional options, see `getCalendarOptions` * @param {CalendarOptions} [options] Additional options, see `getCalendarOptions`
* @return Returns a Promise * @returns {Promise<any>} Returns a Promise
*/ */
@Cordova() @Cordova()
static createEventWithOptions( static createEventWithOptions(
@ -190,7 +190,7 @@ export class Calendar {
* @param {string} [notes] The event notes * @param {string} [notes] The event notes
* @param {Date} [startDate] The event start date * @param {Date} [startDate] The event start date
* @param {Date} [endDate] The event end date * @param {Date} [endDate] The event end date
* @return Returns a Promise * @returns {Promise<any>} Returns a Promise
*/ */
@Cordova() @Cordova()
static createEventInteractively( static createEventInteractively(
@ -210,7 +210,7 @@ export class Calendar {
* @param {Date} [startDate] The event start date * @param {Date} [startDate] The event start date
* @param {Date} [endDate] The event end date * @param {Date} [endDate] The event end date
* @param {CalendarOptions} [options] Additional options, see `getCalendarOptions` * @param {CalendarOptions} [options] Additional options, see `getCalendarOptions`
* @return Returns a Promise * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static createEventInteractivelyWithOptions( static createEventInteractivelyWithOptions(
@ -241,7 +241,7 @@ export class Calendar {
* @param {string} [notes] The event notes * @param {string} [notes] The event notes
* @param {Date} [startDate] The event start date * @param {Date} [startDate] The event start date
* @param {Date} [endDate] The event end date * @param {Date} [endDate] The event end date
* @return Returns a Promise * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static findEvent( static findEvent(
@ -260,7 +260,7 @@ export class Calendar {
* @param {Date} [startDate] The event start date * @param {Date} [startDate] The event start date
* @param {Date} [endDate] The event end date * @param {Date} [endDate] The event end date
* @param {CalendarOptions} [options] Additional options, see `getCalendarOptions` * @param {CalendarOptions} [options] Additional options, see `getCalendarOptions`
* @return Returns a Promise that resolves with the event, or rejects with an error. * @returns {Promise<any>} Returns a Promise that resolves with the event, or rejects with an error.
*/ */
@Cordova() @Cordova()
static findEventWithOptions( static findEventWithOptions(
@ -277,21 +277,21 @@ export class Calendar {
* *
* @param {Date} [startDate] The start date * @param {Date} [startDate] The start date
* @param {Date} [endDate] The end date * @param {Date} [endDate] The end date
* @return Returns a Promise that resolves with the list of events, or rejects with an error. * @returns {Promise<any>} Returns a Promise that resolves with the list of events, or rejects with an error.
*/ */
@Cordova() @Cordova()
static listEventsInRange(startDate: Date, endDate: Date): Promise<any> { return; } static listEventsInRange(startDate: Date, endDate: Date): Promise<any> { return; }
/** /**
* Get a list of all calendars. * Get a list of all calendars.
* @return A Promise that resolves with the list of calendars, or rejects with an error. * @returns {Promise<any>} A Promise that resolves with the list of calendars, or rejects with an error.
*/ */
@Cordova() @Cordova()
static listCalendars(): Promise<any> { return; } static listCalendars(): Promise<any> { return; }
/** /**
* Get a list of all future events in the specified calendar. (iOS only) * Get a list of all future events in the specified calendar. (iOS only)
* @return Returns a Promise that resolves with the list of events, or rejects with an error. * @returns {Promise<any>} Returns a Promise that resolves with the list of events, or rejects with an error.
*/ */
@Cordova() @Cordova()
static findAllEventsInNamedCalendar(calendarName: string): Promise<any> { return; } static findAllEventsInNamedCalendar(calendarName: string): Promise<any> { return; }

1
src/plugins/call-number.ts
View File

@ -27,6 +27,7 @@ export class CallNumber {
* Calls a phone number * Calls a phone number
* @param numberToCall {string} The phone number to call as a string * @param numberToCall {string} The phone number to call as a string
* @param bypassAppChooser {boolean} Set to true to bypass the app chooser and go directly to dialer * @param bypassAppChooser {boolean} Set to true to bypass the app chooser and go directly to dialer
* @return {Promise<any>}
*/ */
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'

3
src/plugins/camera-preview.ts
View File

@ -40,7 +40,7 @@ export interface CameraPreviewSize {
* 'front', // default camera * 'front', // default camera
* true, // tap to take picture * true, // tap to take picture
* false, // disable drag * false, // disable drag
* false, // Keep preview in front. Set to false (back of the screen) to apply overlaying elements * false, // keep preview in front. Set to true (back of the screen) to apply overlaying elements
* 1 // set the preview alpha * 1 // set the preview alpha
* ); * );
* *
@ -111,6 +111,7 @@ export class CameraPreview {
/** /**
* Register a callback function that receives the original picture and the image captured from the preview box. * Register a callback function that receives the original picture and the image captured from the preview box.
* @returns {Observable<any>}
*/ */
@Cordova({ @Cordova({
observable: true observable: true

10
src/plugins/camera.ts
View File

@ -56,8 +56,8 @@ export interface CameraOptions {
/** /**
* Choose the camera to use (front- or back-facing). * Choose the camera to use (front- or back-facing).
* Defined in Camera.Direction. Default is BACK. * Defined in Camera.Direction. Default is BACK.
* FRONT: 0 * BACK: 0
* BACK: 1 * FRONT: 1
*/ */
cameraDirection?: number; cameraDirection?: number;
/** iOS-only options that specify popover location in iPad. Defined in CameraPopoverOptions. */ /** iOS-only options that specify popover location in iPad. Defined in CameraPopoverOptions. */
@ -192,8 +192,8 @@ export class Camera {
/** /**
* Take a picture or video, or load one from the library. * Take a picture or video, or load one from the library.
* @param {CameraOptions?} options Options that you want to pass to the camera. Encoding type, quality, etc. Optional * @param {CameraOptions?} options optional. Options that you want to pass to the camera. Encoding type, quality, etc. Platform-specific quirks are described in the [Cordova plugin docs](https://github.com/apache/cordova-plugin-camera#cameraoptions-errata-).
* @return {Promise} Returns a Promise that resolves with Base64 encoding of the image data, or the image file URI, depending on cameraOptions, otherwise rejects with an error. * @returns {Promise<any>} Returns a Promise that resolves with Base64 encoding of the image data, or the image file URI, depending on cameraOptions, otherwise rejects with an error.
*/ */
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'
@ -203,7 +203,7 @@ export class Camera {
/** /**
* Remove intermediate image files that are kept in temporary storage after calling camera.getPicture. * Remove intermediate image files that are kept in temporary storage after calling camera.getPicture.
* Applies only when the value of Camera.sourceType equals Camera.PictureSourceType.CAMERA and the Camera.destinationType equals Camera.DestinationType.FILE_URI. * Applies only when the value of Camera.sourceType equals Camera.PictureSourceType.CAMERA and the Camera.destinationType equals Camera.DestinationType.FILE_URI.
* @return Returns a Promise * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
platforms: ['iOS'] platforms: ['iOS']

3
src/plugins/card-io.ts
View File

@ -36,6 +36,7 @@ export class CardIO {
* Check whether card scanning is currently available. (May vary by * Check whether card scanning is currently available. (May vary by
* device, OS version, network connectivity, etc.) * device, OS version, network connectivity, etc.)
* *
* @returns {Promise<boolean>}
*/ */
@Cordova() @Cordova()
static canScan(): Promise<boolean> { return; } static canScan(): Promise<boolean> { return; }
@ -43,12 +44,14 @@ export class CardIO {
/** /**
* Scan a credit card with card.io. * Scan a credit card with card.io.
* @param {CardIOOptions} options Options for configuring the plugin * @param {CardIOOptions} options Options for configuring the plugin
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static scan(options?: CardIOOptions): Promise<CardIOResponse> { return; } static scan(options?: CardIOOptions): Promise<CardIOResponse> { return; }
/** /**
* Retrieve the version of the card.io library. Useful when contacting support. * Retrieve the version of the card.io library. Useful when contacting support.
* @returns {Promise<string>}
*/ */
@Cordova() @Cordova()
static version(): Promise<string> { return; } static version(): Promise<string> { return; }

4
src/plugins/clipboard.ts
View File

@ -39,14 +39,14 @@ export class Clipboard {
/** /**
* Copies the given text * Copies the given text
* @param {string} text Text that gets copied on the system clipboard * @param {string} text Text that gets copied on the system clipboard
* @returns {Promise<T>} Returns a promise after the text has been copied * @returns {Promise<any>} Returns a promise after the text has been copied
*/ */
@Cordova() @Cordova()
static copy(text: string): Promise<any> { return; } static copy(text: string): Promise<any> { return; }
/** /**
* Pastes the text stored in clipboard * Pastes the text stored in clipboard
* @returns {Promise<T>} Returns a promise after the text has been pasted * @returns {Promise<any>} Returns a promise after the text has been pasted
*/ */
@Cordova() @Cordova()
static paste(): Promise<any> { return; } static paste(): Promise<any> { return; }

6
src/plugins/code-push.ts
View File

@ -433,6 +433,7 @@ export class CodePush {
* *
* @param packageSuccess Callback invoked with the currently deployed package information. * @param packageSuccess Callback invoked with the currently deployed package information.
* @param packageError Optional callback invoked in case of an error. * @param packageError Optional callback invoked in case of an error.
* @returns {Promise<ILocalPackage>}
*/ */
@Cordova() @Cordova()
static getCurrentPackage(): Promise<ILocalPackage> { static getCurrentPackage(): Promise<ILocalPackage> {
@ -442,6 +443,7 @@ export class CodePush {
/** /**
* Gets the pending package information, if any. A pending package is one that has been installed but the application still runs the old code. * Gets the pending package information, if any. A pending package is one that has been installed but the application still runs the old code.
* This happends only after a package has been installed using ON_NEXT_RESTART or ON_NEXT_RESUME mode, but the application was not restarted/resumed yet. * This happends only after a package has been installed using ON_NEXT_RESTART or ON_NEXT_RESUME mode, but the application was not restarted/resumed yet.
* @returns {Promise<ILocalPackage>}
*/ */
@Cordova() @Cordova()
static getPendingPackage(): Promise<ILocalPackage> { static getPendingPackage(): Promise<ILocalPackage> {
@ -456,6 +458,7 @@ export class CodePush {
* A null package means the application is up to date for the current native application version. * A null package means the application is up to date for the current native application version.
* @param queryError Optional callback invoked in case of an error. * @param queryError Optional callback invoked in case of an error.
* @param deploymentKey Optional deployment key that overrides the config.xml setting. * @param deploymentKey Optional deployment key that overrides the config.xml setting.
* @returns {Promise<IRemotePackage>}
*/ */
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'
@ -471,6 +474,7 @@ export class CodePush {
* *
* @param notifySucceeded Optional callback invoked if the plugin was successfully notified. * @param notifySucceeded Optional callback invoked if the plugin was successfully notified.
* @param notifyFailed Optional callback invoked in case of an error during notifying the plugin. * @param notifyFailed Optional callback invoked in case of an error during notifying the plugin.
* @returns {Promise<void>}
*/ */
@Cordova() @Cordova()
static notifyApplicationReady(): Promise<void> { static notifyApplicationReady(): Promise<void> {
@ -480,6 +484,7 @@ export class CodePush {
/** /**
* Reloads the application. If there is a pending update package installed using ON_NEXT_RESTART or ON_NEXT_RESUME modes, the update * Reloads the application. If there is a pending update package installed using ON_NEXT_RESTART or ON_NEXT_RESUME modes, the update
* will be immediately visible to the user. Otherwise, calling this function will simply reload the current version of the application. * will be immediately visible to the user. Otherwise, calling this function will simply reload the current version of the application.
* @returns {Promise<void>}
*/ */
@Cordova() @Cordova()
static restartApplication(): Promise<void> { static restartApplication(): Promise<void> {
@ -504,6 +509,7 @@ export class CodePush {
* @param syncCallback Optional callback to be called with the status of the sync operation. * @param syncCallback Optional callback to be called with the status of the sync operation.
* @param syncOptions Optional SyncOptions parameter configuring the behavior of the sync operation. * @param syncOptions Optional SyncOptions parameter configuring the behavior of the sync operation.
* @param downloadProgress Optional callback invoked during the download process. It is called several times with one DownloadProgress parameter. * @param downloadProgress Optional callback invoked during the download process. It is called several times with one DownloadProgress parameter.
* @returns {Observable<SyncStatus>}
* *
*/ */
@Cordova({ @Cordova({

6
src/plugins/contacts.ts
View File

@ -324,7 +324,7 @@ export class ContactFindOptions implements IContactFindOptions {
export class Contacts { export class Contacts {
/** /**
* Create a single contact. * Create a single contact.
* @return Returns a object Contact * @returns {Contact} Returns a Contact object
*/ */
static create(): Contact { static create(): Contact {
return new Contact(); return new Contact();
@ -342,7 +342,7 @@ export class Contacts {
* desiredFields: Contact fields to be returned back. If specified, the resulting Contact object only features values for these fields. (DOMString[]) [Optional] * desiredFields: Contact fields to be returned back. If specified, the resulting Contact object only features values for these fields. (DOMString[]) [Optional]
* hasPhoneNumber(Android only): Filters the search to only return contacts with a phone number informed. (Boolean) (Default: false) * hasPhoneNumber(Android only): Filters the search to only return contacts with a phone number informed. (Boolean) (Default: false)
* *
* @return Returns a Promise that resolves with the search results (an array of Contact objects) * @returns {Promise<any>} Returns a Promise that resolves with the search results (an array of Contact objects)
*/ */
@Cordova({ @Cordova({
successIndex: 1, successIndex: 1,
@ -352,7 +352,7 @@ export class Contacts {
/** /**
* Select a single Contact. * Select a single Contact.
* @return Returns a Promise that resolves with the selected Contact * @returns {Promise<any>} Returns a Promise that resolves with the selected Contact
*/ */
@Cordova() @Cordova()
static pickContact(): Promise<any> { return; } static pickContact(): Promise<any> { return; }

2
src/plugins/crop.ts
View File

@ -26,7 +26,7 @@ export class Crop {
* Crops an image * Crops an image
* @param pathToImage * @param pathToImage
* @param options * @param options
* @return {Promise<string>} Returns a promise that resolves with the new image path, or rejects if failed to crop. * @returns {Promise<string>} Returns a promise that resolves with the new image path, or rejects if failed to crop.
*/ */
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'

6
src/plugins/dbmeter.ts
View File

@ -41,7 +41,7 @@ export class DBMeter {
/** /**
* Starts listening * Starts listening
* @return {Observable<string>} Returns an observable. Subscribe to start listening. Unsubscribe to stop listening. * @returns {Observable<any>} Returns an observable. Subscribe to start listening. Unsubscribe to stop listening.
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -58,14 +58,14 @@ export class DBMeter {
/** /**
* Check if the DB Meter is listening * Check if the DB Meter is listening
* @return {Promise<boolean>} Returns a promise that resolves with a boolean that tells us whether the DB meter is listening * @returns {Promise<boolean>} Returns a promise that resolves with a boolean that tells us whether the DB meter is listening
*/ */
@Cordova() @Cordova()
static isListening(): Promise<boolean> { return; } static isListening(): Promise<boolean> { return; }
/** /**
* Delete the DB Meter instance * Delete the DB Meter instance
* @return {Promise<any>} Returns a promise that will resolve if the instance has been deleted, and rejects if errors occur. * @returns {Promise<any>} Returns a promise that will resolve if the instance has been deleted, and rejects if errors occur.
*/ */
@Cordova() @Cordova()
static delete(): Promise<any> { return; } static delete(): Promise<any> { return; }

4
src/plugins/deeplinks.ts
View File

@ -75,7 +75,7 @@ export class Deeplinks {
* paths takes an object of the form { 'path': data }. If a deeplink * paths takes an object of the form { 'path': data }. If a deeplink
* matches the path, the resulting path-data pair will be returned in the * matches the path, the resulting path-data pair will be returned in the
* promise result which you can then use to navigate in the app as you see fit. * promise result which you can then use to navigate in the app as you see fit.
* @returns {Observable} Returns an Observable that is called each time a deeplink comes through, and * @returns {Observable<DeeplinkMatch>} Returns an Observable that is called each time a deeplink comes through, and
* errors if a deeplink comes through that does not match a given path. * errors if a deeplink comes through that does not match a given path.
*/ */
@Cordova({ @Cordova({
@ -98,7 +98,7 @@ export class Deeplinks {
* matches the path, the resulting path-data pair will be returned in the * matches the path, the resulting path-data pair will be returned in the
* promise result which you can then use to navigate in the app as you see fit. * promise result which you can then use to navigate in the app as you see fit.
* *
* @returns {Observable} Returns an Observable that resolves each time a deeplink comes through, and * @returns {Observable<DeeplinkMatch} Returns an Observable that resolves each time a deeplink comes through, and
* errors if a deeplink comes through that does not match a given path. * errors if a deeplink comes through that does not match a given path.
*/ */
@Cordova({ @Cordova({

1
src/plugins/device-feedback.ts
View File

@ -48,6 +48,7 @@ export class DeviceFeedback {
/** /**
* Check if haptic and acoustic feedback is enabled by user settings. * Check if haptic and acoustic feedback is enabled by user settings.
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static isFeedbackEnabled(): Promise<{ haptic: boolean; acoustic: boolean; }> { return; } static isFeedbackEnabled(): Promise<{ haptic: boolean; acoustic: boolean; }> { return; }

4
src/plugins/device.ts
View File

@ -51,9 +51,9 @@ export class Device {
/** /**
* Returns the whole device object. * Returns the whole device object.
* *
* @returns {Object} The device object. * @returns {Device} The device object.
*/ */
@CordovaProperty @CordovaProperty
static get device() { return window.device; } static get device(): Device { return window.device; }
} }

4
src/plugins/deviceaccounts.ts
View File

@ -12,24 +12,28 @@ export class DeviceAccounts {
/** /**
* Gets all accounts registered on the Android Device * Gets all accounts registered on the Android Device
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static get(): Promise<any> { return; } static get(): Promise<any> { return; }
/** /**
* Get all accounts registered on Android device for requested type * Get all accounts registered on Android device for requested type
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static getByType(type: string): Promise<any> { return; } static getByType(type: string): Promise<any> { return; }
/** /**
* Get all emails registered on Android device (accounts with 'com.google' type) * Get all emails registered on Android device (accounts with 'com.google' type)
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static getEmails(): Promise<any> { return; } static getEmails(): Promise<any> { return; }
/** /**
* Get the first email registered on Android device * Get the first email registered on Android device
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static getEmail(): Promise<any> { return; } static getEmail(): Promise<any> { return; }

2
src/plugins/devicemotion.ts
View File

@ -71,7 +71,7 @@ export class DeviceMotion {
/** /**
* Get the current acceleration along the x, y, and z axes. * Get the current acceleration along the x, y, and z axes.
* @returns {Promise<any>} Returns object with x, y, z, and timestamp properties * @returns {Promise<AccelerationData>} Returns object with x, y, z, and timestamp properties
*/ */
@Cordova() @Cordova()
static getCurrentAcceleration(): Promise<AccelerationData> { return; } static getCurrentAcceleration(): Promise<AccelerationData> { return; }

9
src/plugins/diagnostic.ts
View File

@ -174,6 +174,7 @@ export class Diagnostic {
* Enables/disables WiFi on the device. * Enables/disables WiFi on the device.
* Requires `ACCESS_WIFI_STATE` and `CHANGE_WIFI_STATE` permissions on Android * Requires `ACCESS_WIFI_STATE` and `CHANGE_WIFI_STATE` permissions on Android
* @param state {boolean} * @param state {boolean}
* @returns {Promise<any>}
*/ */
@Cordova({ callbackOrder: 'reverse', platforms: ['Android', 'Windows 10'] }) @Cordova({ callbackOrder: 'reverse', platforms: ['Android', 'Windows 10'] })
static setWifiState(state: boolean): Promise<any> { return; } static setWifiState(state: boolean): Promise<any> { return; }
@ -182,6 +183,7 @@ export class Diagnostic {
* Enables/disables Bluetooth on the device. * Enables/disables Bluetooth on the device.
* Requires `BLUETOOTH` and `BLUETOOTH_ADMIN` permissions on Android * Requires `BLUETOOTH` and `BLUETOOTH_ADMIN` permissions on Android
* @param state {boolean} * @param state {boolean}
* @returns {Promise<any>}
*/ */
@Cordova({ callbackOrder: 'reverse', platforms: ['Android', 'Windows 10'] }) @Cordova({ callbackOrder: 'reverse', platforms: ['Android', 'Windows 10'] })
static setBluetoothState(state: boolean): Promise<any> { return; } static setBluetoothState(state: boolean): Promise<any> { return; }
@ -297,7 +299,7 @@ export class Diagnostic {
* *
* Notes for iOS: * Notes for iOS:
* - This relates to Calendar Events (not Calendar Reminders) * - This relates to Calendar Events (not Calendar Reminders)
* @returns {Promise<any>} * @returns {Promise<boolean>}
*/ */
@Cordova({ platforms: ['Android', 'iOS'] }) @Cordova({ platforms: ['Android', 'iOS'] })
static isCalendarAuthorized(): Promise<boolean> { return; } static isCalendarAuthorized(): Promise<boolean> { return; }
@ -366,7 +368,7 @@ export class Diagnostic {
/** /**
* Checks if high-accuracy locations are available to the app from GPS hardware. * Checks if high-accuracy locations are available to the app from GPS hardware.
* Returns true if Location mode is enabled and is set to "Device only" or "High accuracy" AND if the app is authorised to use location. * Returns true if Location mode is enabled and is set to "Device only" or "High accuracy" AND if the app is authorised to use location.
* @returns {Promise<any>} * @returns {Promise<boolean>}
*/ */
@Cordova({ platforms: ['Android'] }) @Cordova({ platforms: ['Android'] })
static isGpsLocationAvailable(): Promise<boolean> { return; } static isGpsLocationAvailable(): Promise<boolean> { return; }
@ -376,6 +378,7 @@ export class Diagnostic {
* Returns true if Location mode is enabled and is set to either: * Returns true if Location mode is enabled and is set to either:
* - Device only = GPS hardware only (high accuracy) * - Device only = GPS hardware only (high accuracy)
* - High accuracy = GPS hardware, network triangulation and Wifi network IDs (high and low accuracy) * - High accuracy = GPS hardware, network triangulation and Wifi network IDs (high and low accuracy)
* @returns {Promise<any>}
*/ */
@Cordova({ platforms: ['Android'] }) @Cordova({ platforms: ['Android'] })
static isGpsLocationEnabled(): Promise<any> { return; } static isGpsLocationEnabled(): Promise<any> { return; }
@ -446,7 +449,7 @@ export class Diagnostic {
* Note that only one request can be made concurrently because the native API cannot handle concurrent requests, * Note that only one request can be made concurrently because the native API cannot handle concurrent requests,
* so the plugin will invoke the error callback if attempting to make more than one simultaneous request. * so the plugin will invoke the error callback if attempting to make more than one simultaneous request.
* Multiple permission requests should be grouped into a single call since the native API is setup to handle batch requests of multiple permission groups. * Multiple permission requests should be grouped into a single call since the native API is setup to handle batch requests of multiple permission groups.
* @return {boolean} * @returns {boolean}
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
static isRequestingPermission(): boolean { return; } static isRequestingPermission(): boolean { return; }

2
src/plugins/emailcomposer.ts
View File

@ -56,7 +56,7 @@ export class EmailComposer {
* Verifies if sending emails is supported on the device. * Verifies if sending emails is supported on the device.
* *
* @param app {string?} An optional app id or uri scheme. * @param app {string?} An optional app id or uri scheme.
* @returns {Promise<boolean>} Resolves if available, rejects if not available * @returns {Promise<any>} Resolves if available, rejects if not available
*/ */
static isAvailable(app?: string): Promise<any> { static isAvailable(app?: string): Promise<any> {
return new Promise<boolean>((resolve, reject) => { return new Promise<boolean>((resolve, reject) => {

46
src/plugins/estimote-beacons.ts
View File

@ -88,7 +88,7 @@ export class EstimoteBeacons {
* ``` * ```
* *
* @see {@link https://community.estimote.com/hc/en-us/articles/203393036-Estimote-SDK-and-iOS-8-Location-Services|Estimote SDK and iOS 8 Location Services} * @see {@link https://community.estimote.com/hc/en-us/articles/203393036-Estimote-SDK-and-iOS-8-Location-Services|Estimote SDK and iOS 8 Location Services}
* @return Returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static requestWhenInUseAuthorization(): Promise<any> { return; } static requestWhenInUseAuthorization(): Promise<any> { return; }
@ -109,7 +109,7 @@ export class EstimoteBeacons {
* ``` * ```
* *
* @see {@link https://community.estimote.com/hc/en-us/articles/203393036-Estimote-SDK-and-iOS-8-Location-Services|Estimote SDK and iOS 8 Location Services} * @see {@link https://community.estimote.com/hc/en-us/articles/203393036-Estimote-SDK-and-iOS-8-Location-Services|Estimote SDK and iOS 8 Location Services}
* @return Returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static requestAlwaysAuthorization(): Promise<any> { return; } static requestAlwaysAuthorization(): Promise<any> { return; }
@ -128,7 +128,7 @@ export class EstimoteBeacons {
* ``` * ```
* *
* @see {@link https://community.estimote.com/hc/en-us/articles/203393036-Estimote-SDK-and-iOS-8-Location-Services|Estimote SDK and iOS 8 Location Services} * @see {@link https://community.estimote.com/hc/en-us/articles/203393036-Estimote-SDK-and-iOS-8-Location-Services|Estimote SDK and iOS 8 Location Services}
* @return Returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static authorizationStatus(): Promise<any> { return; } static authorizationStatus(): Promise<any> { return; }
@ -148,7 +148,7 @@ export class EstimoteBeacons {
* @param major {number} Major value to advertise (mandatory). * @param major {number} Major value to advertise (mandatory).
* @param minor {number} Minor value to advertise (mandatory). * @param minor {number} Minor value to advertise (mandatory).
* @param regionId {string} Identifier of the region used to advertise (mandatory). * @param regionId {string} Identifier of the region used to advertise (mandatory).
* @return Returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
clearFunction: 'stopAdvertisingAsBeacon' clearFunction: 'stopAdvertisingAsBeacon'
@ -166,7 +166,7 @@ export class EstimoteBeacons {
* EstimoteBeacons.stopAdvertisingAsBeacon().then((result) => { console.log('Beacon stopped'); }); * EstimoteBeacons.stopAdvertisingAsBeacon().then((result) => { console.log('Beacon stopped'); });
* }, 5000); * }, 5000);
* ``` * ```
* @return Returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static stopAdvertisingAsBeacon(): Promise<any> { return; } static stopAdvertisingAsBeacon(): Promise<any> { return; }
@ -181,7 +181,7 @@ export class EstimoteBeacons {
* EstimoteBeacons.enableAnalytics(true).then(() => { console.log('Analytics enabled'); }); * EstimoteBeacons.enableAnalytics(true).then(() => { console.log('Analytics enabled'); });
* ``` * ```
* @param enable {number} Boolean value to turn analytics on or off (mandatory). * @param enable {number} Boolean value to turn analytics on or off (mandatory).
* @return Returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static enableAnalytics(enable: boolean): Promise<any> { return; } static enableAnalytics(enable: boolean): Promise<any> { return; }
@ -195,7 +195,7 @@ export class EstimoteBeacons {
* ``` * ```
* EstimoteBeacons.isAnalyticsEnabled().then((enabled) => { console.log('Analytics enabled: ' + enabled); }); * EstimoteBeacons.isAnalyticsEnabled().then((enabled) => { console.log('Analytics enabled: ' + enabled); });
* ``` * ```
* @return Returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static isAnalyticsEnabled(): Promise<any> { return; } static isAnalyticsEnabled(): Promise<any> { return; }
@ -209,7 +209,7 @@ export class EstimoteBeacons {
* ``` * ```
* EstimoteBeacons.isAuthorized().then((isAuthorized) => { console.log('App ID and App Token is set: ' + isAuthorized); }); * EstimoteBeacons.isAuthorized().then((isAuthorized) => { console.log('App ID and App Token is set: ' + isAuthorized); });
* ``` * ```
* @return Returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static isAuthorized(): Promise<any> { return; } static isAuthorized(): Promise<any> { return; }
@ -225,7 +225,7 @@ export class EstimoteBeacons {
* ``` * ```
* @param appID {string} The App ID (mandatory). * @param appID {string} The App ID (mandatory).
* @param appToken {string} The App Token (mandatory). * @param appToken {string} The App Token (mandatory).
* @return Returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static setupAppIDAndAppToken(appID: string, appToken: string): Promise<any> { return; } static setupAppIDAndAppToken(appID: string, appToken: string): Promise<any> { return; }
@ -243,7 +243,7 @@ export class EstimoteBeacons {
* EstimoteBeacons.stopEstimoteBeaconDiscovery().then(() => { console.log('scan stopped'); }); * EstimoteBeacons.stopEstimoteBeaconDiscovery().then(() => { console.log('scan stopped'); });
* }, 5000); * }, 5000);
* ``` * ```
* @return Returns an Observable that notifies of each beacon discovered. * @returns {Observable<any>} Returns an Observable that notifies of each beacon discovered.
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -263,7 +263,7 @@ export class EstimoteBeacons {
* EstimoteBeacons.stopEstimoteBeaconDiscovery().then(() => { console.log('scan stopped'); }); * EstimoteBeacons.stopEstimoteBeaconDiscovery().then(() => { console.log('scan stopped'); });
* }, 5000); * }, 5000);
* ``` * ```
* @return returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static stopEstimoteBeaconDiscovery(): Promise<any> { return; } static stopEstimoteBeaconDiscovery(): Promise<any> { return; }
@ -282,7 +282,7 @@ export class EstimoteBeacons {
* }, 5000); * }, 5000);
* ``` * ```
* @param region {EstimoteBeaconRegion} Dictionary with region properties (mandatory). * @param region {EstimoteBeaconRegion} Dictionary with region properties (mandatory).
* @return Returns an Observable that notifies of each beacon discovered. * @returns {Observable<any>} Returns an Observable that notifies of each beacon discovered.
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -305,7 +305,7 @@ export class EstimoteBeacons {
* }, 5000); * }, 5000);
* ``` * ```
* @param region {EstimoteBeaconRegion} Dictionary with region properties (mandatory). * @param region {EstimoteBeaconRegion} Dictionary with region properties (mandatory).
* @return returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static stopRangingBeaconsInRegion(region: EstimoteBeaconRegion): Promise<any> { return; } static stopRangingBeaconsInRegion(region: EstimoteBeaconRegion): Promise<any> { return; }
@ -316,6 +316,7 @@ export class EstimoteBeacons {
* {@link EstimoteBeacons.startRangingBeaconsInRegion}. * {@link EstimoteBeacons.startRangingBeaconsInRegion}.
* To use secure beacons set the App ID and App Token using * To use secure beacons set the App ID and App Token using
* {@link EstimoteBeacons.setupAppIDAndAppToken}. * {@link EstimoteBeacons.setupAppIDAndAppToken}.
* @returns {Observable<any>}
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -328,6 +329,7 @@ export class EstimoteBeacons {
* Stop ranging secure beacons. Available on iOS. * Stop ranging secure beacons. Available on iOS.
* This function has the same parameters/behaviour as * This function has the same parameters/behaviour as
* {@link EstimoteBeacons.stopRangingBeaconsInRegion}. * {@link EstimoteBeacons.stopRangingBeaconsInRegion}.
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static stopRangingSecureBeaconsInRegion(region: EstimoteBeaconRegion): Promise<any> { return; } static stopRangingSecureBeaconsInRegion(region: EstimoteBeaconRegion): Promise<any> { return; }
@ -347,7 +349,7 @@ export class EstimoteBeacons {
* are inside a region when the user turns display on, see * are inside a region when the user turns display on, see
* {@link https://developer.apple.com/library/prerelease/ios/documentation/CoreLocation/Reference/CLBeaconRegion_class/index.html#//apple_ref/occ/instp/CLBeaconRegion/notifyEntryStateOnDisplay|iOS documentation} * {@link https://developer.apple.com/library/prerelease/ios/documentation/CoreLocation/Reference/CLBeaconRegion_class/index.html#//apple_ref/occ/instp/CLBeaconRegion/notifyEntryStateOnDisplay|iOS documentation}
* for further details (optional, defaults to false, iOS only). * for further details (optional, defaults to false, iOS only).
* @return Returns an Observable that notifies of each region state discovered. * @returns {Observable<any>} Returns an Observable that notifies of each region state discovered.
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -367,7 +369,7 @@ export class EstimoteBeacons {
* EstimoteBeacons.stopMonitoringForRegion(region).then(() => { console.log('monitoring is stopped'); }); * EstimoteBeacons.stopMonitoringForRegion(region).then(() => { console.log('monitoring is stopped'); });
* ``` * ```
* @param region {EstimoteBeaconRegion} Dictionary with region properties (mandatory). * @param region {EstimoteBeaconRegion} Dictionary with region properties (mandatory).
* @return returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static stopMonitoringForRegion(region: EstimoteBeaconRegion): Promise<any> { return; } static stopMonitoringForRegion(region: EstimoteBeaconRegion): Promise<any> { return; }
@ -381,6 +383,7 @@ export class EstimoteBeacons {
* @see {@link EstimoteBeacons.startMonitoringForRegion} * @see {@link EstimoteBeacons.startMonitoringForRegion}
* @param region {EstimoteBeaconRegion} Region * @param region {EstimoteBeaconRegion} Region
* @param notifyEntryStateOnDisplay {boolean} * @param notifyEntryStateOnDisplay {boolean}
* @returns {Observable<any>}
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -396,7 +399,8 @@ export class EstimoteBeacons {
* Stop monitoring secure beacons. Available on iOS. * Stop monitoring secure beacons. Available on iOS.
* This function has the same parameters/behaviour as * This function has the same parameters/behaviour as
* {@link EstimoteBeacons.stopMonitoringForRegion}. * {@link EstimoteBeacons.stopMonitoringForRegion}.
* @param region {EstimoteBeaconRegion} Region * @param region {EstimoteBeaconRegion} Region
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static stopSecureMonitoringForRegion(region: EstimoteBeaconRegion): Promise<any> { return; } static stopSecureMonitoringForRegion(region: EstimoteBeaconRegion): Promise<any> { return; }
@ -416,7 +420,7 @@ export class EstimoteBeacons {
* }); * });
* ``` * ```
* @param beacon {Beacon} Beacon to connect to. * @param beacon {Beacon} Beacon to connect to.
* @return returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static connectToBeacon(beacon: any): Promise<any> { return; } static connectToBeacon(beacon: any): Promise<any> { return; }
@ -428,7 +432,7 @@ export class EstimoteBeacons {
* ``` * ```
* EstimoteBeacons.disconnectConnectedBeacon(); * EstimoteBeacons.disconnectConnectedBeacon();
* ``` * ```
* @return returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static disconnectConnectedBeacon(): Promise<any> { return; } static disconnectConnectedBeacon(): Promise<any> { return; }
@ -442,7 +446,7 @@ export class EstimoteBeacons {
* EstimoteBeacons.writeConnectedProximityUUID(ESTIMOTE_PROXIMITY_UUID); * EstimoteBeacons.writeConnectedProximityUUID(ESTIMOTE_PROXIMITY_UUID);
* *
* @param uuid {string} String to write as new UUID * @param uuid {string} String to write as new UUID
* @return returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static writeConnectedProximityUUID(uuid: any): Promise<any> { return; } static writeConnectedProximityUUID(uuid: any): Promise<any> { return; }
@ -456,7 +460,7 @@ export class EstimoteBeacons {
* EstimoteBeacons.writeConnectedMajor(1); * EstimoteBeacons.writeConnectedMajor(1);
* *
* @param major {number} number to write as new major * @param major {number} number to write as new major
* @return returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static writeConnectedMajor(major: number): Promise<any> { return; } static writeConnectedMajor(major: number): Promise<any> { return; }
@ -470,7 +474,7 @@ export class EstimoteBeacons {
* EstimoteBeacons.writeConnectedMinor(1); * EstimoteBeacons.writeConnectedMinor(1);
* *
* @param minor {number} number to write as new minor * @param minor {number} number to write as new minor
* @return returns a Promise. * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static writeConnectedMinor(minor: number): Promise<any> { return; } static writeConnectedMinor(minor: number): Promise<any> { return; }

21
src/plugins/facebook.ts
View File

@ -90,6 +90,7 @@ export class Facebook {
* Browser wrapper * Browser wrapper
* @param {number} appId Your Facebook AppID from their dashboard * @param {number} appId Your Facebook AppID from their dashboard
* @param {string} version The version of API you may want to use. Optional * @param {string} version The version of API you may want to use. Optional
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static browserInit(appId: number, version?: string): Promise<any> { static browserInit(appId: number, version?: string): Promise<any> {
@ -114,7 +115,7 @@ export class Facebook {
* ``` * ```
* *
* @param {string[]} permissions List of [permissions](https://developers.facebook.com/docs/facebook-login/permissions) this app has upon logging in. * @param {string[]} permissions List of [permissions](https://developers.facebook.com/docs/facebook-login/permissions) this app has upon logging in.
* @return {Promise<FacebookLoginResponse>} Returns a Promise that resolves with a status object if login succeeds, and rejects if login fails. * @returns {Promise<FacebookLoginResponse>} Returns a Promise that resolves with a status object if login succeeds, and rejects if login fails.
*/ */
@Cordova() @Cordova()
static login(permissions: string[]): Promise<FacebookLoginResponse> { return; } static login(permissions: string[]): Promise<FacebookLoginResponse> { return; }
@ -123,7 +124,7 @@ export class Facebook {
* Logout of Facebook. * Logout of Facebook.
* *
* For more info see the [Facebook docs](https://developers.facebook.com/docs/reference/javascript/FB.logout) * For more info see the [Facebook docs](https://developers.facebook.com/docs/reference/javascript/FB.logout)
* @return Returns a Promise that resolves on a successful logout, and rejects if logout fails. * @returns {Promise<any>} Returns a Promise that resolves on a successful logout, and rejects if logout fails.
*/ */
@Cordova() @Cordova()
static logout(): Promise<any> { return; } static logout(): Promise<any> { return; }
@ -152,7 +153,7 @@ export class Facebook {
* *
* For more information see the [Facebook docs](https://developers.facebook.com/docs/reference/javascript/FB.getLoginStatus) * For more information see the [Facebook docs](https://developers.facebook.com/docs/reference/javascript/FB.getLoginStatus)
* *
* @return Returns a Promise that resolves with a status, or rejects with an error * @returns {Promise<any>} Returns a Promise that resolves with a status, or rejects with an error
*/ */
@Cordova() @Cordova()
static getLoginStatus(): Promise<any> { return; } static getLoginStatus(): Promise<any> { return; }
@ -160,7 +161,7 @@ export class Facebook {
/** /**
* Get a Facebook access token for using Facebook services. * Get a Facebook access token for using Facebook services.
* *
* @return Returns a Promise that resolves with an access token, or rejects with an error * @returns {Promise<string>} Returns a Promise that resolves with an access token, or rejects with an error
*/ */
@Cordova() @Cordova()
static getAccessToken(): Promise<string> { return; } static getAccessToken(): Promise<string> { return; }
@ -179,8 +180,8 @@ export class Facebook {
* ``` * ```
* *
* For more options see the [Cordova plugin docs](https://github.com/jeduan/cordova-plugin-facebook4#show-a-dialog) and the [Facebook docs](https://developers.facebook.com/docs/javascript/reference/FB.ui) * For more options see the [Cordova plugin docs](https://github.com/jeduan/cordova-plugin-facebook4#show-a-dialog) and the [Facebook docs](https://developers.facebook.com/docs/javascript/reference/FB.ui)
* @options {Object} options The dialog options * @param {Object} options The dialog options
* @return Returns a Promise that resolves with success data, or rejects with an error * @returns {Promise<any>} Returns a Promise that resolves with success data, or rejects with an error
*/ */
@Cordova() @Cordova()
static showDialog(options: any): Promise<any> { return; } static showDialog(options: any): Promise<any> { return; }
@ -196,7 +197,7 @@ export class Facebook {
* *
* @param {string} requestPath Graph API endpoint you want to call * @param {string} requestPath Graph API endpoint you want to call
* @param {string[]} permissions List of [permissions](https://developers.facebook.com/docs/facebook-login/permissions) for this request. * @param {string[]} permissions List of [permissions](https://developers.facebook.com/docs/facebook-login/permissions) for this request.
* @return Returns a Promise that resolves with the result of the request, or rejects with an error * @returns {Promise<any>} Returns a Promise that resolves with the result of the request, or rejects with an error
*/ */
@Cordova() @Cordova()
static api(requestPath: string, permissions: string[]): Promise<any> { return; } static api(requestPath: string, permissions: string[]): Promise<any> { return; }
@ -207,7 +208,7 @@ export class Facebook {
* @param {string} name Name of the event * @param {string} name Name of the event
* @param {Object} [params] An object containing extra data to log with the event * @param {Object} [params] An object containing extra data to log with the event
* @param {number} [valueToSum] any value to be added to added to a sum on each event * @param {number} [valueToSum] any value to be added to added to a sum on each event
* @return * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static logEvent( static logEvent(
@ -221,7 +222,7 @@ export class Facebook {
* *
* @param {number} value Value of the purchase. * @param {number} value Value of the purchase.
* @param {string} currency The currency, as an [ISO 4217 currency code](http://en.wikipedia.org/wiki/ISO_4217) * @param {string} currency The currency, as an [ISO 4217 currency code](http://en.wikipedia.org/wiki/ISO_4217)
* @return Returns a Promise * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static logPurchase(value: number, currency: string): Promise<any> { return; } static logPurchase(value: number, currency: string): Promise<any> { return; }
@ -239,7 +240,7 @@ export class Facebook {
* url: [App Link](https://developers.facebook.com/docs/applinks) to your app * url: [App Link](https://developers.facebook.com/docs/applinks) to your app
* picture: image to be displayed in the App Invite dialog * picture: image to be displayed in the App Invite dialog
* *
* @return Returns a Promise that resolves with the result data, or rejects with an error * @returns {Promise<any>} Returns a Promise that resolves with the result data, or rejects with an error
*/ */
@Cordova() @Cordova()
static appInvite(options: { static appInvite(options: {

1
src/plugins/file-chooser.ts
View File

@ -25,6 +25,7 @@ import { Plugin, Cordova } from './plugin';
export class FileChooser { export class FileChooser {
/** /**
* Open a file * Open a file
* @returns {Promise<string>}
*/ */
@Cordova() @Cordova()
static open(): Promise<string> { return; } static open(): Promise<string> { return; }

3
src/plugins/file-opener.ts
View File

@ -23,6 +23,7 @@ export class FileOpener {
* Open an file * Open an file
* @param filePath {string} File Path * @param filePath {string} File Path
* @param fileMIMEType {string} File MIME Type * @param fileMIMEType {string} File MIME Type
* @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
callbackStyle: 'object', callbackStyle: 'object',
@ -34,6 +35,7 @@ export class FileOpener {
/** /**
* Uninstalls a package * Uninstalls a package
* @param packageId {string} Package ID * @param packageId {string} Package ID
* @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
callbackStyle: 'object', callbackStyle: 'object',
@ -45,6 +47,7 @@ export class FileOpener {
/** /**
* Check if an app is already installed * Check if an app is already installed
* @param packageId {string} Package ID * @param packageId {string} Package ID
* @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
callbackStyle: 'object', callbackStyle: 'object',

34
src/plugins/file.ts
View File

@ -407,7 +407,7 @@ export class File {
* *
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above * @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above
* @param {string} dir Name of directory to check * @param {string} dir Name of directory to check
* @return {Promise<boolean|FileError>} Returns a Promise that resolves to true if the directory exists or rejects with an error. * @returns {Promise<boolean|FileError>} Returns a Promise that resolves to true if the directory exists or rejects with an error.
*/ */
static checkDir(path: string, dir: string): Promise<boolean|FileError> { static checkDir(path: string, dir: string): Promise<boolean|FileError> {
if ((/^\//.test(dir))) { if ((/^\//.test(dir))) {
@ -431,7 +431,7 @@ export class File {
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above * @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above
* @param {string} dirName Name of directory to create * @param {string} dirName Name of directory to create
* @param {boolean} replace If true, replaces file with same name. If false returns error * @param {boolean} replace If true, replaces file with same name. If false returns error
* @return {Promise<DirectoryEntry|FileError>} Returns a Promise that resolves with a DirectoryEntry or rejects with an error. * @returns {Promise<DirectoryEntry|FileError>} Returns a Promise that resolves with a DirectoryEntry or rejects with an error.
*/ */
static createDir(path: string, dirName: string, replace: boolean): Promise<DirectoryEntry|FileError> { static createDir(path: string, dirName: string, replace: boolean): Promise<DirectoryEntry|FileError> {
if ((/^\//.test(dirName))) { if ((/^\//.test(dirName))) {
@ -459,7 +459,7 @@ export class File {
* *
* @param {string} path The path to the directory * @param {string} path The path to the directory
* @param {string} dirName The directory name * @param {string} dirName The directory name
* @return {Promise<RemoveResult|FileError>} Returns a Promise that resolves to a RemoveResult or rejects with an error. * @returns {Promise<RemoveResult|FileError>} Returns a Promise that resolves to a RemoveResult or rejects with an error.
*/ */
static removeDir(path: string, dirName: string): Promise<RemoveResult|FileError> { static removeDir(path: string, dirName: string): Promise<RemoveResult|FileError> {
if ((/^\//.test(dirName))) { if ((/^\//.test(dirName))) {
@ -484,7 +484,7 @@ export class File {
* @param {string} dirName The source directory name * @param {string} dirName The source directory name
* @param {string} newPath The destionation path to the directory * @param {string} newPath The destionation path to the directory
* @param {string} newDirName The destination directory name * @param {string} newDirName The destination directory name
* @return {Promise<DirectoryEntry|Entry|FileError>} Returns a Promise that resolves to the new DirectoryEntry object or rejects with an error. * @returns {Promise<DirectoryEntry|Entry|FileError>} Returns a Promise that resolves to the new DirectoryEntry object or rejects with an error.
*/ */
static moveDir(path: string, dirName: string, newPath: string, newDirName: string): Promise<DirectoryEntry|Entry|FileError> { static moveDir(path: string, dirName: string, newPath: string, newDirName: string): Promise<DirectoryEntry|Entry|FileError> {
newDirName = newDirName || dirName; newDirName = newDirName || dirName;
@ -514,7 +514,7 @@ export class File {
* @param {string} dirName Name of directory to copy * @param {string} dirName Name of directory to copy
* @param {string} newPath Base FileSystem of new location * @param {string} newPath Base FileSystem of new location
* @param {string} newDirName New name of directory to copy to (leave blank to remain the same) * @param {string} newDirName New name of directory to copy to (leave blank to remain the same)
* @return {Promise<Entry|FileError>} Returns a Promise that resolves to the new Entry object or rejects with an error. * @returns {Promise<Entry|FileError>} Returns a Promise that resolves to the new Entry object or rejects with an error.
*/ */
static copyDir(path: string, dirName: string, newPath: string, newDirName: string): Promise<Entry|FileError> { static copyDir(path: string, dirName: string, newPath: string, newDirName: string): Promise<Entry|FileError> {
if ((/^\//.test(newDirName))) { if ((/^\//.test(newDirName))) {
@ -540,7 +540,7 @@ export class File {
* *
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above * @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above
* @param {string} dirName Name of directory * @param {string} dirName Name of directory
* @return {Promise<Entry[]>} Returns a Promise that resolves to an array of Entry objects or rejects with an error. * @returns {Promise<Entry[]>} Returns a Promise that resolves to an array of Entry objects or rejects with an error.
*/ */
static listDir(path: string, dirName: string): Promise<Entry[]> { static listDir(path: string, dirName: string): Promise<Entry[]> {
if ((/^\//.test(dirName))) { if ((/^\//.test(dirName))) {
@ -564,7 +564,7 @@ export class File {
* *
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above * @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above
* @param {string} dirName Name of directory * @param {string} dirName Name of directory
* @return {Promise<RemoveResult>} Returns a Promise that resolves with a RemoveResult or rejects with an error. * @returns {Promise<RemoveResult>} Returns a Promise that resolves with a RemoveResult or rejects with an error.
*/ */
static removeRecursively(path: string, dirName: string): Promise<RemoveResult> { static removeRecursively(path: string, dirName: string): Promise<RemoveResult> {
if ((/^\//.test(dirName))) { if ((/^\//.test(dirName))) {
@ -587,7 +587,7 @@ export class File {
* *
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above * @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above
* @param {string} file Name of file to check * @param {string} file Name of file to check
* @return {Promise<boolean|FileError>} Returns a Promise that resolves with a boolean or rejects with an error. * @returns {Promise<boolean|FileError>} Returns a Promise that resolves with a boolean or rejects with an error.
*/ */
static checkFile(path: string, file: string): Promise<boolean|FileError> { static checkFile(path: string, file: string): Promise<boolean|FileError> {
if ((/^\//.test(file))) { if ((/^\//.test(file))) {
@ -616,7 +616,7 @@ export class File {
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above * @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above
* @param {string} fileName Name of file to create * @param {string} fileName Name of file to create
* @param {boolean} replace If true, replaces file with same name. If false returns error * @param {boolean} replace If true, replaces file with same name. If false returns error
* @return {Promise<FileEntry|FileError>} Returns a Promise that resolves to a FileEntry or rejects with an error. * @returns {Promise<FileEntry|FileError>} Returns a Promise that resolves to a FileEntry or rejects with an error.
*/ */
static createFile(path: string, fileName: string, replace: boolean): Promise<FileEntry|FileError> { static createFile(path: string, fileName: string, replace: boolean): Promise<FileEntry|FileError> {
if ((/^\//.test(fileName))) { if ((/^\//.test(fileName))) {
@ -644,7 +644,7 @@ export class File {
* *
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above * @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above
* @param {string} fileName Name of file to remove * @param {string} fileName Name of file to remove
* @return {Promise<RemoveResult|FileError>} Returns a Promise that resolves to a RemoveResult or rejects with an error. * @returns {Promise<RemoveResult|FileError>} Returns a Promise that resolves to a RemoveResult or rejects with an error.
*/ */
static removeFile(path: string, fileName: string): Promise<RemoveResult|FileError> { static removeFile(path: string, fileName: string): Promise<RemoveResult|FileError> {
if ((/^\//.test(fileName))) { if ((/^\//.test(fileName))) {
@ -668,7 +668,7 @@ export class File {
* @param {string} fileName path relative to base path * @param {string} fileName path relative to base path
* @param {string | Blob} text content or blob to write * @param {string | Blob} text content or blob to write
* @param {WriteOptions} options replace file if set to true. See WriteOptions for more information. * @param {WriteOptions} options replace file if set to true. See WriteOptions for more information.
* @returns {Promise<FileEntry>} Returns a Promise that resolves to updated file entry or rejects with an error. * @returns {Promise<any>} Returns a Promise that resolves to updated file entry or rejects with an error.
*/ */
static writeFile(path: string, fileName: string, static writeFile(path: string, fileName: string,
text: string | Blob, options: WriteOptions = {}): Promise<any> { text: string | Blob, options: WriteOptions = {}): Promise<any> {
@ -733,7 +733,7 @@ export class File {
* *
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above * @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above
* @param {string} file Name of file, relative to path. * @param {string} file Name of file, relative to path.
* @return {Promise<string|FileError>} Returns a Promise that resolves with the contents of the file as string or rejects with an error. * @returns {Promise<string|FileError>} Returns a Promise that resolves with the contents of the file as string or rejects with an error.
*/ */
static readAsText(path: string, file: string): Promise<string|FileError> { static readAsText(path: string, file: string): Promise<string|FileError> {
if ((/^\//.test(file))) { if ((/^\//.test(file))) {
@ -774,7 +774,7 @@ export class File {
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above * @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above
* @param {string} file Name of file, relative to path. * @param {string} file Name of file, relative to path.
* @return {Promise<string|FileError>} Returns a Promise that resolves with the contents of the file as data URL or rejects with an error. * @returns {Promise<string|FileError>} Returns a Promise that resolves with the contents of the file as data URL or rejects with an error.
*/ */
static readAsDataURL(path: string, file: string): Promise<string|FileError> { static readAsDataURL(path: string, file: string): Promise<string|FileError> {
if ((/^\//.test(file))) { if ((/^\//.test(file))) {
@ -816,7 +816,7 @@ export class File {
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above * @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above
* @param {string} file Name of file, relative to path. * @param {string} file Name of file, relative to path.
* @return {Promise<string|FileError>} Returns a Promise that resolves with the contents of the file as string rejects with an error. * @returns {Promise<string|FileError>} Returns a Promise that resolves with the contents of the file as string rejects with an error.
*/ */
static readAsBinaryString(path: string, file: string): Promise<string|FileError> { static readAsBinaryString(path: string, file: string): Promise<string|FileError> {
if ((/^\//.test(file))) { if ((/^\//.test(file))) {
@ -857,7 +857,7 @@ export class File {
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above * @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above
* @param {string} file Name of file, relative to path. * @param {string} file Name of file, relative to path.
* @return {Promise<ArrayBuffer|FileError>} Returns a Promise that resolves with the contents of the file as ArrayBuffer or rejects with an error. * @returns {Promise<ArrayBuffer|FileError>} Returns a Promise that resolves with the contents of the file as ArrayBuffer or rejects with an error.
*/ */
static readAsArrayBuffer(path: string, file: string): Promise<ArrayBuffer|FileError> { static readAsArrayBuffer(path: string, file: string): Promise<ArrayBuffer|FileError> {
if ((/^\//.test(file))) { if ((/^\//.test(file))) {
@ -900,7 +900,7 @@ export class File {
* @param {string} fileName Name of file to move * @param {string} fileName Name of file to move
* @param {string} newPath Base FileSystem of new location * @param {string} newPath Base FileSystem of new location
* @param {string} newFileName New name of file to move to (leave blank to remain the same) * @param {string} newFileName New name of file to move to (leave blank to remain the same)
* @return {Promise<Entry|FileError>} Returns a Promise that resolves to the new Entry or rejects with an error. * @returns {Promise<Entry|FileError>} Returns a Promise that resolves to the new Entry or rejects with an error.
*/ */
static moveFile(path: string, fileName: string, newPath: string, newFileName: string): Promise<Entry|FileError> { static moveFile(path: string, fileName: string, newPath: string, newFileName: string): Promise<Entry|FileError> {
newFileName = newFileName || fileName; newFileName = newFileName || fileName;
@ -930,7 +930,7 @@ export class File {
* @param {string} fileName Name of file to copy * @param {string} fileName Name of file to copy
* @param {string} newPath Base FileSystem of new location * @param {string} newPath Base FileSystem of new location
* @param {string} newFileName New name of file to copy to (leave blank to remain the same) * @param {string} newFileName New name of file to copy to (leave blank to remain the same)
* @return {Promise<Entry|FileError>} Returns a Promise that resolves to an Entry or rejects with an error. * @returns {Promise<Entry|FileError>} Returns a Promise that resolves to an Entry or rejects with an error.
*/ */
static copyFile(path: string, fileName: string, newPath: string, newFileName: string): Promise<Entry|FileError> { static copyFile(path: string, fileName: string, newPath: string, newFileName: string): Promise<Entry|FileError> {
newFileName = newFileName || fileName; newFileName = newFileName || fileName;

1
src/plugins/filepath.ts
View File

@ -29,6 +29,7 @@ export class FilePath {
/** /**
* Resolve native path for given content URL/path. * Resolve native path for given content URL/path.
* @param {String} path Content URL/path. * @param {String} path Content URL/path.
* @returns {Promise<string>}
*/ */
@Cordova() @Cordova()
static resolveNativePath(path: string): Promise<string> {return; } static resolveNativePath(path: string): Promise<string> {return; }

4
src/plugins/filetransfer.ts
View File

@ -211,7 +211,7 @@ export class Transfer {
* @param {string} url URL of the server to receive the file, as encoded by encodeURI(). * @param {string} url URL of the server to receive the file, as encoded by encodeURI().
* @param {FileUploadOptions} options Optional parameters. * @param {FileUploadOptions} options Optional parameters.
* @param {boolean} trustAllHosts Optional parameter, defaults to false. If set to true, it accepts all security certificates. This is useful since Android rejects self-signed security certificates. Not recommended for production use. Supported on Android and iOS. * @param {boolean} trustAllHosts Optional parameter, defaults to false. If set to true, it accepts all security certificates. This is useful since Android rejects self-signed security certificates. Not recommended for production use. Supported on Android and iOS.
* @return Returns a Promise that resolves to a FileUploadResult and rejects with FileTransferError. * @returns {Promise<FileUploadResult>} Returns a Promise that resolves to a FileUploadResult and rejects with FileTransferError.
*/ */
@CordovaInstance({ @CordovaInstance({
successIndex: 2, successIndex: 2,
@ -228,7 +228,7 @@ export class Transfer {
* @param {stirng} target Filesystem url representing the file on the device. For backwards compatibility, this can also be the full path of the file on the device. * @param {stirng} target Filesystem url representing the file on the device. For backwards compatibility, this can also be the full path of the file on the device.
* @param {boolean} trustAllHosts Optional parameter, defaults to false. If set to true, it accepts all security certificates. This is useful because Android rejects self-signed security certificates. Not recommended for production use. Supported on Android and iOS. * @param {boolean} trustAllHosts Optional parameter, defaults to false. If set to true, it accepts all security certificates. This is useful because Android rejects self-signed security certificates. Not recommended for production use. Supported on Android and iOS.
* @param {object} Optional parameters, currently only supports headers (such as Authorization (Basic Authentication), etc). * @param {object} Optional parameters, currently only supports headers (such as Authorization (Basic Authentication), etc).
* @return Returns a Promise that resolves to a FileEntry object. * @returns {Promise<any>} Returns a Promise that resolves to a FileEntry object.
*/ */
@CordovaInstance({ @CordovaInstance({
successIndex: 2, successIndex: 2,

14
src/plugins/geofence.ts
View File

@ -94,7 +94,7 @@ export class Geofence {
/** /**
* Initializes the plugin. User will be prompted to allow the app to use location and notifications. * Initializes the plugin. User will be prompted to allow the app to use location and notifications.
* *
* @return {Promise<any>} * @returns {Promise<void>}
*/ */
@Cordova() @Cordova()
static initialize(): Promise<void> { return; }; static initialize(): Promise<void> { return; };
@ -102,7 +102,7 @@ export class Geofence {
/** /**
* Adds a new geofence or array of geofences. For geofence object, see above. * Adds a new geofence or array of geofences. For geofence object, see above.
* *
* @return {Promise<any>} * @returns {Promise<void>}
*/ */
@Cordova() @Cordova()
static addOrUpdate(geofences: Object | Array<Object>): Promise<void> { return; }; static addOrUpdate(geofences: Object | Array<Object>): Promise<void> { return; };
@ -111,7 +111,7 @@ export class Geofence {
* Removes a geofence or array of geofences. `geofenceID` corresponds to one or more IDs specified when the * Removes a geofence or array of geofences. `geofenceID` corresponds to one or more IDs specified when the
* geofence was created. * geofence was created.
* *
* @return {Promise<any>} * @returns {Promise<void>}
*/ */
@Cordova() @Cordova()
static remove(geofenceId: string | Array<string>): Promise<void> { return; }; static remove(geofenceId: string | Array<string>): Promise<void> { return; };
@ -119,7 +119,7 @@ export class Geofence {
/** /**
* Removes all geofences. * Removes all geofences.
* *
* @return {Promise<any>} * @returns {Promise<void>}
*/ */
@Cordova() @Cordova()
static removeAll(): Promise<void> { return; }; static removeAll(): Promise<void> { return; };
@ -127,7 +127,7 @@ export class Geofence {
/** /**
* Returns an array of geofences currently being monitored. * Returns an array of geofences currently being monitored.
* *
* @return {Promise<Array<string>>} * @returns {Promise<Array<string>>}
*/ */
@Cordova() @Cordova()
static getWatched(): Promise<string> { return; }; static getWatched(): Promise<string> { return; };
@ -135,7 +135,7 @@ export class Geofence {
/** /**
* Called when a geofence is crossed in the direction specified by `TransitType`. * Called when a geofence is crossed in the direction specified by `TransitType`.
* *
* @return {Promise<any>} * @returns {Observable<any>}
*/ */
static onTransitionReceived(): Observable<any> { static onTransitionReceived(): Observable<any> {
@ -149,7 +149,7 @@ export class Geofence {
/** /**
* Called when the user clicks a geofence notification. iOS and Android only. * Called when the user clicks a geofence notification. iOS and Android only.
* *
* @return {Promise<Object>} * @returns {Observable<any>}
*/ */
static onNotificationClicked(): Observable<any> { static onNotificationClicked(): Observable<any> {

6
src/plugins/geolocation.ts
View File

@ -149,7 +149,7 @@ export class Geolocation {
* Get the device's current position. * Get the device's current position.
* *
* @param {GeolocationOptions} options The [geolocation options](https://developer.mozilla.org/en-US/docs/Web/API/PositionOptions). * @param {GeolocationOptions} options The [geolocation options](https://developer.mozilla.org/en-US/docs/Web/API/PositionOptions).
* @return Returns a Promise that resolves with the [position](https://developer.mozilla.org/en-US/docs/Web/API/Position) of the device, or rejects with an error. * @returns {Promise<Geoposition>} Returns a Promise that resolves with the [position](https://developer.mozilla.org/en-US/docs/Web/API/Position) of the device, or rejects with an error.
*/ */
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'
@ -172,9 +172,9 @@ export class Geolocation {
* ``` * ```
* *
* @param {GeolocationOptions} options The [geolocation options](https://developer.mozilla.org/en-US/docs/Web/API/PositionOptions). * @param {GeolocationOptions} options The [geolocation options](https://developer.mozilla.org/en-US/docs/Web/API/PositionOptions).
* @return Returns an Observable that notifies with the [position](https://developer.mozilla.org/en-US/docs/Web/API/Position) of the device, or errors. * @returns {Observable<Geoposition>} Returns an Observable that notifies with the [position](https://developer.mozilla.org/en-US/docs/Web/API/Position) of the device, or errors.
*/ */
static watchPosition(options?: GeolocationOptions): Observable<Geoposition & PositionError> { static watchPosition(options?: GeolocationOptions): Observable<Geoposition> {
return new Observable<Geoposition>( return new Observable<Geoposition>(
(observer: any) => { (observer: any) => {
let watchId = navigator.geolocation.watchPosition(observer.next.bind(observer), observer.next.bind(observer), options); let watchId = navigator.geolocation.watchPosition(observer.next.bind(observer), observer.next.bind(observer), options);

22
src/plugins/globalization.ts
View File

@ -20,14 +20,14 @@ export class Globalization {
/** /**
* Returns the BCP-47 compliant language identifier tag to the successCallback with a properties object as a parameter. That object should have a value property with a String value. * Returns the BCP-47 compliant language identifier tag to the successCallback with a properties object as a parameter. That object should have a value property with a String value.
* @return {Promise<{value: string}>} * @returns {Promise<{value: string}>}
*/ */
@Cordova() @Cordova()
static getPreferredLanguage(): Promise<{ value: string }> { return; } static getPreferredLanguage(): Promise<{ value: string }> { return; }
/** /**
* Returns the BCP 47 compliant locale identifier string to the successCallback with a properties object as a parameter. * Returns the BCP 47 compliant locale identifier string to the successCallback with a properties object as a parameter.
* @return {Promise<{value: string}>} * @returns {Promise<{value: string}>}
*/ */
@Cordova() @Cordova()
static getLocaleName(): Promise<{ value: string }> { return; } static getLocaleName(): Promise<{ value: string }> { return; }
@ -36,7 +36,7 @@ export class Globalization {
* Converts date to string * Converts date to string
* @param {Date} date Date you wish to convert * @param {Date} date Date you wish to convert
* @param options Options for the converted date. Length, selector. * @param options Options for the converted date. Length, selector.
* @return {Promise<{value: string}>} Returns a promise when the date has been converted. * @returns {Promise<{value: string}>} Returns a promise when the date has been converted.
*/ */
@Cordova({ @Cordova({
successIndex: 1, successIndex: 1,
@ -48,7 +48,7 @@ export class Globalization {
* Parses a date formatted as a string, according to the client's user preferences and calendar using the time zone of the client, and returns the corresponding date object. * Parses a date formatted as a string, according to the client's user preferences and calendar using the time zone of the client, and returns the corresponding date object.
* @param {string} dateString Date as a string to be converted * @param {string} dateString Date as a string to be converted
* @param options Options for the converted date. Length, selector. * @param options Options for the converted date. Length, selector.
* @return {Promise<{value: string}>} Returns a promise when the date has been converted. * @returns {Promise<{ year: number, month: number, day: number, hour: number, minute: number, second: number, millisecond: number }>} Returns a promise when the date has been converted.
*/ */
@Cordova({ @Cordova({
successIndex: 1, successIndex: 1,
@ -59,7 +59,7 @@ export class Globalization {
/** /**
* Returns a pattern string to format and parse dates according to the client's user preferences. * Returns a pattern string to format and parse dates according to the client's user preferences.
* @param options Object with the format length and selector * @param options Object with the format length and selector
* @return {Promise<{value: string}>} Returns a promise. * @returns {Promise<{pattern: string}>} Returns a promise.
*/ */
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'
@ -69,7 +69,7 @@ export class Globalization {
/** /**
* Returns an array of the names of the months or days of the week, depending on the client's user preferences and calendar. * Returns an array of the names of the months or days of the week, depending on the client's user preferences and calendar.
* @param options Object with type (narrow or wide) and item (month or days). * @param options Object with type (narrow or wide) and item (month or days).
* @return {Promise<{value: string}>} Returns a promise. * @returns {Promise<{value: Array<string>}>} Returns a promise.
*/ */
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'
@ -79,14 +79,14 @@ export class Globalization {
/** /**
* Indicates whether daylight savings time is in effect for a given date using the client's time zone and calendar. * Indicates whether daylight savings time is in effect for a given date using the client's time zone and calendar.
* @param {data} date Date to process * @param {data} date Date to process
* @returns {Promise<dst>} reutrns a promise with the value * @returns {Promise<{dst: string}>} reutrns a promise with the value
*/ */
@Cordova() @Cordova()
static isDayLightSavingsTime(date: Date): Promise<{ dst: string }> { return; } static isDayLightSavingsTime(date: Date): Promise<{ dst: string }> { return; }
/** /**
* Returns the first day of the week according to the client's user preferences and calendar. * Returns the first day of the week according to the client's user preferences and calendar.
* @returns {Promise<value>} reutrns a promise with the value * @returns {Promise<{value: string}>} returns a promise with the value
*/ */
@Cordova() @Cordova()
static getFirstDayOfWeek(): Promise<{ value: string }> { return; } static getFirstDayOfWeek(): Promise<{ value: string }> { return; }
@ -106,7 +106,7 @@ export class Globalization {
* *
* @param {string} stringToConvert String you want to conver to a number * @param {string} stringToConvert String you want to conver to a number
* @param options The type of number you want to return. Can be decimal, percent, or currency. * @param options The type of number you want to return. Can be decimal, percent, or currency.
* @returns {Promise} Returns a promise with the value. * @returns {Promise<{ value: number | string }>} Returns a promise with the value.
*/ */
@Cordova({ @Cordova({
successIndex: 1, successIndex: 1,
@ -117,7 +117,7 @@ export class Globalization {
/** /**
* Returns a pattern string to format and parse numbers according to the client's user preferences. * Returns a pattern string to format and parse numbers according to the client's user preferences.
* @param options Can be decimal, percent, or currency. * @param options Can be decimal, percent, or currency.
* @returns {Promise} returns a promise with the value. * @returns {Promise<{ pattern: string, symbol: string, fraction: number, rounding: number, positive: string, negative: string, decimal: string, grouping: string }>}
*/ */
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'
@ -127,7 +127,7 @@ export class Globalization {
/** /**
* Returns a pattern string to format and parse currency values according to the client's user preferences and ISO 4217 currency code. * Returns a pattern string to format and parse currency values according to the client's user preferences and ISO 4217 currency code.
* @param {string} currencyCode Currency Code.A * @param {string} currencyCode Currency Code.A
* @returns {Promise} returns a promise with the value * @returns {Promise<{ pattern: string, code: string, fraction: number, rounding: number, decimal: number, grouping: string }>}
*/ */
@Cordova() @Cordova()
static getCurrencyPattern(currencyCode: string): Promise<{ pattern: string, code: string, fraction: number, rounding: number, decimal: number, grouping: string }> { return; } static getCurrencyPattern(currencyCode: string): Promise<{ pattern: string, code: string, fraction: number, rounding: number, decimal: number, grouping: string }> { return; }

4
src/plugins/google-plus.ts
View File

@ -24,6 +24,7 @@ export class GooglePlus {
/** /**
* The login function walks the user through the Google Auth process. * The login function walks the user through the Google Auth process.
* @param options * @param options
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static login(options?: any): Promise<any> { return; } static login(options?: any): Promise<any> { return; }
@ -31,18 +32,21 @@ export class GooglePlus {
/** /**
* You can call trySilentLogin to check if they're already signed in to the app and sign them in silently if they are. * You can call trySilentLogin to check if they're already signed in to the app and sign them in silently if they are.
* @param options * @param options
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static trySilentLogin(options?: any): Promise<any> { return; } static trySilentLogin(options?: any): Promise<any> { return; }
/** /**
* This will clear the OAuth2 token. * This will clear the OAuth2 token.
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static logout(): Promise<any> { return; } static logout(): Promise<any> { return; }
/** /**
* This will clear the OAuth2 token, forget which account was used to login, and disconnect that account from the app. This will require the user to allow the app access again next time they sign in. Be aware that this effect is not always instantaneous. It can take time to completely disconnect. * This will clear the OAuth2 token, forget which account was used to login, and disconnect that account from the app. This will require the user to allow the app access again next time they sign in. Be aware that this effect is not always instantaneous. It can take time to completely disconnect.
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static disconnect(): Promise<any> { return; } static disconnect(): Promise<any> { return; }

32
src/plugins/googleanalytics.ts
View File

@ -25,7 +25,7 @@ export class GoogleAnalytics {
* https://developers.google.com/analytics/devguides/collection/analyticsjs/ * https://developers.google.com/analytics/devguides/collection/analyticsjs/
* @param {string} id Your Google Analytics Mobile App property * @param {string} id Your Google Analytics Mobile App property
* @param {number} interval Optional dispatch period in seconds. Defaults to 30. * @param {number} interval Optional dispatch period in seconds. Defaults to 30.
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static startTrackerWithId(id: string, interval?: number): Promise<any> { return; } static startTrackerWithId(id: string, interval?: number): Promise<any> { return; }
@ -33,7 +33,7 @@ export class GoogleAnalytics {
/** /**
* Enabling Advertising Features in Google Analytics allows you to take advantage of Remarketing, Demographics & Interests reports, and more * Enabling Advertising Features in Google Analytics allows you to take advantage of Remarketing, Demographics & Interests reports, and more
* @param allow {boolean} * @param allow {boolean}
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static setAllowIDFACollection(allow: boolean): Promise<any> { return; } static setAllowIDFACollection(allow: boolean): Promise<any> { return; }
@ -42,7 +42,7 @@ export class GoogleAnalytics {
* Set a UserId * Set a UserId
* https://developers.google.com/analytics/devguides/collection/analyticsjs/user-id * https://developers.google.com/analytics/devguides/collection/analyticsjs/user-id
* @param {string} id User ID * @param {string} id User ID
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static setUserId(id: string): Promise<any> { return; } static setUserId(id: string): Promise<any> { return; }
@ -50,7 +50,7 @@ export class GoogleAnalytics {
/** /**
* Set a anonymize Ip address * Set a anonymize Ip address
* @param anonymize {boolean} Set to true to anonymize the IP Address * @param anonymize {boolean} Set to true to anonymize the IP Address
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static setAnonymizeIp(anonymize: boolean): Promise<any> { return; } static setAnonymizeIp(anonymize: boolean): Promise<any> { return; }
@ -58,7 +58,7 @@ export class GoogleAnalytics {
/** /**
* Sets the app version * Sets the app version
* @param appVersion {string} App version * @param appVersion {string} App version
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static setAppVersion(appVersion: string): Promise<any> { return; } static setAppVersion(appVersion: string): Promise<any> { return; }
@ -66,14 +66,14 @@ export class GoogleAnalytics {
/** /**
* Set OptOut * Set OptOut
* @param optout {boolean} * @param optout {boolean}
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static setOptOut(optout: boolean): Promise<any> { return; } static setOptOut(optout: boolean): Promise<any> { return; }
/** /**
* Enable verbose logging * Enable verbose logging
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static debugMode(): Promise<any> { return; } static debugMode(): Promise<any> { return; }
@ -82,7 +82,7 @@ export class GoogleAnalytics {
* Track custom metric * Track custom metric
* @param key {string} * @param key {string}
* @param value {any} * @param value {any}
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
successIndex: 2, successIndex: 2,
@ -97,7 +97,7 @@ export class GoogleAnalytics {
* @param title {string} Screen title * @param title {string} Screen title
* @param campaignUrl {string} Campaign url for measuring referrals * @param campaignUrl {string} Campaign url for measuring referrals
* @param newSession {boolean} Set to true to create a new session * @param newSession {boolean} Set to true to create a new session
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
successIndex: 3, successIndex: 3,
@ -110,7 +110,7 @@ export class GoogleAnalytics {
* https://developers.google.com/analytics/devguides/platform/customdimsmets * https://developers.google.com/analytics/devguides/platform/customdimsmets
* @param key {string} * @param key {string}
* @param value {string} * @param value {string}
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static addCustomDimension(key: number, value: string): Promise<any> { return; } static addCustomDimension(key: number, value: string): Promise<any> { return; }
@ -123,7 +123,7 @@ export class GoogleAnalytics {
* @param label {string} * @param label {string}
* @param value {number} * @param value {number}
* @param newSession {boolean} Set to true to create a new session * @param newSession {boolean} Set to true to create a new session
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
successIndex: 5, successIndex: 5,
@ -135,7 +135,7 @@ export class GoogleAnalytics {
* Track an exception * Track an exception
* @param description {string} * @param description {string}
* @param fatal {boolean} * @param fatal {boolean}
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static trackException(description: string, fatal: boolean): Promise<any> { return; } static trackException(description: string, fatal: boolean): Promise<any> { return; }
@ -146,7 +146,7 @@ export class GoogleAnalytics {
* @param intervalInMilliseconds {number} * @param intervalInMilliseconds {number}
* @param variable {string} * @param variable {string}
* @param label {string} * @param label {string}
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static trackTiming(category: string, intervalInMilliseconds: number, variable: string, label: string): Promise<any> { return; } static trackTiming(category: string, intervalInMilliseconds: number, variable: string, label: string): Promise<any> { return; }
@ -160,7 +160,7 @@ export class GoogleAnalytics {
* @param tax {number} * @param tax {number}
* @param shipping {number} * @param shipping {number}
* @param currencyCode {string} * @param currencyCode {string}
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static addTransaction(id: string, affiliation: string, revenue: number, tax: number, shipping: number, currencyCode: string): Promise<any> { return; } static addTransaction(id: string, affiliation: string, revenue: number, tax: number, shipping: number, currencyCode: string): Promise<any> { return; }
@ -175,7 +175,7 @@ export class GoogleAnalytics {
* @param {number} price * @param {number} price
* @param {number} quantity * @param {number} quantity
* @param {string} currencyCode * @param {string} currencyCode
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static addTransactionItem(id: string, name: string, sku: string, category: string, price: number, quantity: number, currencyCode: string): Promise<any> { return; } static addTransactionItem(id: string, name: string, sku: string, category: string, price: number, quantity: number, currencyCode: string): Promise<any> { return; }
@ -183,7 +183,7 @@ export class GoogleAnalytics {
/** /**
* Enable/disable automatic reporting of uncaught exceptions * Enable/disable automatic reporting of uncaught exceptions
* @param shouldEnable {boolean} * @param shouldEnable {boolean}
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static enableUncaughtExceptionReporting(shouldEnable: boolean): Promise<any> { return; } static enableUncaughtExceptionReporting(shouldEnable: boolean): Promise<any> { return; }

48
src/plugins/googlemap.ts
View File

@ -113,7 +113,7 @@ export class GoogleMap {
/** /**
* Checks if a map object has been created and is available. * Checks if a map object has been created and is available.
* *
* @return {Promise<boolean>} * @returns {Promise<boolean>}
*/ */
@Cordova() @Cordova()
static isAvailable(): Promise<boolean> { return; } static isAvailable(): Promise<boolean> { return; }
@ -135,7 +135,7 @@ export class GoogleMap {
/** /**
* Listen to a map event. * Listen to a map event.
* *
* @return {Observable<any>} * @returns {Observable<any>}
*/ */
on(event: any): Observable<any> { on(event: any): Observable<any> {
if (!this._objectInstance) { if (!this._objectInstance) {
@ -155,7 +155,7 @@ export class GoogleMap {
/** /**
* Listen to a map event only once. * Listen to a map event only once.
* *
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
one(event: any): Promise<any> { one(event: any): Promise<any> {
if (!this._objectInstance) { if (!this._objectInstance) {
@ -175,7 +175,7 @@ export class GoogleMap {
/** /**
* Get the position of the camera. * Get the position of the camera.
* *
* @return {Promise<CameraPosition>} * @returns {Promise<CameraPosition>}
*/ */
@CordovaInstance() @CordovaInstance()
getCameraPosition(): Promise<CameraPosition> { return; } getCameraPosition(): Promise<CameraPosition> { return; }
@ -183,7 +183,7 @@ export class GoogleMap {
/** /**
* Get the location of the user. * Get the location of the user.
* *
* @return {Promise<MyLocation>} * @returns {Promise<MyLocation>}
*/ */
@CordovaInstance() @CordovaInstance()
getMyLocation(options?: MyLocationOptions): Promise<MyLocation> { return; } getMyLocation(options?: MyLocationOptions): Promise<MyLocation> { return; }
@ -191,7 +191,7 @@ export class GoogleMap {
/** /**
* Get the visible region. * Get the visible region.
* *
* @return {Promise<VisibleRegion>} * @returns {Promise<VisibleRegion>}
*/ */
@CordovaInstance() @CordovaInstance()
getVisibleRegion(): Promise<VisibleRegion> { return; } getVisibleRegion(): Promise<VisibleRegion> { return; }
@ -217,9 +217,15 @@ export class GoogleMap {
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
setTilt(tiltLevel: number): void { } setTilt(tiltLevel: number): void { }
/**
* @returns {Promise<any>}
*/
@CordovaInstance() @CordovaInstance()
animateCamera(animateCameraOptions: AnimateCameraOptions): Promise<any> { return; } animateCamera(animateCameraOptions: AnimateCameraOptions): Promise<any> { return; }
/**
* @returns {Promise<any>}
*/
@CordovaInstance() @CordovaInstance()
moveCamera(cameraPosition: CameraPosition): Promise<any> { return; } moveCamera(cameraPosition: CameraPosition): Promise<any> { return; }
@ -238,6 +244,9 @@ export class GoogleMap {
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
setAllGesturesEnabled(enabled: boolean): void { } setAllGesturesEnabled(enabled: boolean): void { }
/**
* @returns {Promise<GoogleMapsMarker | any>}
*/
addMarker(options: GoogleMapsMarkerOptions): Promise<GoogleMapsMarker | any> { addMarker(options: GoogleMapsMarkerOptions): Promise<GoogleMapsMarker | any> {
if (!this._objectInstance) { if (!this._objectInstance) {
return Promise.reject({ error: 'plugin_not_installed' }); return Promise.reject({ error: 'plugin_not_installed' });
@ -255,6 +264,9 @@ export class GoogleMap {
); );
} }
/**
* @returns {Promise<GoogleMapsCircle | any>}
*/
addCircle(options: GoogleMapsCircleOptions): Promise<GoogleMapsCircle | any> { addCircle(options: GoogleMapsCircleOptions): Promise<GoogleMapsCircle | any> {
if (!this._objectInstance) { if (!this._objectInstance) {
return Promise.reject({ error: 'plugin_not_installed' }); return Promise.reject({ error: 'plugin_not_installed' });
@ -272,6 +284,9 @@ export class GoogleMap {
); );
} }
/**
* @returns {Promise<GoogleMapsPolygon | any>}
*/
addPolygon(options: GoogleMapsPolygonOptions): Promise<GoogleMapsPolygon | any> { addPolygon(options: GoogleMapsPolygonOptions): Promise<GoogleMapsPolygon | any> {
if (!this._objectInstance) { if (!this._objectInstance) {
return Promise.reject({ error: 'plugin_not_installed' }); return Promise.reject({ error: 'plugin_not_installed' });
@ -289,6 +304,9 @@ export class GoogleMap {
); );
} }
/**
* @returns {Promise<GoogleMapsPolyline | any>}
*/
addPolyline(options: GoogleMapsPolylineOptions): Promise<GoogleMapsPolyline | any> { addPolyline(options: GoogleMapsPolylineOptions): Promise<GoogleMapsPolyline | any> {
if (!this._objectInstance) { if (!this._objectInstance) {
return Promise.reject({ error: 'plugin_not_installed' }); return Promise.reject({ error: 'plugin_not_installed' });
@ -306,6 +324,9 @@ export class GoogleMap {
); );
} }
/**
* @returns {Promise<GoogleMapsTileOverlay | any>}
*/
addTileOverlay(options: GoogleMapsTileOverlayOptions): Promise<GoogleMapsTileOverlay | any> { addTileOverlay(options: GoogleMapsTileOverlayOptions): Promise<GoogleMapsTileOverlay | any> {
if (!this._objectInstance) { if (!this._objectInstance) {
return Promise.reject({ error: 'plugin_not_installed' }); return Promise.reject({ error: 'plugin_not_installed' });
@ -323,6 +344,9 @@ export class GoogleMap {
); );
} }
/**
* @returns {Promise<GoogleMapsGroundOverlay | any>}
*/
addGroundOverlay(options: GoogleMapsGroundOverlayOptions): Promise<GoogleMapsGroundOverlay | any> { addGroundOverlay(options: GoogleMapsGroundOverlayOptions): Promise<GoogleMapsGroundOverlay | any> {
if (!this._objectInstance) { if (!this._objectInstance) {
return Promise.reject({ error: 'plugin_not_installed' }); return Promise.reject({ error: 'plugin_not_installed' });
@ -340,6 +364,9 @@ export class GoogleMap {
); );
} }
/**
* @returns {Promise<GoogleMapsKmlOverlay | any>}
*/
addKmlOverlay(options: GoogleMapsKmlOverlayOptions): Promise<GoogleMapsKmlOverlay | any> { addKmlOverlay(options: GoogleMapsKmlOverlayOptions): Promise<GoogleMapsKmlOverlay | any> {
if (!this._objectInstance) { if (!this._objectInstance) {
return Promise.reject({ error: 'plugin_not_installed' }); return Promise.reject({ error: 'plugin_not_installed' });
@ -378,12 +405,21 @@ export class GoogleMap {
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
refreshLayout(): void { } refreshLayout(): void { }
/**
* @returns {Promise<any>}
*/
@CordovaInstance() @CordovaInstance()
fromLatLngToPoint(latLng: GoogleMapsLatLng, point: any): Promise<any> { return; } fromLatLngToPoint(latLng: GoogleMapsLatLng, point: any): Promise<any> { return; }
/**
* @returns {Promise<GoogleMapsLatLng>}
*/
@CordovaInstance() @CordovaInstance()
fromPointToLatLng(point: any, latLng: GoogleMapsLatLng): Promise<GoogleMapsLatLng> { return; } fromPointToLatLng(point: any, latLng: GoogleMapsLatLng): Promise<GoogleMapsLatLng> { return; }
/**
* @returns {Promise<any>}
*/
@CordovaInstance() @CordovaInstance()
toDataURL(): Promise<any> { return; } toDataURL(): Promise<any> { return; }

71
src/plugins/hotspot.ts
View File

@ -23,9 +23,15 @@ import { Cordova, Plugin } from './plugin';
}) })
export class Hotspot { export class Hotspot {
/**
* @returns {Promise<boolean>}
*/
@Cordova() @Cordova()
static isAvailable(): Promise<boolean> { return; } static isAvailable(): Promise<boolean> { return; }
/**
* @returns {Promise<boolean>}
*/
@Cordova() @Cordova()
static toggleWifi(): Promise<boolean> { return; } static toggleWifi(): Promise<boolean> { return; }
@ -36,7 +42,7 @@ export class Hotspot {
* @param {string} mode - encryption mode (Open, WEP, WPA, WPA_PSK) * @param {string} mode - encryption mode (Open, WEP, WPA, WPA_PSK)
* @param {string} password - password for your new Access Point * @param {string} password - password for your new Access Point
* *
* @return {Promise<void>} - Promise to call once hotspot is started, or reject upon failure * @returns {Promise<void>} - Promise to call once hotspot is started, or reject upon failure
*/ */
@Cordova() @Cordova()
static createHotspot(ssid: string, mode: string, password: string): Promise<void> { return; } static createHotspot(ssid: string, mode: string, password: string): Promise<void> { return; }
@ -44,7 +50,7 @@ export class Hotspot {
/** /**
* Turns on Access Point * Turns on Access Point
* *
* @return {Promise<boolean>} - true if AP is started * @returns {Promise<boolean>} - true if AP is started
*/ */
@Cordova() @Cordova()
static startHotspot(): Promise<boolean> { return; } static startHotspot(): Promise<boolean> { return; }
@ -56,7 +62,7 @@ export class Hotspot {
* @param {string} mode - encryption mode (Open, WEP, WPA, WPA_PSK) * @param {string} mode - encryption mode (Open, WEP, WPA, WPA_PSK)
* @param {string} password - password for your new Access Point * @param {string} password - password for your new Access Point
* *
* @return {Promise<void>} - Promise to call when hotspot is configured, or reject upon failure * @returns {Promise<void>} - Promise to call when hotspot is configured, or reject upon failure
*/ */
@Cordova() @Cordova()
static configureHotspot(ssid: string, mode: string, password: string): Promise<void> { return; } static configureHotspot(ssid: string, mode: string, password: string): Promise<void> { return; }
@ -64,7 +70,7 @@ export class Hotspot {
/** /**
* Turns off Access Point * Turns off Access Point
* *
* @return {Promise<boolean>} - Promise to turn off the hotspot, true on success, false on failure * @returns {Promise<boolean>} - Promise to turn off the hotspot, true on success, false on failure
*/ */
@Cordova() @Cordova()
static stopHotspot(): Promise<boolean> { return; } static stopHotspot(): Promise<boolean> { return; }
@ -72,11 +78,14 @@ export class Hotspot {
/** /**
* Checks if hotspot is enabled * Checks if hotspot is enabled
* *
* @return {Promise<void>} - Promise that hotspot is enabled, rejected if it is not enabled * @returns {Promise<void>} - Promise that hotspot is enabled, rejected if it is not enabled
*/ */
@Cordova() @Cordova()
static isHotspotEnabled(): Promise<void> { return; } static isHotspotEnabled(): Promise<void> { return; }
/**
* @returns {Promise<Array<HotspotDevice>>}
*/
@Cordova() @Cordova()
static getAllHotspotDevices(): Promise<Array<HotspotDevice>> { return; } static getAllHotspotDevices(): Promise<Array<HotspotDevice>> { return; }
@ -88,7 +97,7 @@ export class Hotspot {
* @param {string} password * @param {string} password
* password to use * password to use
* *
* @return {Promise<void>} * @returns {Promise<void>}
* Promise that connection to the WiFi network was successfull, rejected if unsuccessful * Promise that connection to the WiFi network was successfull, rejected if unsuccessful
*/ */
@Cordova() @Cordova()
@ -106,7 +115,7 @@ export class Hotspot {
* @param {string[]} encryption * @param {string[]} encryption
* Encryption modes to use (CCMP, TKIP, WEP104, WEP40) * Encryption modes to use (CCMP, TKIP, WEP104, WEP40)
* *
* @return {Promise<void>} * @returns {Promise<void>}
* Promise that connection to the WiFi network was successfull, rejected if unsuccessful * Promise that connection to the WiFi network was successfull, rejected if unsuccessful
*/ */
@Cordova() @Cordova()
@ -122,7 +131,7 @@ export class Hotspot {
* @param {string} password * @param {string} password
* Password for network * Password for network
* *
* @return {Promise<void>} * @returns {Promise<void>}
* Promise that adding the WiFi network was successfull, rejected if unsuccessful * Promise that adding the WiFi network was successfull, rejected if unsuccessful
*/ */
@Cordova() @Cordova()
@ -134,45 +143,81 @@ export class Hotspot {
* @param {string} ssid * @param {string} ssid
* SSID of network * SSID of network
* *
* @return {Promise<void>} * @returns {Promise<void>}
* Promise that removing the WiFi network was successfull, rejected if unsuccessful * Promise that removing the WiFi network was successfull, rejected if unsuccessful
*/ */
@Cordova() @Cordova()
static removeWifiNetwork(ssid: string): Promise<void> { return; } static removeWifiNetwork(ssid: string): Promise<void> { return; }
/**
* @returns {Promise<boolean>}
*/
@Cordova() @Cordova()
static isConnectedToInternet(): Promise<boolean> { return; } static isConnectedToInternet(): Promise<boolean> { return; }
/**
* @returns {Promise<boolean>}
*/
@Cordova() @Cordova()
static isConnectedToInternetViaWifi(): Promise<boolean> { return; } static isConnectedToInternetViaWifi(): Promise<boolean> { return; }
/**
* @returns {Promise<boolean>}
*/
@Cordova() @Cordova()
static isWifiOn(): Promise<boolean> { return; } static isWifiOn(): Promise<boolean> { return; }
/**
* @returns {Promise<boolean>}
*/
@Cordova() @Cordova()
static isWifiSupported(): Promise<boolean> { return; } static isWifiSupported(): Promise<boolean> { return; }
/**
* @returns {Promise<boolean>}
*/
@Cordova() @Cordova()
static isWifiDirectSupported(): Promise<boolean> { return; } static isWifiDirectSupported(): Promise<boolean> { return; }
/**
* @returns {Promise<Array<HotspotNetwork>>}
*/
@Cordova() @Cordova()
static scanWifi(): Promise<Array<HotspotNetwork>> { return; } static scanWifi(): Promise<Array<HotspotNetwork>> { return; }
/**
* @returns {Promise<Array<HotspotNetwork>>}
*/
@Cordova() @Cordova()
static scanWifiByLevel(): Promise<Array<HotspotNetwork>> { return; } static scanWifiByLevel(): Promise<Array<HotspotNetwork>> { return; }
/**
* @returns {Promise<any>}
*/
@Cordova() @Cordova()
static startWifiPeriodicallyScan(interval: number, duration: number): Promise<any> { return; } static startWifiPeriodicallyScan(interval: number, duration: number): Promise<any> { return; }
/**
* @returns {Promise<any>}
*/
@Cordova() @Cordova()
static stopWifiPeriodicallyScan(): Promise<any> { return; } static stopWifiPeriodicallyScan(): Promise<any> { return; }
/**
* @returns {Promise<HotspotNetworkConfig>}
*/
@Cordova() @Cordova()
static getNetConfig(): Promise<HotspotNetworkConfig> { return; } static getNetConfig(): Promise<HotspotNetworkConfig> { return; }
/**
* @returns {Promise<ConnectionInfo>}
*/
@Cordova() @Cordova()
static getConnectionInfo(): Promise<ConnectionInfo> { return; } static getConnectionInfo(): Promise<ConnectionInfo> { return; }
/**
* @returns {Promise<string>}
*/
@Cordova() @Cordova()
static pingHost(ip: string): Promise<string> { return; } static pingHost(ip: string): Promise<string> { return; }
@ -181,7 +226,7 @@ export class Hotspot {
* *
* @param {string} ip - IP Address that you want the MAC Address of * @param {string} ip - IP Address that you want the MAC Address of
* *
* @return {Promise<string>} - A Promise for the MAC Address * @returns {Promise<string>} - A Promise for the MAC Address
*/ */
@Cordova() @Cordova()
static getMacAddressOfHost(ip: string): Promise<string> { return; } static getMacAddressOfHost(ip: string): Promise<string> { return; }
@ -191,7 +236,7 @@ export class Hotspot {
* *
* @param {string} ip - IP Address you want to test * @param {string} ip - IP Address you want to test
* *
* @return {Promise<boolean>} - A Promise for whether the IP Address is reachable * @returns {Promise<boolean>} - A Promise for whether the IP Address is reachable
*/ */
@Cordova() @Cordova()
static isDnsLive(ip: string): Promise<boolean> { return; } static isDnsLive(ip: string): Promise<boolean> { return; }
@ -201,7 +246,7 @@ export class Hotspot {
* *
* @param {string} ip - IP Address you want to test * @param {string} ip - IP Address you want to test
* *
* @return {Promise<boolean>} - A Promise for whether the IP Address is reachable * @returns {Promise<boolean>} - A Promise for whether the IP Address is reachable
*/ */
@Cordova() @Cordova()
static isPortLive(ip: string): Promise<boolean> { return; } static isPortLive(ip: string): Promise<boolean> { return; }
@ -209,7 +254,7 @@ export class Hotspot {
/** /**
* Checks if device is rooted * Checks if device is rooted
* *
* @return {Promise<boolean>} - A Promise for whether the device is rooted * @returns {Promise<boolean>} - A Promise for whether the device is rooted
*/ */
@Cordova() @Cordova()
static isRooted(): Promise<boolean> { return; } static isRooted(): Promise<boolean> { return; }

16
src/plugins/http.ts
View File

@ -45,7 +45,7 @@ export class HTTP {
* This returns an object representing a basic HTTP Authorization header of the form. * This returns an object representing a basic HTTP Authorization header of the form.
* @param username {string} Username * @param username {string} Username
* @param password {string} Password * @param password {string} Password
* @return {Object} an object representing a basic HTTP Authorization header of the form {'Authorization': 'Basic base64encodedusernameandpassword'} * @returns {Object} an object representing a basic HTTP Authorization header of the form {'Authorization': 'Basic base64encodedusernameandpassword'}
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
static getBasicAuthHeader(username: string, password: string): { Authorization: string; } { return; } static getBasicAuthHeader(username: string, password: string): { Authorization: string; } { return; }
@ -73,7 +73,7 @@ export class HTTP {
* *
* As an alternative, you can store your .cer files in the www/certificates folder. * As an alternative, you can store your .cer files in the www/certificates folder.
* @param enable {boolean} Set to true to enable * @param enable {boolean} Set to true to enable
* @return {Promise<any>} returns a promise that will resolve on success, and reject on failure * @returns {Promise<void>} returns a promise that will resolve on success, and reject on failure
*/ */
@Cordova() @Cordova()
static enableSSLPinning(enable: boolean): Promise<void> { return; } static enableSSLPinning(enable: boolean): Promise<void> { return; }
@ -81,7 +81,7 @@ export class HTTP {
/** /**
* Accept all SSL certificates. Or disabled accepting all certificates. Defaults to false. * Accept all SSL certificates. Or disabled accepting all certificates. Defaults to false.
* @param accept {boolean} Set to true to accept * @param accept {boolean} Set to true to accept
* @return {Promise<any>} returns a promise that will resolve on success, and reject on failure * @returns {Promise<void>} returns a promise that will resolve on success, and reject on failure
*/ */
@Cordova() @Cordova()
static acceptAllCerts(accept: boolean): Promise<void> { return; } static acceptAllCerts(accept: boolean): Promise<void> { return; }
@ -89,7 +89,7 @@ export class HTTP {
/** /**
* Whether or not to validate the domain name in the certificate. This defaults to true. * Whether or not to validate the domain name in the certificate. This defaults to true.
* @param validate {boolean} Set to true to validate * @param validate {boolean} Set to true to validate
* @return {Promise<any>} returns a promise that will resolve on success, and reject on failure * @returns {Promise<void>} returns a promise that will resolve on success, and reject on failure
*/ */
@Cordova() @Cordova()
static validateDomainName(validate: boolean): Promise<void> { return; } static validateDomainName(validate: boolean): Promise<void> { return; }
@ -99,7 +99,7 @@ export class HTTP {
* @param url {string} The url to send the request to * @param url {string} The url to send the request to
* @param body {Object} The body of the request * @param body {Object} The body of the request
* @param headers {Object} The headers to set for this request * @param headers {Object} The headers to set for this request
* @return {Promise<HTTPResponse>} returns a promise that resolve on success, and reject on failure * @returns {Promise<HTTPResponse>} returns a promise that resolve on success, and reject on failure
*/ */
@Cordova() @Cordova()
static post(url: string, body: any, headers: any): Promise<HTTPResponse> { return; } static post(url: string, body: any, headers: any): Promise<HTTPResponse> { return; }
@ -109,7 +109,7 @@ export class HTTP {
* @param url {string} The url to send the request to * @param url {string} The url to send the request to
* @param parameters {Object} Parameters to send with the request * @param parameters {Object} Parameters to send with the request
* @param headers {Object} The headers to set for this request * @param headers {Object} The headers to set for this request
* @return {Promise<HTTPResponse>} returns a promise that resolve on success, and reject on failure * @returns {Promise<HTTPResponse>} returns a promise that resolve on success, and reject on failure
*/ */
@Cordova() @Cordova()
static get(url: string, parameters: any, headers: any): Promise<HTTPResponse> { return; } static get(url: string, parameters: any, headers: any): Promise<HTTPResponse> { return; }
@ -121,7 +121,7 @@ export class HTTP {
* @param headers {Object} The headers to set for this request * @param headers {Object} The headers to set for this request
* @param filePath {string} The local path of the file to upload * @param filePath {string} The local path of the file to upload
* @param name {string} The name of the parameter to pass the file along as * @param name {string} The name of the parameter to pass the file along as
* @return {Promise<HTTPResponse>} returns a promise that resolve on success, and reject on failure * @returns {Promise<HTTPResponse>} returns a promise that resolve on success, and reject on failure
*/ */
@Cordova() @Cordova()
static uploadFile(url: string, body: any, headers: any, filePath: string, name: string): Promise<HTTPResponse> { return; } static uploadFile(url: string, body: any, headers: any, filePath: string, name: string): Promise<HTTPResponse> { return; }
@ -132,7 +132,7 @@ export class HTTP {
* @param body {Object} The body of the request * @param body {Object} The body of the request
* @param headers {Object} The headers to set for this request * @param headers {Object} The headers to set for this request
* @param filePath {string} The path to donwload the file to, including the file name. * @param filePath {string} The path to donwload the file to, including the file name.
* @return {Promise<HTTPResponse>} returns a promise that resolve on success, and reject on failure * @returns {Promise<HTTPResponse>} returns a promise that resolve on success, and reject on failure
*/ */
@Cordova() @Cordova()
static downloadFile(url: string, body: any, headers: any, filePath: string): Promise<HTTPResponse> { return; } static downloadFile(url: string, body: any, headers: any, filePath: string): Promise<HTTPResponse> { return; }

1
src/plugins/httpd.ts
View File

@ -35,6 +35,7 @@ export class Httpd {
* Starts a web server. * Starts a web server.
* @returns {Observable<string>} Returns an Observable. Subscribe to receive the URL for your web server (if succeeded). Unsubscribe to stop the server. * @returns {Observable<string>} Returns an Observable. Subscribe to receive the URL for your web server (if succeeded). Unsubscribe to stop the server.
* @param options {HttpdOptions} * @param options {HttpdOptions}
* @returns {Observable<string>}
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,

74
src/plugins/ibeacon.ts
View File

@ -140,7 +140,7 @@ export interface Delegate {
/** /**
* An observable that publishes information about the location permission authorization status. * An observable that publishes information about the location permission authorization status.
* *
* @return Returns a string. * @returns {Observable<string>} Returns a string.
*/ */
didChangeAuthorizationStatus(): Observable<string>; didChangeAuthorizationStatus(): Observable<string>;
@ -151,7 +151,7 @@ export interface Delegate {
* This event is called when the phone begins starts monitoring, * This event is called when the phone begins starts monitoring,
* when requestStateForRegion is called, etc. * when requestStateForRegion is called, etc.
* *
* @return {PluginResult} Returns a PluginResult object with information about the event, region, and beacon(s). * @returns {Observable<PluginResult>} Returns a PluginResult object with information about the event, region, and beacon(s).
*/ */
didDetermineStateForRegion(): Observable<PluginResult>; didDetermineStateForRegion(): Observable<PluginResult>;
@ -163,7 +163,7 @@ export interface Delegate {
* will be called even when the app is not running on iOS. * will be called even when the app is not running on iOS.
* The app will run silently in the background for a small amount of time. * The app will run silently in the background for a small amount of time.
* *
* @return {PluginResult} Returns a PluginResult object with information about the event, region, and beacon(s). * @returns {Observable<PluginResult>} Returns a PluginResult object with information about the event, region, and beacon(s).
*/ */
didEnterRegion(): Observable<PluginResult>; didEnterRegion(): Observable<PluginResult>;
@ -175,7 +175,7 @@ export interface Delegate {
* will be called even when the app is not running on iOS. * will be called even when the app is not running on iOS.
* The app will run silently in the background for a small amount of time. * The app will run silently in the background for a small amount of time.
* *
* @return {PluginResult} Returns a PluginResult object with information about the event, region, and beacon(s). * @returns {Observable<PluginResult>} Returns a PluginResult object with information about the event, region, and beacon(s).
*/ */
didExitRegion(): Observable<PluginResult>; didExitRegion(): Observable<PluginResult>;
@ -184,7 +184,7 @@ export interface Delegate {
* each time that the device ranges beacons. Modern Android and iOS devices range * each time that the device ranges beacons. Modern Android and iOS devices range
* aproximately once per second. * aproximately once per second.
* *
* @return {PluginResult} Returns a PluginResult object with information about the event, region, and beacon(s). * @returns {Observable<PluginResult>} Returns a PluginResult object with information about the event, region, and beacon(s).
*/ */
didRangeBeaconsInRegion(): Observable<PluginResult>; didRangeBeaconsInRegion(): Observable<PluginResult>;
@ -192,7 +192,7 @@ export interface Delegate {
* An Observable that publishes event data to it's subscribers * An Observable that publishes event data to it's subscribers
* when the device begins monitoring a region. * when the device begins monitoring a region.
* *
* @return {PluginResult} Returns a PluginResult object with information about the event, region, and beacon(s). * @returns {Observable<PluginResult>} Returns a PluginResult object with information about the event, region, and beacon(s).
*/ */
didStartMonitoringForRegion(): Observable<PluginResult>; didStartMonitoringForRegion(): Observable<PluginResult>;
@ -200,7 +200,7 @@ export interface Delegate {
* An Observable that publishes event data to it's subscribers * An Observable that publishes event data to it's subscribers
* when the device fails to monitor a region. * when the device fails to monitor a region.
* *
* @return {PluginResult} Returns a PluginResult object with information about the event, region, and beacon(s). * @returns {Observable<PluginResult>} Returns a PluginResult object with information about the event, region, and beacon(s).
*/ */
monitoringDidFailForRegionWithError(): Observable<PluginResult>; monitoringDidFailForRegionWithError(): Observable<PluginResult>;
@ -208,7 +208,7 @@ export interface Delegate {
* An Observable that publishes event data to it's subscribers * An Observable that publishes event data to it's subscribers
* when the device begins advertising as an iBeacon. * when the device begins advertising as an iBeacon.
* *
* @return {PluginResult} Returns a PluginResult object with information about the event, region, and beacon(s). * @returns {Observable<PluginResult>} Returns a PluginResult object with information about the event, region, and beacon(s).
*/ */
peripheralManagerDidStartAdvertising(): Observable<PluginResult>; peripheralManagerDidStartAdvertising(): Observable<PluginResult>;
@ -217,7 +217,7 @@ export interface Delegate {
* when the state of the peripheral manager's state updates. * when the state of the peripheral manager's state updates.
* *
* *
* @return {PluginResult} Returns a PluginResult object with information about the event, region, and beacon(s). * @returns {Observable<PluginResult>} Returns a PluginResult object with information about the event, region, and beacon(s).
*/ */
peripheralManagerDidUpdateState(): Observable<PluginResult>; peripheralManagerDidUpdateState(): Observable<PluginResult>;
} }
@ -380,14 +380,14 @@ export class IBeacon {
* @param {Number} minor The minor value that you use to identify a specific beacon. * @param {Number} minor The minor value that you use to identify a specific beacon.
* @param {BOOL} notifyEntryStateOnDisplay * @param {BOOL} notifyEntryStateOnDisplay
* *
* @return Returns the BeaconRegion that was created * @returns {BeaconRegion} Returns the BeaconRegion that was created
*/ */
static BeaconRegion(identifer: string, uuid: string, major?: number, minor?: number, notifyEntryStateOnDisplay?: boolean): BeaconRegion { static BeaconRegion(identifer: string, uuid: string, major?: number, minor?: number, notifyEntryStateOnDisplay?: boolean): BeaconRegion {
return new cordova.plugins.locationManager.BeaconRegion(identifer, uuid, major, minor, notifyEntryStateOnDisplay); return new cordova.plugins.locationManager.BeaconRegion(identifer, uuid, major, minor, notifyEntryStateOnDisplay);
} }
/** /**
* @return Returns the Delegate * @returns {Delegate} Returns the Delegate
*/ */
@Cordova() @Cordova()
static getDelegate(): Delegate { return; } static getDelegate(): Delegate { return; }
@ -395,7 +395,7 @@ export class IBeacon {
/** /**
* @param {Delegate} delegate An instance of a delegate to register with the native layer. * @param {Delegate} delegate An instance of a delegate to register with the native layer.
* *
* @return Returns the Delegate * @returns {Delegate} Returns the Delegate
*/ */
@Cordova() @Cordova()
static setDelegate(delegate: Delegate): Delegate { return; } static setDelegate(delegate: Delegate): Delegate { return; }
@ -417,7 +417,7 @@ export class IBeacon {
* message get emitted in the native runtime and the DOM as well after a certain * message get emitted in the native runtime and the DOM as well after a certain
* period of time. * period of time.
* *
* @return 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})
@ -425,7 +425,7 @@ export class IBeacon {
/** /**
* Determines if bluetooth is switched on, according to the native layer. * Determines if bluetooth is switched on, according to the native layer.
* @returns 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})
@ -434,7 +434,7 @@ export class IBeacon {
/** /**
* Enables Bluetooth using the native Layer. (ANDROID ONLY) * Enables Bluetooth using the native Layer. (ANDROID ONLY)
* *
* @returns 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})
@ -443,7 +443,7 @@ export class IBeacon {
/** /**
* Disables Bluetooth using the native Layer. (ANDROID ONLY) * Disables Bluetooth using the native Layer. (ANDROID ONLY)
* *
* @returns 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})
@ -463,7 +463,7 @@ export class IBeacon {
* @param {Region} region An instance of {Region} which will be monitored * @param {Region} region An instance of {Region} which will be monitored
* by the operating system. * by the operating system.
* *
* @return 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})
@ -480,7 +480,7 @@ export class IBeacon {
* @param {Region} region An instance of {Region} which will be monitored * @param {Region} region An instance of {Region} which will be monitored
* by the operating system. * by the operating system.
* *
* @return 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})
@ -496,7 +496,7 @@ export class IBeacon {
* @param {Region} region An instance of {Region} which will be monitored * @param {Region} region An instance of {Region} which will be monitored
* by the operating system. * by the operating system.
* *
* @return 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})
@ -514,7 +514,7 @@ export class IBeacon {
* @param {Region} region An instance of {BeaconRegion} which will be monitored * @param {Region} region An instance of {BeaconRegion} which will be monitored
* by the operating system. * by the operating system.
* *
* @return 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})
@ -531,7 +531,7 @@ export class IBeacon {
* @param {Region} region An instance of {BeaconRegion} which will be monitored * @param {Region} region An instance of {BeaconRegion} which will be monitored
* by the operating system. * by the operating system.
* *
* @return 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})
@ -540,7 +540,7 @@ export class IBeacon {
/** /**
* Queries the native layer to determine the current authorization in effect. * Queries the native layer to determine the current authorization in effect.
* *
* @returns Returns a promise which is resolved with the * @returns {Promise<any>} Returns a promise which is resolved with the
* requested authorization status. * requested authorization status.
*/ */
@Cordova({otherPromise: true}) @Cordova({otherPromise: true})
@ -553,7 +553,7 @@ export class IBeacon {
* <a href="https://developer.apple.com/library/prerelease/iOS/documentation/CoreLocation/Reference/CLLocationManager_Class/index.html#//apple_ref/occ/instm/CLLocationManager/requestAlwaysAuthorization">requestAlwaysAuthorization</a> * <a href="https://developer.apple.com/library/prerelease/iOS/documentation/CoreLocation/Reference/CLLocationManager_Class/index.html#//apple_ref/occ/instm/CLLocationManager/requestAlwaysAuthorization">requestAlwaysAuthorization</a>
* *
* 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 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})
static requestWhenInUseAuthorization(): Promise<void> { return; } static requestWhenInUseAuthorization(): Promise<void> { return; }
@ -562,7 +562,7 @@ export class IBeacon {
/** /**
* See the docuemntation of {@code requestWhenInUseAuthorization} for further details. * See the docuemntation of {@code requestWhenInUseAuthorization} for further details.
* *
* @returns 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})
@ -570,7 +570,7 @@ export class IBeacon {
/** /**
* *
* @returns 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})
@ -578,7 +578,7 @@ export class IBeacon {
/** /**
* *
* @returns 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})
@ -586,7 +586,7 @@ export class IBeacon {
/** /**
* Determines if ranging is available or not, according to the native layer. * Determines if ranging is available or not, according to the native layer.
* @returns 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})
@ -598,7 +598,7 @@ export class IBeacon {
* @param {Region} region An instance of {Region} which will be checked * @param {Region} region An instance of {Region} which will be checked
* by the operating system. * by the operating system.
* *
* @returns 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})
@ -618,7 +618,7 @@ export class IBeacon {
* @param {Integer} measuredPower: Optional parameter, if left empty, the device will * @param {Integer} measuredPower: Optional parameter, if left empty, the device will
* use it's own default value. * use it's own default value.
* *
* @return 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})
@ -629,7 +629,7 @@ export class IBeacon {
* *
* This is done asynchronously and may not be immediately reflected in isAdvertising. * This is done asynchronously and may not be immediately reflected in isAdvertising.
* *
* @return 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})
@ -637,7 +637,7 @@ export class IBeacon {
/** /**
* Determines if advertising is available or not, according to the native layer. * Determines if advertising is available or not, according to the native layer.
* @returns 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})
@ -645,7 +645,7 @@ export class IBeacon {
/** /**
* Determines if advertising is currently active, according to the native layer. * Determines if advertising is currently active, according to the native layer.
* @returns 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})
@ -655,7 +655,7 @@ export class IBeacon {
* Disables debug logging in the native layer. Use this method if you want * Disables debug logging in the native layer. Use this method if you want
* to prevent this plugin from writing to the device logs. * to prevent this plugin from writing to the device logs.
* *
* @returns 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})
@ -666,7 +666,7 @@ export class IBeacon {
* to allow the plugin the posting local notifications. * to allow the plugin the posting local notifications.
* This can be very helpful when debugging how to apps behave when launched into the background. * This can be very helpful when debugging how to apps behave when launched into the background.
* *
* @returns 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})
@ -676,7 +676,7 @@ export class IBeacon {
* Disables the posting of debug notifications in the native layer. Use this method if you want * Disables the posting of debug notifications in the native layer. Use this method if you want
* to prevent the plugin from posting local notifications. * to prevent the plugin from posting local notifications.
* *
* @returns 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})
@ -686,7 +686,7 @@ export class IBeacon {
* Enables debug logging in the native layer. Use this method if you want * Enables debug logging in the native layer. Use this method if you want
* a debug the inner workings of this plugin. * a debug the inner workings of this plugin.
* *
* @returns 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})
@ -698,7 +698,7 @@ export class IBeacon {
* *
* @param {String} message The message to append to the device logs. * @param {String} message The message to append to the device logs.
* *
* @returns Returns a promise which is resolved with the log * @returns {Promise<void>} Returns a promise which is resolved with the log
* 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.
*/ */

2
src/plugins/imagepicker.ts
View File

@ -55,7 +55,7 @@ export class ImagePicker {
/** /**
* Pick pictures from the library. * Pick pictures from the library.
* @param {ImagePickerOptions} options * @param {ImagePickerOptions} options
* @return Returns a Promise that resolves the image file URI * @returns {Promise<any>} Returns a Promise that resolves the image file URI
* otherwise rejects with an error. * otherwise rejects with an error.
*/ */
@Cordova({ @Cordova({

3
src/plugins/imageresizer.ts
View File

@ -73,6 +73,9 @@ export interface ImageResizerOptions {
repo: 'https://github.com/protonet/cordova-plugin-image-resizer' repo: 'https://github.com/protonet/cordova-plugin-image-resizer'
}) })
export class ImageResizer { export class ImageResizer {
/**
* @returns {Promise<any>}
*/
@Cordova() @Cordova()
static resize(options: ImageResizerOptions): Promise<any> { return; } static resize(options: ImageResizerOptions): Promise<any> { return; }
} }

8
src/plugins/inappbrowser.ts
View File

@ -80,13 +80,15 @@ export class InAppBrowser {
/** /**
* Injects JavaScript code into the InAppBrowser window. * Injects JavaScript code into the InAppBrowser window.
* @param script Details of the script to run, specifying either a file or code key. * @param script Details of the script to run, specifying either a file or code key.
* @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 InAppBrowser window. * Injects CSS into the InAppBrowser window.
* @param css Details of the script to run, specifying either a file or code key. * @param {Object} Details of the script to run, specifying either a file or code key.
* @returns {Promise<any>}
*/ */
@CordovaInstance() @CordovaInstance()
insertCss(css: {file?: string, code?: string}): Promise<any> {return; } insertCss(css: {file?: string, code?: string}): Promise<any> {return; }
@ -96,8 +98,8 @@ export class InAppBrowser {
/** /**
* 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.
* @param event Event name * @param {string} name of the event
* @returns {Observable<any>} Returns back an observable that will listen to the event on subscribe, and will stop listening to the event on unsubscribe. * @returns {Observable<InAppBrowserEvent>} Returns back an observable that will listen to the event on subscribe, and will stop listening to the event on unsubscribe.
*/ */
on(event: string): Observable<InAppBrowserEvent> { on(event: string): Observable<InAppBrowserEvent> {
return new Observable<InAppBrowserEvent>((observer) => { return new Observable<InAppBrowserEvent>((observer) => {

9
src/plugins/inapppurchase.ts
View File

@ -62,7 +62,7 @@ export class InAppPurchase {
/** /**
* Retrieves a list of full product data from Apple/Google. This method must be called before making purchases. * Retrieves a list of full product data from Apple/Google. This method must be called before making purchases.
* @param {array<string>} productId an array of product ids. * @param {array<string>} productId an array of product ids.
* @returns {Promise} Returns a Promise that resolves with an array of objects. * @returns {Promise<any>} Returns a Promise that resolves with an array of objects.
*/ */
@Cordova({ @Cordova({
otherPromise: true otherPromise: true
@ -72,7 +72,7 @@ export class InAppPurchase {
/** /**
* Buy a product that matches the productId. * Buy a product that matches the productId.
* @param {string} productId A string that matches the product you want to buy. * @param {string} productId A string that matches the product you want to buy.
* @returns {Promise} Returns a Promise that resolves with the transaction details. * @returns {Promise<{transactionId: string, receipt: string, signature: string, productType: string}>} Returns a Promise that resolves with the transaction details.
*/ */
@Cordova({ @Cordova({
otherPromise: true otherPromise: true
@ -82,7 +82,7 @@ export class InAppPurchase {
/** /**
* Same as buy, but for subscription based products. * Same as buy, but for subscription based products.
* @param {string} productId A string that matches the product you want to subscribe to. * @param {string} productId A string that matches the product you want to subscribe to.
* @returns {Promise} Returns a Promise that resolves with the transaction details. * @returns {Promise<{transactionId: string, receipt: string, signature: string, productType: string}>} Returns a Promise that resolves with the transaction details.
*/ */
@Cordova({ @Cordova({
otherPromise: true otherPromise: true
@ -94,6 +94,7 @@ export class InAppPurchase {
* @param {string} productType * @param {string} productType
* @param {string} receipt * @param {string} receipt
* @param {string} signature * @param {string} signature
* @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
otherPromise: true otherPromise: true
@ -102,7 +103,7 @@ export class InAppPurchase {
/** /**
* Restore all purchases from the store * Restore all purchases from the store
* @returns {Promise} Returns a promise with an array of purchases. * @returns {Promise<any>} Returns a promise with an array of purchases.
*/ */
@Cordova({ @Cordova({
otherPromise: true otherPromise: true

4
src/plugins/insomnia.ts
View File

@ -36,14 +36,14 @@ export class Insomnia {
/** /**
* Keeps awake the application * Keeps awake the application
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static keepAwake(): Promise<any> { return; } static keepAwake(): Promise<any> { return; }
/** /**
* Allows the application to sleep again * Allows the application to sleep again
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static allowSleepAgain(): Promise<any> { return; } static allowSleepAgain(): Promise<any> { return; }

6
src/plugins/instagram.ts
View File

@ -25,7 +25,7 @@ export class Instagram {
/** /**
* Detect if the Instagram application is installed on the device. * Detect if the Instagram application is installed on the device.
* *
* @return {Promise<boolean|string>} Returns a promise that returns a boolean value if installed, or the app version on android * @returns {Promise<boolean|string>} Returns a promise that returns a boolean value if installed, or the app version on android
*/ */
@Cordova({ @Cordova({
callbackStyle: 'node' callbackStyle: 'node'
@ -38,7 +38,7 @@ export class Instagram {
* *
* @param canvasIdOrDataUrl The canvas element id or the dataURL of the image to share * @param canvasIdOrDataUrl The canvas element id or the dataURL of the image to share
* @param caption The caption of the image * @param caption The caption of the image
* @return {Promise<any>} Returns a promise that resolves if the image was shared * @returns {Promise<any>} Returns a promise that resolves if the image was shared
*/ */
@Cordova({ @Cordova({
callbackStyle: 'node' callbackStyle: 'node'
@ -48,7 +48,7 @@ export class Instagram {
/** /**
* Share a library asset or video * Share a library asset or video
* @param assetLocalIdentifier A local fileURI * @param assetLocalIdentifier A local fileURI
* @return {Promise<any>} Returns a promise that resolves if the image was shared * @returns {Promise<any>} Returns a promise that resolves if the image was shared
*/ */
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'

2
src/plugins/is-debug.ts
View File

@ -26,7 +26,7 @@ export class IsDebug {
/** /**
* Determine if an app was installed via xcode / eclipse / the ionic CLI etc * Determine if an app was installed via xcode / eclipse / the ionic CLI etc
* @return {Promise<boolean>} Returns a promise that resolves with true if the app was installed via xcode / eclipse / the ionic CLI etc. It will resolve to false if the app was downloaded from the app / play store by the end user. * @returns {Promise<boolean>} Returns a promise that resolves with true if the app was installed via xcode / eclipse / the ionic CLI etc. It will resolve to false if the app was downloaded from the app / play store by the end user.
*/ */
@Cordova() @Cordova()
static getIsDebug(): Promise<boolean> { static getIsDebug(): Promise<boolean> {

2
src/plugins/keyboard.ts
View File

@ -58,6 +58,7 @@ export class Keyboard {
/** /**
* Creates an observable that notifies you when the keyboard is shown. Unsubscribe to observable to cancel event watch. * Creates an observable that notifies you when the keyboard is shown. Unsubscribe to observable to cancel event watch.
* @returns {Observable<any>}
*/ */
@Cordova({ @Cordova({
eventObservable: true, eventObservable: true,
@ -68,6 +69,7 @@ export class Keyboard {
/** /**
* Creates an observable that notifies you when the keyboard is hidden. Unsubscribe to observable to cancel event watch. * Creates an observable that notifies you when the keyboard is hidden. Unsubscribe to observable to cancel event watch.
* @returns {Observable<any>}
*/ */
@Cordova({ @Cordova({
eventObservable: true, eventObservable: true,

22
src/plugins/launchnavigator.ts
View File

@ -107,12 +107,14 @@ export class LaunchNavigator {
/** /**
* Determines if the given app is installed and available on the current device. * Determines if the given app is installed and available on the current device.
* @param app {string} * @param app {string}
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static isAppAvailable(app: string): Promise<any> { return; } static isAppAvailable(app: string): Promise<any> { return; }
/** /**
* Returns a list indicating which apps are installed and available on the current device. * Returns a list indicating which apps are installed and available on the current device.
* @returns {Promise<string[]>}
*/ */
@Cordova() @Cordova()
static availableApps(): Promise<string[]> { return; } static availableApps(): Promise<string[]> { return; }
@ -120,6 +122,7 @@ export class LaunchNavigator {
/** /**
* Returns the display name of the specified app. * Returns the display name of the specified app.
* @param app {string} * @param app {string}
* @returns {string}
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
static getAppDisplayName(app: string): string { return; } static getAppDisplayName(app: string): string { return; }
@ -127,6 +130,7 @@ export class LaunchNavigator {
/** /**
* Returns list of supported apps on a given platform. * Returns list of supported apps on a given platform.
* @param platform {string} * @param platform {string}
* @returns {string[]}
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
static getAppsForPlatform(platform: string): string[] { return; } static getAppsForPlatform(platform: string): string[] { return; }
@ -135,6 +139,7 @@ export class LaunchNavigator {
* Indicates if an app on a given platform supports specification of transport mode. * Indicates if an app on a given platform supports specification of transport mode.
* @param app {string} specified as a string, you can use one of the constants, e.g `LaunchNavigator.APP.GOOGLE_MAPS` * @param app {string} specified as a string, you can use one of the constants, e.g `LaunchNavigator.APP.GOOGLE_MAPS`
* @param platform {string} * @param platform {string}
* @returns {boolean}
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
static supportsTransportMode(app: string, platform: string): boolean { return; } static supportsTransportMode(app: string, platform: string): boolean { return; }
@ -143,6 +148,7 @@ export class LaunchNavigator {
* Returns the list of transport modes supported by an app on a given platform. * Returns the list of transport modes supported by an app on a given platform.
* @param app {string} * @param app {string}
* @param platform {string} * @param platform {string}
* @returns {string[]}
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
static getTransportModes(app: string, platform: string): string[] { return; } static getTransportModes(app: string, platform: string): string[] { return; }
@ -152,6 +158,7 @@ export class LaunchNavigator {
* Note that currently only Google Maps on Android does. * Note that currently only Google Maps on Android does.
* @param app {string} * @param app {string}
* @param platform {string} * @param platform {string}
* @returns {boolean}
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
static supportsLaunchMode(app: string, platform: string): boolean { return; } static supportsLaunchMode(app: string, platform: string): boolean { return; }
@ -160,16 +167,31 @@ export class LaunchNavigator {
* Indicates if an app on a given platform supports specification of start location. * Indicates if an app on a given platform supports specification of start location.
* @param app {string} * @param app {string}
* @param platform {string} * @param platform {string}
* @returns {boolean}
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
static supportsStart(app: string, platform: string): boolean { return; } static supportsStart(app: string, platform: string): boolean { return; }
/**
* @param app {string}
* @param platform {string}
* @returns {boolean}
*/
@Cordova({ sync: true }) @Cordova({ sync: true })
static supportsStartName(app: string, platform: string): boolean { return; } static supportsStartName(app: string, platform: string): boolean { return; }
/**
* @param app {string}
* @param platform {string}
* @returns {boolean}
*/
@Cordova({ sync: true }) @Cordova({ sync: true })
static supportsDestName(app: string, platform: string): boolean { return; } static supportsDestName(app: string, platform: string): boolean { return; }
/**
* @param destination {string | number[]}
* @param options {LaunchNavigatorOptions}
*/
@Cordova({ sync: true }) @Cordova({ sync: true })
static userSelect(destination: string | number[], options: LaunchNavigatorOptions): void { } static userSelect(destination: string | number[], options: LaunchNavigatorOptions): void { }

54
src/plugins/localnotifications.ts
View File

@ -54,7 +54,7 @@ export class LocalNotifications {
/** /**
* Schedules a single or multiple notifications * Schedules a single or multiple notifications
* @param options * @param options {Notification | Array<Notification>} optional
*/ */
@Cordova({ @Cordova({
sync: true sync: true
@ -63,7 +63,7 @@ export class LocalNotifications {
/** /**
* Updates a previously scheduled notification. Must include the id in the options parameter. * Updates a previously scheduled notification. Must include the id in the options parameter.
* @param options * @param options {Notification} optional
*/ */
@Cordova({ @Cordova({
sync: true sync: true
@ -72,15 +72,15 @@ export class LocalNotifications {
/** /**
* Clears single or multiple notifications * Clears single or multiple notifications
* @param notificationId A single notification id, or an array of notification ids. * @param notificationId {any} A single notification id, or an array of notification ids.
* @returns {Promise} Returns a promise when the notification had been cleared * @returns {Promise<any>} Returns a promise when the notification had been cleared
*/ */
@Cordova() @Cordova()
static clear(notificationId: any): Promise<any> { return; } static clear(notificationId: any): Promise<any> { return; }
/** /**
* Clears all notifications * Clears all notifications
* @returns {Promise} Returns a promise when all notifications have cleared * @returns {Promise<any>} Returns a promise when all notifications have cleared
*/ */
@Cordova({ @Cordova({
successIndex: 0, successIndex: 0,
@ -90,15 +90,15 @@ export class LocalNotifications {
/** /**
* Cancels single or multiple notifications * Cancels single or multiple notifications
* @param notificationId A single notification id, or an array of notification ids. * @param notificationId {any} A single notification id, or an array of notification ids.
* @returns {Promise} Returns a promise when the notification is canceled * @returns {Promise<any>} Returns a promise when the notification is canceled
*/ */
@Cordova() @Cordova()
static cancel(notificationId: any): Promise<any> { return; } static cancel(notificationId: any): Promise<any> { return; }
/** /**
* Cancels all notifications * Cancels all notifications
* @returns {Promise} Returns a promise when all notifications are canceled * @returns {Promise<any>} Returns a promise when all notifications are canceled
*/ */
@Cordova({ @Cordova({
successIndex: 0, successIndex: 0,
@ -108,61 +108,61 @@ export class LocalNotifications {
/** /**
* Checks presence of a notification * Checks presence of a notification
* @param notificationId * @param notificationId {number}
* @returns {Promise} Returns a promise * @returns {Promise<boolean>}
*/ */
@Cordova() @Cordova()
static isPresent(notificationId: number): Promise<boolean> { return; } static isPresent(notificationId: number): Promise<boolean> { return; }
/** /**
* Checks is a notification is scheduled * Checks is a notification is scheduled
* @param notificationId * @param notificationId {number}
* @returns {Promise} Returns a promise * @returns {Promise<boolean>}
*/ */
@Cordova() @Cordova()
static isScheduled(notificationId: number): Promise<boolean> { return; } static isScheduled(notificationId: number): Promise<boolean> { return; }
/** /**
* Checks if a notification is triggered * Checks if a notification is triggered
* @param notificationId * @param notificationId {number}
* @returns {Promise} Returns a promise * @returns {Promise<boolean>}
*/ */
@Cordova() @Cordova()
static isTriggered(notificationId: number): Promise<boolean> { return; } static isTriggered(notificationId: number): Promise<boolean> { return; }
/** /**
* Get all the notification ids * Get all the notification ids
* @returns {Promise} Returns a promise * @returns {Promise<Array<number>>}
*/ */
@Cordova() @Cordova()
static getAllIds(): Promise<Array<number>> { return; } static getAllIds(): Promise<Array<number>> { return; }
/** /**
* Get the ids of triggered notifications * Get the ids of triggered notifications
* @returns {Promise} Returns a promise * @returns {Promise<Array<number>>}
*/ */
@Cordova() @Cordova()
static getTriggeredIds(): Promise<Array<number>> { return; } static getTriggeredIds(): Promise<Array<number>> { return; }
/** /**
* Get the ids of scheduled notifications * Get the ids of scheduled notifications
* @returns {Promise} Returns a promise * @returns {Promise<Array<number>>} Returns a promise
*/ */
@Cordova() @Cordova()
static getScheduledIds(): Promise<Array<number>> { return; } static getScheduledIds(): Promise<Array<number>> { return; }
/** /**
* Get a notification object * Get a notification object
* @param notificationId The id of the notification to get * @param notificationId {any} The id of the notification to get
* @returns {Promise} Returns a promise * @returns {Promise<Notification>}
*/ */
@Cordova() @Cordova()
static get(notificationId: any): Promise<Notification> { return; } static get(notificationId: any): Promise<Notification> { return; }
/** /**
* Get a scheduled notification object * Get a scheduled notification object
* @param notificationId The id of the notification to get * @param notificationId {any} The id of the notification to get
* @returns {Promise} Returns a promise * @returns {Promise<Notification>}
*/ */
@Cordova() @Cordova()
static getScheduled(notificationId: any): Promise<Notification> { return; } static getScheduled(notificationId: any): Promise<Notification> { return; }
@ -170,42 +170,42 @@ export class LocalNotifications {
/** /**
* Get a triggered notification object * Get a triggered notification object
* @param notificationId The id of the notification to get * @param notificationId The id of the notification to get
* @returns {Promise} Returns a promise * @returns {Promise<Notification>}
*/ */
@Cordova() @Cordova()
static getTriggered(notificationId: any): Promise<Notification> { return; } static getTriggered(notificationId: any): Promise<Notification> { return; }
/** /**
* Get all notification objects * Get all notification objects
* @returns {Promise} Returns a promise * @returns {Promise<Array<Notification>>}
*/ */
@Cordova() @Cordova()
static getAll(): Promise<Array<Notification>> { return; } static getAll(): Promise<Array<Notification>> { return; }
/** /**
* Get all scheduled notification objects * Get all scheduled notification objects
* @returns {Promise} Returns a promise * @returns {Promise<Array<Notification>>}
*/ */
@Cordova() @Cordova()
static getAllScheduled(): Promise<Array<Notification>> { return; } static getAllScheduled(): Promise<Array<Notification>> { return; }
/** /**
* Get all triggered notification objects * Get all triggered notification objects
* @returns {Promise} Returns a promise * @returns {Promise<Array<Notification>>}
*/ */
@Cordova() @Cordova()
static getAllTriggered(): Promise<Array<Notification>> { return; } static getAllTriggered(): Promise<Array<Notification>> { return; }
/** /**
* Register permission to show notifications if not already granted. * Register permission to show notifications if not already granted.
* @returns {Promise} Returns a promise * @returns {Promise<boolean>}
*/ */
@Cordova() @Cordova()
static registerPermission(): Promise<boolean> { return; } static registerPermission(): Promise<boolean> { return; }
/** /**
* Informs if the app has the permission to show notifications. * Informs if the app has the permission to show notifications.
* @returns {Promise} Returns a promise * @returns {Promise<boolean>}
*/ */
@Cordova() @Cordova()
static hasPermission(): Promise<boolean> { return; } static hasPermission(): Promise<boolean> { return; }

2
src/plugins/market.ts
View File

@ -22,7 +22,7 @@ export class Market {
/** /**
* Opens an app in Google Play / App Store * Opens an app in Google Play / App Store
* @param appId {string} Package name * @param appId {string} Package name
* @param callbacks {Object} Optional callbacks * @param callbacks {Object} Optional callbacks in the format {success?: Function, failure?: Function}
*/ */
@Cordova({sync: true}) @Cordova({sync: true})
static open(appId: string, callbacks?: {success?: Function, failure?: Function}): void { } static open(appId: string, callbacks?: {success?: Function, failure?: Function}): void { }

5
src/plugins/media-capture.ts
View File

@ -58,6 +58,7 @@ export class MediaCapture {
/** /**
* Start the audio recorder application and return information about captured audio clip files. * Start the audio recorder application and return information about captured audio clip files.
* @param options * @param options
* @returns {Promise<MediaFile[]>}
*/ */
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'
@ -67,6 +68,7 @@ export class MediaCapture {
/** /**
* Start the camera application and return information about captured image files. * Start the camera application and return information about captured image files.
* @param options * @param options
* @returns {Promise<MediaFile[]>}
*/ */
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'
@ -76,6 +78,7 @@ export class MediaCapture {
/** /**
* Start the video recorder application and return information about captured video clip files. * Start the video recorder application and return information about captured video clip files.
* @param options * @param options
* @returns {Promise<MediaFile[]>}
*/ */
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'
@ -84,6 +87,7 @@ export class MediaCapture {
/** /**
* is fired if the capture call is successful * is fired if the capture call is successful
* @returns {Observable<MediaFile[]>}
*/ */
@Cordova({ @Cordova({
eventObservable: true, eventObservable: true,
@ -93,6 +97,7 @@ export class MediaCapture {
/** /**
* is fired if the capture call is unsuccessful * is fired if the capture call is unsuccessful
* @returns {Observable<CaptureError>}
*/ */
@Cordova({ @Cordova({
eventObservable: true, eventObservable: true,

8
src/plugins/media.ts
View File

@ -140,21 +140,21 @@ export class MediaPlugin {
/** /**
* Get the current amplitude of the current recording. * Get the current amplitude of the current recording.
* @returns {Promise} Returns a promise with the amplitude of the current recording * @returns {Promise<any>} Returns a promise with the amplitude of the current recording
*/ */
@CordovaInstance() @CordovaInstance()
getCurrentAmplitude(): Promise<any> { return; } getCurrentAmplitude(): Promise<any> { return; }
/** /**
* Get the current position within an audio file. Also updates the Media object's position parameter. * Get the current position within an audio file. Also updates the Media object's position parameter.
* @returns {Promise} Returns a promise with the position of the current recording * @returns {Promise<any>} Returns a promise with the position of the current recording
*/ */
@CordovaInstance() @CordovaInstance()
getCurrentPosition(): Promise<any> { return; } getCurrentPosition(): Promise<any> { return; }
/** /**
* Get the duration of an audio file in seconds. If the duration is unknown, it returns a value of -1. * Get the duration of an audio file in seconds. If the duration is unknown, it returns a value of -1.
* @returns {Promise} Returns a promise with the duration of the current recording * @returns {number} Returns a promise with the duration of the current recording
*/ */
@CordovaInstance({ @CordovaInstance({
sync: true sync: true
@ -199,7 +199,7 @@ export class MediaPlugin {
/** /**
* Set the volume for an audio file. * Set the volume for an audio file.
* @param volume The volume to set for playback. The value must be within the range of 0.0 to 1.0. * @param volume {number} The volume to set for playback. The value must be within the range of 0.0 to 1.0.
*/ */
@CordovaInstance({ @CordovaInstance({
sync: true sync: true

11
src/plugins/mixpanel.ts
View File

@ -41,7 +41,7 @@ export class Mixpanel {
static distinctId(): Promise<any> { return; } static distinctId(): Promise<any> { return; }
/** /**
* * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static flush(): Promise<any> { return; } static flush(): Promise<any> { return; }
@ -52,7 +52,7 @@ export class Mixpanel {
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static identify(distinctId): Promise<any> { return; } static identify(distinctId: string): Promise<any> { return; }
/** /**
* *
@ -64,7 +64,7 @@ export class Mixpanel {
/** /**
* *
* @param superProperties * @param superProperties {any}
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
@ -79,8 +79,9 @@ export class Mixpanel {
/** /**
* *
* @param eventName * @param eventName {string}
* @param eventProperties * @param eventProperties {any} optional
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static track(eventName: string, eventProperties?: any): Promise<any> { return; } static track(eventName: string, eventProperties?: any): Promise<any> { return; }

6
src/plugins/native-audio.ts
View File

@ -55,7 +55,8 @@ export class NativeAudio {
/** /**
* Plays an audio asset * Plays an audio asset
* @param id {string} unique ID for the audio file * @param id {string} unique ID for the audio file
* @param completeCallback {Function} callback to be invoked when audio is done playing * @param completeCallback {Function} optional. Callback to be invoked when audio is done playing
* @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
successIndex: 1, successIndex: 1,
@ -66,6 +67,7 @@ export class NativeAudio {
/** /**
* Stops playing an audio * Stops playing an audio
* @param id {string} unique ID for the audio file * @param id {string} unique ID for the audio file
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static stop(id: string): Promise<any> {return; } static stop(id: string): Promise<any> {return; }
@ -81,6 +83,7 @@ export class NativeAudio {
/** /**
* Unloads an audio file from memory * Unloads an audio file from memory
* @param id {string} unique ID for the audio file * @param id {string} unique ID for the audio file
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static unload(id: string): Promise<any> {return; } static unload(id: string): Promise<any> {return; }
@ -89,6 +92,7 @@ export class NativeAudio {
* Changes the volume for preloaded complex assets. * Changes the volume for preloaded complex assets.
* @param id {string} unique ID for the audio file * @param id {string} unique ID for the audio file
* @param volume {number} the volume of the audio asset (0.1 to 1.0) * @param volume {number} the volume of the audio asset (0.1 to 1.0)
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static setVolumeForComplexAsset(id: string, volume: number): Promise<any> {return; } static setVolumeForComplexAsset(id: string, volume: number): Promise<any> {return; }

5
src/plugins/native-page-transitions.ts
View File

@ -37,6 +37,7 @@ export class NativePageTransitions {
/** /**
* Perform a slide animation * Perform a slide animation
* @param options {TransitionOptions} Options for the transition * @param options {TransitionOptions} Options for the transition
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static slide(options: TransitionOptions): Promise<any> { return; } static slide(options: TransitionOptions): Promise<any> { return; }
@ -44,6 +45,7 @@ export class NativePageTransitions {
/** /**
* Perform a flip animation * Perform a flip animation
* @param options {TransitionOptions} Options for the transition * @param options {TransitionOptions} Options for the transition
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static flip(options: TransitionOptions): Promise<any> { return; } static flip(options: TransitionOptions): Promise<any> { return; }
@ -51,6 +53,7 @@ export class NativePageTransitions {
/** /**
* Perform a fade animation * Perform a fade animation
* @param options {TransitionOptions} Options for the transition * @param options {TransitionOptions} Options for the transition
* @returns {Promise<any>}
*/ */
@Cordova({platforms: ['iOS', 'Android']}) @Cordova({platforms: ['iOS', 'Android']})
static fade(options: TransitionOptions): Promise<any> { return; } static fade(options: TransitionOptions): Promise<any> { return; }
@ -59,6 +62,7 @@ export class NativePageTransitions {
/** /**
* Perform a slide animation * Perform a slide animation
* @param options {TransitionOptions} Options for the transition * @param options {TransitionOptions} Options for the transition
* @returns {Promise<any>}
*/ */
@Cordova({platforms: ['iOS', 'Android']}) @Cordova({platforms: ['iOS', 'Android']})
static drawer(options: TransitionOptions): Promise<any> { return; } static drawer(options: TransitionOptions): Promise<any> { return; }
@ -68,6 +72,7 @@ export class NativePageTransitions {
/** /**
* Perform a slide animation * Perform a slide animation
* @param options {TransitionOptions} Options for the transition * @param options {TransitionOptions} Options for the transition
* @returns {Promise<any>}
*/ */
@Cordova({platforms: ['iOS']}) @Cordova({platforms: ['iOS']})
static curl(options: TransitionOptions): Promise<any> { return; } static curl(options: TransitionOptions): Promise<any> { return; }

4
src/plugins/nativestorage.ts
View File

@ -33,6 +33,7 @@ export class NativeStorage {
* Stores a value * Stores a value
* @param reference {string} * @param reference {string}
* @param value * @param value
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static setItem(reference: string, value: any): Promise<any> {return; } static setItem(reference: string, value: any): Promise<any> {return; }
@ -40,6 +41,7 @@ export class NativeStorage {
/** /**
* Gets a stored item * Gets a stored item
* @param reference {string} * @param reference {string}
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static getItem(reference: string): Promise<any> {return; } static getItem(reference: string): Promise<any> {return; }
@ -47,12 +49,14 @@ export class NativeStorage {
/** /**
* Removes a single stored item * Removes a single stored item
* @param reference {string} * @param reference {string}
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static remove(reference: string): Promise<any> {return; } static remove(reference: string): Promise<any> {return; }
/** /**
* Removes all stored values. * Removes all stored values.
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static clear(): Promise<any> {return; } static clear(): Promise<any> {return; }

24
src/plugins/nfc.ts
View File

@ -34,7 +34,7 @@ export class NFC {
* Registers an event listener for any NDEF tag. * Registers an event listener for any NDEF tag.
* @param onSuccess * @param onSuccess
* @param onFailure * @param onFailure
* @return {Promise<any>} * @returns {Observable<any>}
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -50,7 +50,7 @@ export class NFC {
* @param mimeType * @param mimeType
* @param onSuccess * @param onSuccess
* @param onFailure * @param onFailure
* @return {Promise<any>} * @returns {Observable<any>}
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -65,7 +65,7 @@ export class NFC {
* Registers an event listener for NDEF tags matching a specified MIME type. * Registers an event listener for NDEF tags matching a specified MIME type.
* @param onSuccess * @param onSuccess
* @param onFailure * @param onFailure
* @return {Promise<any>} * @returns {Observable<any>}
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -80,7 +80,7 @@ export class NFC {
* Registers an event listener for formatable NDEF tags. * Registers an event listener for formatable NDEF tags.
* @param onSuccess * @param onSuccess
* @param onFailure * @param onFailure
* @return {Promise<any>} * @returns {Observable<any>}
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -92,13 +92,13 @@ export class NFC {
/** /**
* Qrites an NdefMessage to a NFC tag. * Qrites an NdefMessage to a NFC tag.
* @param message {any[]} * @param message {any[]}
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static write(message: any[]): Promise<any> {return; } static 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.
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static makeReadyOnly(): Promise<any> {return; } static makeReadyOnly(): Promise<any> {return; }
@ -106,14 +106,14 @@ export class NFC {
/** /**
* Shares an NDEF Message via peer-to-peer. * Shares an NDEF Message via peer-to-peer.
* @param message An array of NDEF Records. * @param message An array of NDEF Records.
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static share(message: any[]): Promise<any> {return; } static share(message: any[]): Promise<any> {return; }
/** /**
* Stop sharing NDEF data via peer-to-peer. * Stop sharing NDEF data via peer-to-peer.
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static unshare(): Promise<any> {return; } static unshare(): Promise<any> {return; }
@ -127,28 +127,28 @@ export class NFC {
/** /**
* Send a file to another device via NFC handover. * Send a file to another device via NFC handover.
* @param uris A URI as a String, or an array of URIs. * @param uris A URI as a String, or an array of URIs.
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static handover(uris: string[]): Promise<any> {return; } static handover(uris: string[]): Promise<any> {return; }
/** /**
* Stop sharing NDEF data via NFC handover. * Stop sharing NDEF data via NFC handover.
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static stopHandover(): Promise<any> {return; } static stopHandover(): Promise<any> {return; }
/** /**
* Show the NFC settings on the device. * Show the NFC settings on the device.
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static showSettings(): Promise<any> {return; } static showSettings(): Promise<any> {return; }
/** /**
* Check if NFC is available and enabled on this device. * Check if NFC is available and enabled on this device.
* @return {Promise<any>} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static enabled(): Promise<any> {return; } static enabled(): Promise<any> {return; }

11
src/plugins/onesignal.ts
View File

@ -51,6 +51,7 @@ export class OneSignal {
* *
* @param {string} appId Your AppId from your OneSignal app * @param {string} appId Your AppId from your OneSignal app
* @param {string} googleProjectNumber The Google Project Number (which you can get from the Google Developer Portal) and the autoRegister option. * @param {string} googleProjectNumber The Google Project Number (which you can get from the Google Developer Portal) and the autoRegister option.
* @returns {any}
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
static startInit(appId: string, googleProjectNumber: string): any { return; } static startInit(appId: string, googleProjectNumber: string): any { return; }
@ -76,6 +77,7 @@ export class OneSignal {
/** /**
* *
* @param settings * @param settings
* @returns {any}
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
static iOSSettings(settings: { static iOSSettings(settings: {
@ -83,13 +85,16 @@ export class OneSignal {
kOSSettingsKeyAutoPrompt: boolean; kOSSettingsKeyAutoPrompt: boolean;
}): any { return; } }): any { return; }
/**
* @returns {any}
*/
@Cordova({ sync: true }) @Cordova({ sync: true })
static endInit(): any { return; } static endInit(): any { return; }
/** /**
* Retrieve a list of tags that have been set on the user from the OneSignal server. * Retrieve a list of tags that have been set on the user from the OneSignal server.
* *
* @returns {Promise} Returns a Promise that resolves when tags are recieved. * @returns {Promise<any>} Returns a Promise that resolves when tags are recieved.
*/ */
@Cordova() @Cordova()
static getTags(): Promise<any> { return; } static getTags(): Promise<any> { return; }
@ -98,7 +103,7 @@ export class OneSignal {
* Lets you retrieve the OneSignal user id and device token. * Lets you retrieve the OneSignal user id and device token.
* Your handler is called after the device is successfully registered with OneSignal. * Your handler is called after the device is successfully registered with OneSignal.
* *
* @returns {Promise} Returns a Promise that reolves if the device was successfully registered. * @returns {Promise<any>} Returns a Promise that reolves if the device was successfully registered.
* It returns a JSON with `userId`and `pushToken`. * It returns a JSON with `userId`and `pushToken`.
*/ */
@Cordova() @Cordova()
@ -192,7 +197,7 @@ export class OneSignal {
/** /**
* *
* @param {notificationObj} Parameters see POST [documentation](https://documentation.onesignal.com/v2.0/docs/notifications-create-notification) * @param {notificationObj} Parameters see POST [documentation](https://documentation.onesignal.com/v2.0/docs/notifications-create-notification)
* @returns {Promise} Returns a Promise that resolves if the notification was send successfully. * @returns {Promise<any>} Returns a Promise that resolves if the notification was send successfully.
*/ */
@Cordova() @Cordova()
static postNotification(notificationObj: OneSignalNotification): Promise<any> { return; } static postNotification(notificationObj: OneSignalNotification): Promise<any> { return; }

11
src/plugins/pay-pal.ts
View File

@ -66,6 +66,7 @@ import { Plugin, Cordova } from './plugin';
export class PayPal { export class PayPal {
/** /**
* Retrieve the version of the PayPal iOS SDK library. Useful when contacting support. * Retrieve the version of the PayPal iOS SDK library. Useful when contacting support.
* @returns {Promise<string>}
*/ */
@Cordova() @Cordova()
static version(): Promise<string> {return; } static version(): Promise<string> {return; }
@ -77,6 +78,7 @@ export class PayPal {
* the recommended time to preconnect is on page load. * the recommended time to preconnect is on page load.
* *
* @param {PayPalEnvironment} clientIdsForEnvironments: set of client ids for environments * @param {PayPalEnvironment} clientIdsForEnvironments: set of client ids for environments
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static init(clientIdsForEnvironments: PayPalEnvironment): Promise<any> {return; } static init(clientIdsForEnvironments: PayPalEnvironment): Promise<any> {return; }
@ -88,7 +90,8 @@ export class PayPal {
* *
* @param {String} environment: available options are "PayPalEnvironmentNoNetwork", "PayPalEnvironmentProduction" and "PayPalEnvironmentSandbox" * @param {String} environment: available options are "PayPalEnvironmentNoNetwork", "PayPalEnvironmentProduction" and "PayPalEnvironmentSandbox"
* @param {PayPalConfiguration} configuration: PayPalConfiguration object, for Future Payments merchantName, merchantPrivacyPolicyURL and merchantUserAgreementURL must be set be set * @param {PayPalConfiguration} configuration: PayPalConfiguration object, for Future Payments merchantName, merchantPrivacyPolicyURL and merchantUserAgreementURL must be set be set
**/ * @returns {Promise<any>}
*/
@Cordova() @Cordova()
static prepareToRender(environment: string, configuration: PayPalConfiguration): Promise<any> {return; } static prepareToRender(environment: string, configuration: PayPalConfiguration): Promise<any> {return; }
@ -98,6 +101,7 @@ export class PayPal {
* for more documentation of the params. * for more documentation of the params.
* *
* @param {PayPalPayment} payment PayPalPayment object * @param {PayPalPayment} payment PayPalPayment object
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static renderSinglePaymentUI(payment: PayPalPayment): Promise<any> {return; } static renderSinglePaymentUI(payment: PayPalPayment): Promise<any> {return; }
@ -110,12 +114,14 @@ export class PayPal {
* This method MUST be called prior to initiating a pre-consented payment (a "future payment") from a mobile device. * This method MUST be called prior to initiating a pre-consented payment (a "future payment") from a mobile device.
* Pass the result to your server, to include in the payment request sent to PayPal. * Pass the result to your server, to include in the payment request sent to PayPal.
* Do not otherwise cache or store this value. * Do not otherwise cache or store this value.
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static clientMetadataID(): Promise<any> {return; } static 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>}
*/ */
@Cordova() @Cordova()
static renderFuturePaymentUI(): Promise<any> {return; } static renderFuturePaymentUI(): Promise<any> {return; }
@ -125,7 +131,8 @@ export class PayPal {
* *
* @param {Array<string>} scopes scopes Set of requested scope-values. Accepted scopes are: openid, profile, address, email, phone, futurepayments and paypalattributes * @param {Array<string>} scopes scopes Set of requested scope-values. Accepted scopes are: openid, profile, address, email, phone, futurepayments and paypalattributes
* See https://developer.paypal.com/docs/integration/direct/identity/attributes/ for more details * See https://developer.paypal.com/docs/integration/direct/identity/attributes/ for more details
**/ * @returns {Promise<any>}
*/
@Cordova() @Cordova()
static renderProfileSharingUI(scopes: string[]): Promise<any> {return; } static renderProfileSharingUI(scopes: string[]): Promise<any> {return; }
} }

2
src/plugins/photo-viewer.ts
View File

@ -25,5 +25,5 @@ export class PhotoViewer {
* @param options {any} * @param options {any}
*/ */
@Cordova({sync: true}) @Cordova({sync: true})
static show(url: string, title?: string, options?: {share?: boolean; }): void { } static show(url: string, title?: string, options?: {share?: boolean}): void { }
} }

1
src/plugins/pin-dialog.ts
View File

@ -31,6 +31,7 @@ export class PinDialog {
* @param {string} message Message to show the user * @param {string} message Message to show the user
* @param {string} title Title of the dialog * @param {string} title Title of the dialog
* @param {string[]} buttons Buttons to show * @param {string[]} buttons Buttons to show
* @returns {Promise<{ buttonIndex: number, input1: string }>}
*/ */
@Cordova({ @Cordova({
successIndex: 1 successIndex: 1

4
src/plugins/power-management.ts
View File

@ -24,18 +24,21 @@ import { Plugin, Cordova } from './plugin';
export class PowerManagement { export class PowerManagement {
/** /**
* Acquire a wakelock by calling this. * Acquire a wakelock by calling this.
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static acquire(): Promise<any> {return; } static 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>}
*/ */
@Cordova() @Cordova()
static dim(): Promise<any> {return; } static 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>}
*/ */
@Cordova() @Cordova()
static release(): Promise<any> {return; } static release(): Promise<any> {return; }
@ -44,6 +47,7 @@ export class PowerManagement {
* 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).
* It will reacquire the wakelock upon app resume. If you would prefer to disable this behaviour, you can use this function. * It will reacquire the wakelock upon app resume. If you would prefer to disable this behaviour, you can use this function.
* @param set {boolean} * @param set {boolean}
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static setReleaseOnPause(set: boolean): Promise<any> {return; } static setReleaseOnPause(set: boolean): Promise<any> {return; }

6
src/plugins/printer.ts
View File

@ -71,14 +71,16 @@ export class Printer {
/** /**
* Checks whether to device is capable of printing. * Checks whether to device is capable of printing.
* @returns {Promise<boolean>}
*/ */
@Cordova() @Cordova()
static isAvailable(): Promise<boolean> { return; } static isAvailable(): Promise<boolean> { return; }
/** /**
* Sends content to the printer. * Sends content to the printer.
* @param {content} The content to print. Can be a URL or an HTML string. If a HTML DOM Object is provided, its innerHtml property value will be used. * @param content {string | HTMLElement} The content to print. Can be a URL or an HTML string. If a HTML DOM Object is provided, its innerHtml property value will be used.
* @param {options} The options to pass to the printer * @param options {PrintOptions} optional. The options to pass to the printer
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static print(content: string | HTMLElement, options?: PrintOptions): Promise<any> { return; } static print(content: string | HTMLElement, options?: PrintOptions): Promise<any> { return; }

4
src/plugins/push.ts
View File

@ -312,7 +312,7 @@ export class Push {
* ``` * ```
* *
* @param {PushOptions} options The Push [options](https://github.com/phonegap/phonegap-plugin-push/blob/master/docs/API.md#parameters). * @param {PushOptions} options The Push [options](https://github.com/phonegap/phonegap-plugin-push/blob/master/docs/API.md#parameters).
* @return {PushNotification} Returns a new [PushNotification](https://github.com/phonegap/phonegap-plugin-push/blob/master/docs/API.md#pushonevent-callback) object. * @returns {PushNotification} Returns a new [PushNotification](https://github.com/phonegap/phonegap-plugin-push/blob/master/docs/API.md#pushonevent-callback) object.
*/ */
@Cordova({ @Cordova({
sync: true sync: true
@ -321,7 +321,7 @@ export class Push {
/** /**
* Check whether the push notification permission has been granted. * Check whether the push notification permission has been granted.
* @return {Promise} Returns a Promise that resolves with an object with one property: isEnabled, a boolean that indicates if permission has been granted. * @return {Promise<{isEnabled: boolean}>} Returns a Promise that resolves with an object with one property: isEnabled, a boolean that indicates if permission has been granted.
*/ */
@Cordova() @Cordova()
static hasPermission(): Promise<{ isEnabled: boolean }> { return; } static hasPermission(): Promise<{ isEnabled: boolean }> { return; }

9
src/plugins/safari-view-controller.ts
View File

@ -49,13 +49,15 @@ export class SafariViewController {
/** /**
* Checks if SafariViewController is available * Checks if SafariViewController is available
* @returns {Promise<boolean>}
*/ */
@Cordova() @Cordova()
static isAvailable(): Promise<boolean> { return; } static isAvailable(): Promise<boolean> { return; }
/** /**
* Shows Safari View Controller * Shows Safari View Controller
* @param options * @param options {SafariViewControllerOptions} optional
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static show(options?: SafariViewControllerOptions): Promise<any> { return; } static show(options?: SafariViewControllerOptions): Promise<any> { return; }
@ -68,19 +70,22 @@ export class SafariViewController {
/** /**
* Tries to connect to the Chrome's custom tabs service. you must call this method before calling any of the other methods listed below. * Tries to connect to the Chrome's custom tabs service. you must call this method before calling any of the other methods listed below.
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static connectToService(): Promise<any> { return; } static connectToService(): Promise<any> { return; }
/** /**
* Call this method whenever there's a chance the user will open an external url. * Call this method whenever there's a chance the user will open an external url.
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static warmUp(): Promise<any> { return; } static warmUp(): Promise<any> { return; }
/** /**
* For even better performance optimization, call this methods if there's more than a 50% chance the user will open a certain URL. * For even better performance optimization, call this methods if there's more than a 50% chance the user will open a certain URL.
* @param url * @param url{string}
* @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static mayLaunchUrl(url: string): Promise<any> { return; } static mayLaunchUrl(url: string): Promise<any> { return; }

2
src/plugins/screen-orientation.ts
View File

@ -48,7 +48,7 @@ export class ScreenOrientation {
/** /**
* Lock the orientation to the passed value. * Lock the orientation to the passed value.
* See below for accepted values * See below for accepted values
* @param {orientation} The orientation which should be locked. Accepted values see table below. * @param orientation {string} The orientation which should be locked. Accepted values see table below.
*/ */
@Cordova({ sync: true }) @Cordova({ sync: true })
static lockOrientation(orientation: string): void { } static lockOrientation(orientation: string): void { }

2
src/plugins/screenshot.ts
View File

@ -32,6 +32,7 @@ export class Screenshot {
* @param {number} quality. Determines the quality of the screenshot. * @param {number} quality. Determines the quality of the screenshot.
* Default quality is set to 100. * Default quality is set to 100.
* @param {string} filename. Name of the file as stored on the storage * @param {string} filename. Name of the file as stored on the storage
* @returns {Promise<any>}
*/ */
static save(format?: string, quality?: number, filename?: string): Promise<any> { static save(format?: string, quality?: number, filename?: string): Promise<any> {
return new Promise<any>( return new Promise<any>(
@ -57,6 +58,7 @@ export class Screenshot {
* *
* @param {number} quality. Determines the quality of the screenshot. * @param {number} quality. Determines the quality of the screenshot.
* Default quality is set to 100. * Default quality is set to 100.
* @returns {Promise<any>}
*/ */
static URI(quality?: number): Promise<any> { static URI(quality?: number): Promise<any> {
return new Promise<any>( return new Promise<any>(

4
src/plugins/securestorage.ts
View File

@ -55,6 +55,7 @@ export class SecureStorage {
/** /**
* Creates a namespaced storage. * Creates a namespaced storage.
* @param store {string} * @param store {string}
* @returns {Promise<any>}
*/ */
create(store: string): Promise<any> { create(store: string): Promise<any> {
return new Promise((res, rej) => { return new Promise((res, rej) => {
@ -65,6 +66,7 @@ export class SecureStorage {
/** /**
* Gets a stored item * Gets a stored item
* @param reference {string} * @param reference {string}
* @returns {Promise<any>}
*/ */
@CordovaInstance({ @CordovaInstance({
callbackOrder: 'reverse' callbackOrder: 'reverse'
@ -75,6 +77,7 @@ export class SecureStorage {
* Stores a value * Stores a value
* @param reference {string} * @param reference {string}
* @param value {string} * @param value {string}
* @returns {Promise<any>}
*/ */
@CordovaInstance({ @CordovaInstance({
callbackOrder: 'reverse' callbackOrder: 'reverse'
@ -84,6 +87,7 @@ export class SecureStorage {
/** /**
* Removes a single stored item * Removes a single stored item
* @param reference {string} * @param reference {string}
* @returns {Promise<any>}
*/ */
@CordovaInstance({ @CordovaInstance({
callbackOrder: 'reverse' callbackOrder: 'reverse'

1
src/plugins/shake.ts
View File

@ -24,6 +24,7 @@ export class Shake {
/** /**
* Watch for shake gesture * Watch for shake gesture
* @param sensitivity {number} Optional sensitivity parameter. Defaults to 40 * @param sensitivity {number} Optional sensitivity parameter. Defaults to 40
* @returns {Observable<any>}
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,

2
src/plugins/sim.ts
View File

@ -29,7 +29,7 @@ import { Cordova, Plugin } from './plugin';
export class Sim { export class Sim {
/** /**
* Returns info from the SIM card. * Returns info from the SIM card.
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static getSimInfo(): Promise<any> { return; } static getSimInfo(): Promise<any> { return; }

26
src/plugins/socialsharing.ts
View File

@ -38,7 +38,7 @@ export class SocialSharing {
* @param subject {string} The subject * @param subject {string} The subject
* @param file {string|string[]} URL(s) to file(s) or image(s), local path(s) to file(s) or image(s), or base64 data of an image. Only the first file/image will be used on Windows Phone. * @param file {string|string[]} URL(s) to file(s) or image(s), local path(s) to file(s) or image(s), or base64 data of an image. Only the first file/image will be used on Windows Phone.
* @param url {string} A URL to share * @param url {string} A URL to share
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova() @Cordova()
static share(message?: string, subject?: string, file?: string|string[], url?: string): Promise<any> { return; } static share(message?: string, subject?: string, file?: string|string[], url?: string): Promise<any> { return; }
@ -46,7 +46,7 @@ export class SocialSharing {
/** /**
* 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+)
* @param options {object} The options object with the message, subject, files, url and chooserTitle properties. * @param options {object} The options object with the message, subject, files, url and chooserTitle properties.
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
platforms: ['iOS', 'Android'] platforms: ['iOS', 'Android']
@ -60,7 +60,7 @@ export class SocialSharing {
* @param subject {string} * @param subject {string}
* @param image {string} * @param image {string}
* @param url {string} * @param url {string}
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
successIndex: 5, successIndex: 5,
@ -74,7 +74,7 @@ export class SocialSharing {
* @param message {string} * @param message {string}
* @param image {string} * @param image {string}
* @param url {string} * @param url {string}
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
successIndex: 3, successIndex: 3,
@ -88,7 +88,7 @@ export class SocialSharing {
* @param message {string} * @param message {string}
* @param image {string} * @param image {string}
* @param url {string} * @param url {string}
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
successIndex: 3, successIndex: 3,
@ -104,7 +104,7 @@ export class SocialSharing {
* @param image {string} * @param image {string}
* @param url {string} * @param url {string}
* @param pasteMessageHint {string} * @param pasteMessageHint {string}
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
successIndex: 4, successIndex: 4,
@ -117,7 +117,7 @@ export class SocialSharing {
* Shares directly to Instagram * Shares directly to Instagram
* @param message {string} * @param message {string}
* @param image {string} * @param image {string}
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
platforms: ['iOS', 'Android'] platforms: ['iOS', 'Android']
@ -129,7 +129,7 @@ export class SocialSharing {
* @param message {string} * @param message {string}
* @param image {string} * @param image {string}
* @param url {string} * @param url {string}
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
successIndex: 3, successIndex: 3,
@ -144,7 +144,7 @@ export class SocialSharing {
* @param message {string} Message to send * @param message {string} Message to send
* @param image {string} Image to send (does not work on iOS * @param image {string} Image to send (does not work on iOS
* @param url {string} Link to send * @param url {string} Link to send
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
successIndex: 4, successIndex: 4,
@ -157,7 +157,7 @@ export class SocialSharing {
* Share via SMS * Share via SMS
* @param messge {string} message to send * @param messge {string} message to send
* @param phoneNumber {string} Number or multiple numbers seperated by commas * @param phoneNumber {string} Number or multiple numbers seperated by commas
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
platforms: ['iOS', 'Android'] platforms: ['iOS', 'Android']
@ -166,7 +166,7 @@ export class SocialSharing {
/** /**
* Checks if you can share via email * Checks if you can share via email
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
platforms: ['iOS', 'Android'] platforms: ['iOS', 'Android']
@ -181,7 +181,7 @@ export class SocialSharing {
* @param cc {string[]} Optional * @param cc {string[]} Optional
* @param bcc {string[]} Optional * @param bcc {string[]} Optional
* @param files {string|string[]} Optional URL or local path to file(s) to attach * @param files {string|string[]} Optional URL or local path to file(s) to attach
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
platforms: ['iOS', 'Android'], platforms: ['iOS', 'Android'],
@ -197,7 +197,7 @@ export class SocialSharing {
* @param subject {string} * @param subject {string}
* @param image {string} * @param image {string}
* @param url {string} * @param url {string}
* @returns {Promise} * @returns {Promise<any>}
*/ */
@Cordova({ @Cordova({
successIndex: 5, successIndex: 5,

49
src/plugins/sqlite.ts
View File

@ -51,6 +51,7 @@ export class SQLite {
* See the plugin docs for an explanation of all options: https://github.com/litehelpers/Cordova-sqlite-storage#opening-a-database * See the plugin docs for an explanation of all options: https://github.com/litehelpers/Cordova-sqlite-storage#opening-a-database
* *
* @param config the config for opening the database. * @param config the config for opening the database.
* @returns {Promise<any>}
* @usage * @usage
* *
* ```typescript * ```typescript
@ -95,12 +96,20 @@ export class SQLite {
}) })
addTransaction(transaction: any): void { } addTransaction(transaction: any): void { }
/**
* @param fn {any}
* @returns {Promise<any>}
*/
@CordovaInstance({ @CordovaInstance({
successIndex: 2, successIndex: 2,
errorIndex: 1 errorIndex: 1
}) })
transaction(fn: any): Promise<any> { return; } transaction(fn: any): Promise<any> { return; }
/**
* @param fn {any}
* @returns {Promise<any>}
*/
@CordovaInstance() @CordovaInstance()
readTransaction(fn: any): Promise<any> { return; } readTransaction(fn: any): Promise<any> { return; }
@ -109,6 +118,9 @@ export class SQLite {
}) })
startNextTransaction(): void { } startNextTransaction(): void { }
/**
* @returns {Promise<any>}
*/
@CordovaInstance() @CordovaInstance()
close(): Promise<any> { return; } close(): Promise<any> { return; }
@ -129,13 +141,25 @@ export class SQLite {
* // resultSet.rows.item(i) * // resultSet.rows.item(i)
* }, (err) => {}) * }, (err) => {})
* ``` * ```
* @param statement {string}
* @param params {any}
* @returns {Promise<any>}
*/ */
@CordovaInstance() @CordovaInstance()
executeSql(statement: string, params: any): Promise<any> { return; } executeSql(statement: string, params: any): Promise<any> { return; }
/**
* @param sql
* @param values
* @returns {Promise<any>}
*/
@CordovaInstance() @CordovaInstance()
addStatement(sql, values): Promise<any> { return; } addStatement(sql, values): Promise<any> { return; }
/**
* @param sqlStatements {any}
* @returns {Promise<any>}
*/
@CordovaInstance() @CordovaInstance()
sqlBatch(sqlStatements: any): Promise<any> { return; } sqlBatch(sqlStatements: any): Promise<any> { return; }
@ -144,12 +168,19 @@ export class SQLite {
}) })
abortallPendingTransactions(): void { } abortallPendingTransactions(): void { }
/**
@param handler
@param response
*/
@CordovaInstance({ @CordovaInstance({
sync: true sync: true
}) })
handleStatementSuccess(handler, response): void { } handleStatementSuccess(handler, response): void { }
/**
* @param handler
* @param response
*/
@CordovaInstance({ @CordovaInstance({
sync: true sync: true
}) })
@ -161,7 +192,9 @@ export class SQLite {
}) })
run(): void { } run(): void { }
/**
* @param txFailure
*/
@CordovaInstance({ @CordovaInstance({
sync: true sync: true
}) })
@ -173,16 +206,24 @@ export class SQLite {
}) })
finish(): void { } finish(): void { }
/**
* @param sqlerror
*/
@CordovaInstance({ @CordovaInstance({
sync: true sync: true
}) })
abortFromQ(sqlerror): void { } abortFromQ(sqlerror): void { }
/**
* @returns {Promise<any>}
*/
@Cordova() @Cordova()
static echoTest(): Promise<any> { return; } static echoTest(): Promise<any> { return; }
/**
* @param first
* @returns {Promise<any>}
*/
@Cordova() @Cordova()
static deleteDatabase(first): Promise<any> { return; } static deleteDatabase(first): Promise<any> { return; }

12
src/plugins/stepcounter.ts
View File

@ -32,42 +32,42 @@ export class Stepcounter {
* Start the step counter * Start the step counter
* *
* @param startingOffset {number} will be added to the total steps counted in this session * @param startingOffset {number} will be added to the total steps counted in this session
* @return {Promise} Returns a Promise that resolves on success or rejects on failure * @returns {Promise<any | number>} Returns a Promise that resolves on success or rejects on failure
*/ */
@Cordova() @Cordova()
static start(startingOffset: number): Promise<number | any> { return; } static start(startingOffset: number): Promise<number | any> { return; }
/** /**
* Stop the step counter * Stop the step counter
* @return {Promise} Returns a Promise that resolves on success with the amount of steps since the start command has been called, or rejects on failure * @returns {Promise<any | number>} Returns a Promise that resolves on success with the amount of steps since the start command has been called, or rejects on failure
*/ */
@Cordova() @Cordova()
static stop(): Promise<number | any> { return; } static stop(): Promise<number | any> { return; }
/** /**
* Get the amount of steps for today (or -1 if it no data given) * Get the amount of steps for today (or -1 if it no data given)
* @return {Promise} Returns a Promise that resolves on success with the amount of steps today, or rejects on failure * @returns {Promise<any | number>} Returns a Promise that resolves on success with the amount of steps today, or rejects on failure
*/ */
@Cordova() @Cordova()
static getTodayStepCount(): Promise<number | any> { return; } static getTodayStepCount(): Promise<number | any> { return; }
/** /**
* Get the amount of steps since the start command has been called * Get the amount of steps since the start command has been called
* @return {Promise} Returns a Promise that resolves on success with the amount of steps since the start command has been called, or rejects on failure * @returns {Promise<any | number>} Returns a Promise that resolves on success with the amount of steps since the start command has been called, or rejects on failure
*/ */
@Cordova() @Cordova()
static getStepCount(): Promise<number | any> { return; } static getStepCount(): Promise<number | any> { return; }
/** /**
* Returns true/false if Android device is running >API level 19 && has the step counter API available * Returns true/false if Android device is running >API level 19 && has the step counter API available
* @return {Promise} Returns a Promise that resolves on success, or rejects on failure * @returns {Promise<any | boolean>} Returns a Promise that resolves on success, or rejects on failure
*/ */
@Cordova() @Cordova()
static deviceCanCountSteps(): Promise<boolean | any> { return; } static deviceCanCountSteps(): Promise<boolean | any> { return; }
/** /**
* Get the step history (JavaScript object) * Get the step history (JavaScript object)
* @return {Promise} Returns a Promise that resolves on success, or rejects on failure * @returns {Promise<any>} Returns a Promise that resolves on success, or rejects on failure
*/ */
@Cordova() @Cordova()
static getHistory(): Promise<any> { return; } static getHistory(): Promise<any> { return; }

4
src/plugins/themeable-browser.ts
View File

@ -183,6 +183,7 @@ export class ThemeableBrowser {
/** /**
* Injects JavaScript code into the browser window. * Injects JavaScript code into the browser window.
* @param script Details of the script to run, specifying either a file or code key. * @param script Details of the script to run, specifying either a file or code key.
* @returns {Promise<any>}
*/ */
@CordovaInstance() @CordovaInstance()
executeScript(script: {file?: string, code?: string}): Promise<any> {return; } executeScript(script: {file?: string, code?: string}): Promise<any> {return; }
@ -190,6 +191,7 @@ export class ThemeableBrowser {
/** /**
* Injects CSS into the browser window. * Injects CSS into the browser window.
* @param css Details of the script to run, specifying either a file or code key. * @param css Details of the script to run, specifying either a file or code key.
* @returns {Promise<any>}
*/ */
@CordovaInstance() @CordovaInstance()
insertCss(css: {file?: string, code?: string}): Promise<any> {return; } insertCss(css: {file?: string, code?: string}): Promise<any> {return; }
@ -198,7 +200,7 @@ export class ThemeableBrowser {
* 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.
* Available events are: `ThemeableBrowserError`, `ThemeableBrowserWarning`, `critical`, `loadfail`, `unexpected`, `undefined` * Available events are: `ThemeableBrowserError`, `ThemeableBrowserWarning`, `critical`, `loadfail`, `unexpected`, `undefined`
* @param event Event name * @param event Event name
* @returns {Observable<any>} Returns back an observable that will listen to the event on subscribe, and will stop listening to the event on unsubscribe. * @returns {Observable<InAppBrowserEvent>} Returns back an observable that will listen to the event on subscribe, and will stop listening to the event on unsubscribe.
*/ */
on(event: string): Observable<InAppBrowserEvent> { on(event: string): Observable<InAppBrowserEvent> {
return new Observable<InAppBrowserEvent>((observer) => { return new Observable<InAppBrowserEvent>((observer) => {

24
src/plugins/toast.ts
View File

@ -71,7 +71,7 @@ export class Toast {
* @param {string} message The message to display. * @param {string} message The message to display.
* @param {string} duration Duration to show the toast, either 'short', 'long' or any number of milliseconds: '1500'. * @param {string} duration Duration to show the toast, either 'short', 'long' or any number of milliseconds: '1500'.
* @param {string} position Where to position the toast, either 'top', 'center', or 'bottom'. * @param {string} position Where to position the toast, either 'top', 'center', or 'bottom'.
* @return {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error. * @returns {Observable<any>} Returns an Observable that notifies first on success and then when tapped, rejects on error.
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -85,7 +85,7 @@ export class Toast {
/** /**
* Manually hide any currently visible toast. * Manually hide any currently visible toast.
* @return {Promise} Returns a Promise that resolves on success. * @returns {Promise<any>} Returns a Promise that resolves on success.
*/ */
@Cordova() @Cordova()
static hide(): Promise<any> { return; } static hide(): Promise<any> { return; }
@ -99,7 +99,7 @@ export class Toast {
* position Where to position the toast, either 'top', 'center', or 'bottom'. * position Where to position the toast, either 'top', 'center', or 'bottom'.
* addPixelsY Offset in pixels to move the toast up or down from its specified position. * addPixelsY Offset in pixels to move the toast up or down from its specified position.
* *
* @return {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error. * @returns {Observable<any>} Returns an Observable that notifies first on success and then when tapped, rejects on error.
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -109,7 +109,8 @@ export class Toast {
/** /**
* Shorthand for `show(message, 'short', 'top')`. * Shorthand for `show(message, 'short', 'top')`.
* @return {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error. * @param message {string}
* @returns {Observable<any>} Returns an Observable that notifies first on success and then when tapped, rejects on error.
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -119,7 +120,8 @@ export class Toast {
/** /**
* Shorthand for `show(message, 'short', 'center')`. * Shorthand for `show(message, 'short', 'center')`.
* @return {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error. * @param message {string}
* @returns {Observable<any>} Returns an Observable that notifies first on success and then when tapped, rejects on error.
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -130,7 +132,8 @@ export class Toast {
/** /**
* Shorthand for `show(message, 'short', 'bottom')`. * Shorthand for `show(message, 'short', 'bottom')`.
* @return {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error. * @param message {string}
* @returns {Observable<any>} Returns an Observable that notifies first on success and then when tapped, rejects on error.
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -141,7 +144,8 @@ export class Toast {
/** /**
* Shorthand for `show(message, 'long', 'top')`. * Shorthand for `show(message, 'long', 'top')`.
* @return {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error. * @param message {string}
* @returns {Observable<any>} Returns an Observable that notifies first on success and then when tapped, rejects on error.
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -152,7 +156,8 @@ export class Toast {
/** /**
* Shorthand for `show(message, 'long', 'center')`. * Shorthand for `show(message, 'long', 'center')`.
* @return {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error. * @param message {string}
* @returns {Observable<any>} Returns an Observable that notifies first on success and then when tapped, rejects on error.
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,
@ -163,7 +168,8 @@ export class Toast {
/** /**
* Shorthand for `show(message, 'long', 'bottom')`. * Shorthand for `show(message, 'long', 'bottom')`.
* @return {Observable} Returns an Observable that notifies first on success and then when tapped, rejects on error. * @param message {string}
* @returns {Observable<any>} Returns an Observable that notifies first on success and then when tapped, rejects on error.
*/ */
@Cordova({ @Cordova({
observable: true, observable: true,

8
src/plugins/touchid.ts
View File

@ -56,7 +56,7 @@ export class TouchID {
/** /**
* Checks Whether TouchID is available or not. * Checks Whether TouchID is available or not.
* *
* @return {Promise} Returns a Promise that resolves if yes, rejects if no. * @returns {Promise<any>} Returns a Promise that resolves if yes, rejects if no.
*/ */
@Cordova() @Cordova()
static isAvailable(): Promise<any> { return; } static isAvailable(): Promise<any> { return; }
@ -65,7 +65,7 @@ export class TouchID {
* Show TouchID dialog and wait for a fingerprint scan. If user taps 'Enter Password' button, brings up standard system passcode screen. * Show TouchID dialog and wait for a fingerprint scan. If user taps 'Enter Password' button, brings up standard system passcode screen.
* *
* @param {string} message The message to display * @param {string} message The message to display
* @return {Promise} Returns a Promise the resolves if the fingerprint scan was successful, rejects with an error code (see above). * @returns {Promise<any>} Returns a Promise the resolves if the fingerprint scan was successful, rejects with an error code (see above).
*/ */
@Cordova() @Cordova()
static verifyFingerprint(message: string): Promise<any> { return; } static verifyFingerprint(message: string): Promise<any> { return; }
@ -74,7 +74,7 @@ export class TouchID {
* Show TouchID dialog and wait for a fingerprint scan. If user taps 'Enter Password' button, rejects with code '-3' (see above). * Show TouchID dialog and wait for a fingerprint scan. If user taps 'Enter Password' button, rejects with code '-3' (see above).
* *
* @param {string} message The message to display * @param {string} message The message to display
* @return {Promise} Returns a Promise the resolves if the fingerprint scan was successful, rejects with an error code (see above). * @returns {Promise<any>} Returns a Promise the resolves if the fingerprint scan was successful, rejects with an error code (see above).
*/ */
@Cordova() @Cordova()
static verifyFingerprintWithCustomPasswordFallback(message: string): Promise<any> { return; } static verifyFingerprintWithCustomPasswordFallback(message: string): Promise<any> { return; }
@ -84,7 +84,7 @@ export class TouchID {
* *
* @param {string} message The message to display * @param {string} message The message to display
* @param {string} enterPasswordLabel Custom text for the 'Enter Password' button * @param {string} enterPasswordLabel Custom text for the 'Enter Password' button
* @return {Promise} Returns a Promise the resolves if the fingerprint scan was successful, rejects with an error code (see above). * @returns {Promise<any>} Returns a Promise the resolves if the fingerprint scan was successful, rejects with an error code (see above).
*/ */
@Cordova() @Cordova()
static verifyFingerprintWithCustomPasswordFallbackAndEnterPasswordLabel(message: string, enterPasswordLabel: string): Promise<any> { return; } static verifyFingerprintWithCustomPasswordFallbackAndEnterPasswordLabel(message: string, enterPasswordLabel: string): Promise<any> { return; }

6
src/plugins/twitter-connect.ts
View File

@ -36,20 +36,20 @@ import { Plugin, Cordova } from './plugin';
export class TwitterConnect { export class TwitterConnect {
/** /**
* Logs in * Logs in
* @return {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()
static login(): Promise<TwitterConnectResponse> {return; } static login(): Promise<TwitterConnectResponse> {return; }
/** /**
* Logs out * Logs out
* @return {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()
static logout(): Promise<any> {return; } static logout(): Promise<any> {return; }
/** /**
* Returns user's profile information * Returns user's profile information
* @return {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()
static showUser(): Promise<any> {return; } static showUser(): Promise<any> {return; }

8
src/plugins/video-editor.ts
View File

@ -160,7 +160,7 @@ export class VideoEditor {
/** /**
* Transcode a video * Transcode a video
* @param options {TranscodeOptions} Options * @param options {TranscodeOptions} Options
* @return {Promise<string>} Returns a promise that resolves to the path of the transcoded video * @returns {Promise<string>} Returns a promise that resolves to the path of the transcoded video
*/ */
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'
@ -170,7 +170,7 @@ export class VideoEditor {
/** /**
* Trim a video * Trim a video
* @param options {TrimOptions} Options * @param options {TrimOptions} Options
* @return {Promise<string>} Returns a promise that resolves to the path of the trimmed video * @returns {Promise<string>} Returns a promise that resolves to the path of the trimmed video
*/ */
@Cordova({ @Cordova({
callbackOrder: 'reverse', callbackOrder: 'reverse',
@ -181,7 +181,7 @@ export class VideoEditor {
/** /**
* Create a JPEG thumbnail from a video * Create a JPEG thumbnail from a video
* @param options {CreateThumbnailOptions} Options * @param options {CreateThumbnailOptions} Options
* @return {Promise<string>} Returns a promise that resolves to the path to the jpeg image on the device * @returns {Promise<string>} Returns a promise that resolves to the path to the jpeg image on the device
*/ */
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'
@ -191,7 +191,7 @@ export class VideoEditor {
/** /**
* Get info on a video (width, height, orientation, duration, size, & bitrate) * Get info on a video (width, height, orientation, duration, size, & bitrate)
* @param options {GetVideoInfoOptions} Options * @param options {GetVideoInfoOptions} Options
* @return {Promise<VideoInfo>} Returns a promise that resolves to an object containing info on the video * @returns {Promise<VideoInfo>} Returns a promise that resolves to an object containing info on the video
*/ */
@Cordova({ @Cordova({
callbackOrder: 'reverse' callbackOrder: 'reverse'

22
src/plugins/webintent.ts
View File

@ -35,21 +35,43 @@ export class WebIntent {
return window.plugins.webintent.EXTRA_TEXT; return window.plugins.webintent.EXTRA_TEXT;
} }
/**
* @param options {Object} { action: any, url: string, type?: string }
* @returns {Promise<any>}
*/
@Cordova() @Cordova()
static startActivity(options: { action: any, url: string, type?: string }): Promise<any> { return; } static startActivity(options: { action: any, url: string, type?: string }): Promise<any> { return; }
/**
* @param extra {any}
* @returns {Promise<any>}
*/
@Cordova() @Cordova()
static hasExtra(extra: any): Promise<any> { return; } static hasExtra(extra: any): Promise<any> { return; }
/**
* @param extra {any}
* @returns {Promise<any>}
*/
@Cordova() @Cordova()
static getExtra(extra: any): Promise<any> { return; } static getExtra(extra: any): Promise<any> { return; }
/**
* @returns {Promise<any>}
*/
@Cordova() @Cordova()
static getUri(): Promise<string> { return; }; static getUri(): Promise<string> { return; };
/**
* @returns {Promise<string>}
*/
@Cordova() @Cordova()
static onNewIntent(): Promise<string> { return; }; static onNewIntent(): Promise<string> { return; };
/**
* @param options {Object} { action: string, extras?: { option: boolean } }
* @returns {Promise<any>}
*/
@Cordova() @Cordova()
static sendBroadcast(options: { action: string, extras?: { option: boolean } }): Promise<any> { return; } static sendBroadcast(options: { action: string, extras?: { option: boolean } }): Promise<any> { return; }

2
src/plugins/z-bar.ts
View File

@ -50,7 +50,7 @@ export class ZBar {
/** /**
* Open the scanner * Open the scanner
* @param options { ZBarOptions } Scan options * @param options { ZBarOptions } Scan options
* @return Returns a Promise that resolves with the scanned string, or rejects with an error. * @returns {Promise<any>} Returns a Promise that resolves with the scanned string, or rejects with an error.
*/ */
@Cordova() @Cordova()
static scan(options: ZBarOptions): Promise<any> { return; } static scan(options: ZBarOptions): Promise<any> { return; }

2
src/plugins/zip.ts
View File

@ -29,7 +29,7 @@ export class Zip {
* @param sourceZip {string} Source ZIP file * @param sourceZip {string} Source ZIP file
* @param destUrl {string} Destination folder * @param destUrl {string} Destination folder
* @param onProgress {Function} optional callback to be called on progress update * @param onProgress {Function} optional callback to be called on progress update
* @return {Promise<number>} returns a promise that resolves with a number. 0 is success, -1 is error * @returns {Promise<number>} returns a promise that resolves with a number. 0 is success, -1 is error
*/ */
@Cordova({ @Cordova({
successIndex: 2, successIndex: 2,