Skip to content

Commit

Permalink
feat(plugin): add vibration
Browse files Browse the repository at this point in the history
  • Loading branch information
ihadeed committed Mar 13, 2016
1 parent 786cd21 commit 3cc4ee4
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions src/plugins/vibration.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
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) {}

}

0 comments on commit 3cc4ee4

Please sign in to comment.