awesome-cordova-plugins/src/plugins/vibration.ts

37 lines
965 B
TypeScript
Raw Normal View History

2016-03-14 03:53:03 +08:00
import {Plugin, Cordova} from './plugin'
/**
* @name Vibration
* @description Vibrates the device
* @usage
* ```ts
* // Vibrate the device for a second
* Vibration.vibrate(1000);
*
* // Vibrate 2 seconds
* // Pause for 1 second
* // Vibrate for 2 seconds
* // Patterns work on Android and Windows only
* Vibration.vibrate([2000,1000,2000]);
*
* // Stop any current vibrations immediately
* // Works on Android and Windows only
* Vibration.vibrate(0);
* ```
*/
@Plugin({
plugin: 'cordova-plugin-vibration',
pluginRef: 'navigator.vibrate',
repo: 'https://github.com/apache/cordova-plugin-vibration'
})
export class Vibration {
/**
* Vibrates the device for given amount of time.
* @param time {Number|Array<Number>} Milliseconds to vibrate the device. If passed an array of numbers, it will define a vibration pattern. Pass 0 to stop any vibration immediately.
*/
@Cordova({
sync: true
})
static vibrate(time : any) {}
}