docs(): add beta tag

This commit is contained in:
Ibby 2017-01-20 16:10:39 -05:00
parent be20c51996
commit 23639ee859

View File

@ -1,4 +1,4 @@
import { Plugin, Cordova} from './plugin'; import { Plugin, Cordova } from './plugin';
export interface FingerprintOptions { export interface FingerprintOptions {
@ -14,26 +14,27 @@ export interface FingerprintOptions {
} }
/** /**
* @name FingerprintAIO * @beta
* @description * @name FingerprintAIO
* Use simple fingerprint authentication on Android and iOS. * @description
* Requires Cordova plugin: cordova-plugin-fingerprint-aio. For more info about plugin, vist: https://github.com/NiklasMerz/cordova-plugin-fingerprint-aio * Use simple fingerprint authentication on Android and iOS.
* * Requires Cordova plugin: cordova-plugin-fingerprint-aio. For more info about plugin, vist: https://github.com/NiklasMerz/cordova-plugin-fingerprint-aio
* @usage *
* ```typescript * @usage
* import { FingerprintAIO } from 'ionic-native'; * ```typescript
* * import { FingerprintAIO } from 'ionic-native';
* FingerprintAIO.show({ *
* clientId: "Fingerprint-Demo", * FingerprintAIO.show({
* clientSecret: "password" //Only necessary for Android * clientId: "Fingerprint-Demo",
* }) * clientSecret: "password" //Only necessary for Android
* .then((result: any) => console.log(any)) * })
* .catch((error: any) => console.log(error)); * .then((result: any) => console.log(any))
* * .catch((error: any) => console.log(error));
* ``` *
* @interfaces * ```
* FingerprintOptions * @interfaces
*/ * FingerprintOptions
*/
@Plugin({ @Plugin({
pluginName: 'FingerprintAIO', pluginName: 'FingerprintAIO',
plugin: 'cordova-plugin-fingerprint-aio', plugin: 'cordova-plugin-fingerprint-aio',
@ -48,9 +49,7 @@ export class FingerprintAIO {
* @return {Promise<any>} Returns a promise with result * @return {Promise<any>} Returns a promise with result
*/ */
@Cordova() @Cordova()
static isAvailable(): Promise<any> { static isAvailable(): Promise<any> { return; }
return;
}
/** /**
* Show authentication dialogue * Show authentication dialogue
@ -58,8 +57,6 @@ export class FingerprintAIO {
* @return {Promise<any>} Returns a promise that resolves when authentication was successfull * @return {Promise<any>} Returns a promise that resolves when authentication was successfull
*/ */
@Cordova() @Cordova()
static show(options: FingerprintOptions): Promise<any> { static show(options: FingerprintOptions): Promise<any> { return; }
return;
}
} }