-
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.
feat(device-feedback): add DeviceFeedback plugin (#696)
- Loading branch information
Showing
2 changed files
with
57 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
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,54 @@ | ||
import {Plugin, Cordova} from './plugin'; | ||
/** | ||
* @name DeviceFeedback | ||
* @description | ||
* | ||
* Plugin that lets you provide haptic or acoustic feedback on Android devices. | ||
* | ||
* @usage | ||
* ``` | ||
* import { DeviceFeedback } from 'ionic-native'; | ||
* | ||
* DeviceFeedback.acoustic(); | ||
* | ||
* DeviceFeedback.haptic(0); | ||
* | ||
* DeviceFeedback.isFeedbackEnabled() | ||
* .then((feedback) => { | ||
* console.log(feedback); | ||
* // { | ||
* // acoustic: true, | ||
* // haptic: true | ||
* // } | ||
* }); | ||
* | ||
* ``` | ||
*/ | ||
@Plugin({ | ||
plugin: 'cordova-plugin-velda-devicefeedback', | ||
pluginRef: 'plugins.deviceFeedback', | ||
repo: 'https://github.com/VVelda/device-feedback', | ||
platforms: ['Android'] | ||
}) | ||
export class DeviceFeedback { | ||
|
||
/** | ||
* Provide sound feedback to user, nevertheless respect user's settings and current active device profile as native feedback do. | ||
*/ | ||
@Cordova({ sync: true }) | ||
static acoustic(): void { } | ||
|
||
/** | ||
* Provide vibrate feedback to user, nevertheless respect user's tactile feedback setting as native feedback do. | ||
* @param type {Number} Specify type of vibration feedback. 0 for long press, 1 for virtual key, or 3 for keyboard tap. | ||
*/ | ||
@Cordova({ sync: true }) | ||
static haptic(type: number): void { } | ||
|
||
/** | ||
* Check if haptic and acoustic feedback is enabled by user settings. | ||
*/ | ||
@Cordova() | ||
static isFeedbackEnabled(): Promise<{ haptic: boolean; acoustic: boolean; }> { return; } | ||
|
||
} |