UNPKG

1.24 kBTypeScriptView Raw
1/**
2 * @name DeviceFeedback
3 * @description
4 *
5 * Plugin that lets you provide haptic or acoustic feedback on Android devices.
6 *
7 * @usage
8 * ```
9 * import { DeviceFeedback } from 'ionic-native';
10 *
11 * DeviceFeedback.acoustic();
12 *
13 * DeviceFeedback.haptic(0);
14 *
15 * DeviceFeedback.isFeedbackEnabled()
16 * .then((feedback) => {
17 * console.log(feedback);
18 * // {
19 * // acoustic: true,
20 * // haptic: true
21 * // }
22 * });
23 *
24 * ```
25 */
26export declare class DeviceFeedback {
27 /**
28 * Provide sound feedback to user, nevertheless respect user's settings and current active device profile as native feedback do.
29 */
30 static acoustic(): void;
31 /**
32 * Provide vibrate feedback to user, nevertheless respect user's tactile feedback setting as native feedback do.
33 * @param type {Number} Specify type of vibration feedback. 0 for long press, 1 for virtual key, or 3 for keyboard tap.
34 */
35 static haptic(type: number): void;
36 /**
37 * Check if haptic and acoustic feedback is enabled by user settings.
38 * @returns {Promise<any>}
39 */
40 static isFeedbackEnabled(): Promise<{
41 haptic: boolean;
42 acoustic: boolean;
43 }>;
44}