feat(taptic-engine): add missing functions and types

This commit is contained in:
Daniel 2018-09-18 22:35:58 +02:00
parent c0d8c99e8d
commit a6bcc9affd

View File

@ -1,5 +1,5 @@
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
import { Injectable } from '@angular/core'; import { Injectable } from '@angular/core';
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
/** /**
* @name Taptic Engine * @name Taptic Engine
@ -33,30 +33,63 @@ import { Injectable } from '@angular/core';
}) })
@Injectable() @Injectable()
export class TapticEngine extends IonicNativePlugin { export class TapticEngine extends IonicNativePlugin {
/** /**
* Use selection feedback generators to indicate a change in selection. * Use selection feedback generators to indicate a change in selection.
* @returns {Promise<any>} Returns a promise that resolves on success and rejects on error * @returns {Promise<any>} Returns a promise that resolves on success and rejects on error
*/ */
@Cordova() @Cordova()
selection(): Promise<any> { return; } selection(): Promise<any> {
return;
}
/** /**
* Use this to indicate success/failure/warning to the user. * Use this to indicate success/failure/warning to the user.
* @param options {Object} should be of the type { type: 'success' } (or 'warning'/'error') * @param options {Object} should be of the type { type: 'success' } (or 'warning'/'error')
* @param options.type {string} * @param {'success' | 'warning' | 'error'} options.type
* @returns {Promise<any>} Returns a promise that resolves on success and rejects on error * @returns {Promise<any>} Returns a promise that resolves on success and rejects on error
*/ */
@Cordova() @Cordova()
notification(options: { type: string }): Promise<any> { return; } notification(options: {
type: 'success' | 'warning' | 'error';
}): Promise<any> {
return;
}
/** /**
* Use this to indicate success/failure/warning to the user. * Use this to indicate success/failure/warning to the user.
* @param options {Object} should be of the type { style: 'light' } (or 'medium'/'heavy') * @param options {Object} should be of the type { style: 'light' } (or 'medium'/'heavy')
* @param options.type {string} * @param {'light' | 'medium' | 'heavy'} options.type
* @returns {Promise<any>} Returns a promise that resolves on success and rejects on error * @returns {Promise<any>} Returns a promise that resolves on success and rejects on error
*/ */
@Cordova() @Cordova()
impact(options: { style: string }): Promise<any> { return; } impact(options: { style: 'light' | 'medium' | 'heavy' }): Promise<any> {
return;
}
/**
* Tell the taptic engine that a gesture for a selection change is starting.
* @returns {Promise<any>}
*/
@Cordova()
gestureSelectionStart(): Promise<any> {
return;
}
/**
* Tell the taptic engine that a selection changed during a gesture.
* @returns {Promise<any>}
*/
@Cordova()
gestureSelectionChanged(): Promise<any> {
return;
}
/**
* Tell the taptic engine we are done with a gesture. This needs to be called lest resources are not properly recycled.
* @returns {Promise<any>}
*/
@Cordova()
gestureSelectionEnd(): Promise<any> {
return;
}
} }