awesome-cordova-plugins/src/@ionic-native/plugins/vibration/index.ts
Daniel Sogl 328e5de3f3 docs(plugins): added platforms (#1638)
* added platforms

* round 2

* round 3

* Update index.ts
2017-06-02 15:34:18 -04:00

51 lines
1.4 KiB
TypeScript

import { Injectable } from '@angular/core';
import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
/**
* @name Vibration
* @description Vibrates the device
* @usage
* ```typescript
* import { Vibration } from '@ionic-native/vibration';
*
* constructor(private vibration: Vibration) { }
*
* ...
*
* // Vibrate the device for a second
* // Duration is ignored on iOS.
* this.vibration.vibrate(1000);
*
* // Vibrate 2 seconds
* // Pause for 1 second
* // Vibrate for 2 seconds
* // Patterns work on Android and Windows only
* this.vibration.vibrate([2000,1000,2000]);
*
* // Stop any current vibrations immediately
* // Works on Android and Windows only
* this.vibration.vibrate(0);
* ```
*/
@Plugin({
pluginName: 'Vibration',
plugin: 'cordova-plugin-vibration',
pluginRef: 'navigator',
repo: 'https://github.com/apache/cordova-plugin-vibration',
platforms: ['Android', 'BlackBerry 10', 'Firefox OS', 'iOS', 'Tizen', 'Ubuntu', 'Windows', 'Windows Phone']
})
@Injectable()
export class Vibration extends IonicNativePlugin {
/**
* 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
})
vibrate(time: number | Array<number>) { }
}