-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) {} | ||
|
||
} |