Added in API level 3

HapticFeedbackConstants

Kotlin |Java

public class HapticFeedbackConstants
extends Object

java.lang.Object
↳	android.view.HapticFeedbackConstants

Constants to be used to perform haptic feedback effects via View#performHapticFeedback(int)

Summary

Constants
`int`	`CLOCK_TICK` The user has pressed either an hour or minute tick of a Clock.
`int`	`CONFIRM` A haptic effect to signal the confirmation or successful completion of a user interaction.
`int`	`CONTEXT_CLICK` The user has performed a context click on an object.
`int`	`DRAG_START` The user has started a drag-and-drop gesture.
`int`	`FLAG_IGNORE_GLOBAL_SETTING` This constant was deprecated in API level 33. Starting from `Build.VERSION_CODES.TIRAMISU` only privileged apps can ignore user settings for touch feedback.
`int`	`FLAG_IGNORE_VIEW_SETTING` Flag for `View.performHapticFeedback(int, int)`: Ignore the setting in the view for whether to perform haptic feedback, do it always.
`int`	`GESTURE_END` The user has finished a gesture (e.g. on the soft keyboard).
`int`	`GESTURE_START` The user has started a gesture (e.g. on the soft keyboard).
`int`	`GESTURE_THRESHOLD_ACTIVATE` The user is executing a swipe/drag-style gesture, such as pull-to-refresh, where the gesture action is \u201celigible\u201d at a certain threshold of movement, and can be cancelled by moving back past the threshold.
`int`	`GESTURE_THRESHOLD_DEACTIVATE` The user is executing a swipe/drag-style gesture, such as pull-to-refresh, where the gesture action is \u201celigible\u201d at a certain threshold of movement, and can be cancelled by moving back past the threshold.
`int`	`KEYBOARD_PRESS` The user has pressed a virtual or software keyboard key.
`int`	`KEYBOARD_RELEASE` The user has released a virtual keyboard key.
`int`	`KEYBOARD_TAP` The user has pressed a soft keyboard key.
`int`	`LONG_PRESS` The user has performed a long press on an object that is resulting in an action being performed.
`int`	`NO_HAPTICS` No haptic feedback should be performed.
`int`	`REJECT` A haptic effect to signal the rejection or failure of a user interaction.
`int`	`SEGMENT_FREQUENT_TICK` The user is switching between a series of many potential choices, for example minutes on a clock face, or individual percentages.
`int`	`SEGMENT_TICK` The user is switching between a series of potential choices, for example items in a list or discrete points on a slider.
`int`	`TEXT_HANDLE_MOVE` The user has performed a selection/insertion handle move on text field.
`int`	`TOGGLE_OFF` The user has toggled a switch or button into the off position.
`int`	`TOGGLE_ON` The user has toggled a switch or button into the on position.
`int`	`VIRTUAL_KEY` The user has pressed on a virtual on-screen key.
`int`	`VIRTUAL_KEY_RELEASE` The user has released a virtual key.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Constants

CLOCK_TICK

Added in API level 21

public static final int CLOCK_TICK

The user has pressed either an hour or minute tick of a Clock.

Constant Value: 4 (0x00000004)

CONFIRM

Added in API level 30

public static final int CONFIRM

A haptic effect to signal the confirmation or successful completion of a user interaction.

Constant Value: 16 (0x00000010)

CONTEXT_CLICK

Added in API level 23

public static final int CONTEXT_CLICK

The user has performed a context click on an object.

Constant Value: 6 (0x00000006)

DRAG_START

Added in API level 34

public static final int DRAG_START

The user has started a drag-and-drop gesture. The drag target has just been "picked up".

Constant Value: 25 (0x00000019)

FLAG_IGNORE_GLOBAL_SETTING

Added in API level 3
Deprecated in API level 33

public static final int FLAG_IGNORE_GLOBAL_SETTING

This constant was deprecated in API level 33.
Starting from Build.VERSION_CODES.TIRAMISU only privileged apps can ignore user settings for touch feedback.

Flag for View.performHapticFeedback(int, int): Ignore the global setting for whether to perform haptic feedback, do it always.

Constant Value: 2 (0x00000002)

FLAG_IGNORE_VIEW_SETTING

Added in API level 3

public static final int FLAG_IGNORE_VIEW_SETTING

Flag for View.performHapticFeedback(int, int): Ignore the setting in the view for whether to perform haptic feedback, do it always.

Constant Value: 1 (0x00000001)

GESTURE_END

Added in API level 30

public static final int GESTURE_END

The user has finished a gesture (e.g. on the soft keyboard).

Constant Value: 13 (0x0000000d)

GESTURE_START

Added in API level 30

public static final int GESTURE_START

The user has started a gesture (e.g. on the soft keyboard).

Constant Value: 12 (0x0000000c)

GESTURE_THRESHOLD_ACTIVATE

Added in API level 34

public static final int GESTURE_THRESHOLD_ACTIVATE

The user is executing a swipe/drag-style gesture, such as pull-to-refresh, where the gesture action is \u201celigible\u201d at a certain threshold of movement, and can be cancelled by moving back past the threshold. This constant indicates that the user's motion has just passed the threshold for the action to be activated on release.

See also:

GESTURE_THRESHOLD_DEACTIVATE

Constant Value: 23 (0x00000017)

GESTURE_THRESHOLD_DEACTIVATE

Added in API level 34

public static final int GESTURE_THRESHOLD_DEACTIVATE

The user is executing a swipe/drag-style gesture, such as pull-to-refresh, where the gesture action is \u201celigible\u201d at a certain threshold of movement, and can be cancelled by moving back past the threshold. This constant indicates that the user's motion has just re-crossed back "under" the threshold for the action to be activated, meaning the gesture is currently in a cancelled state.

See also:

GESTURE_THRESHOLD_ACTIVATE

Constant Value: 24 (0x00000018)

KEYBOARD_PRESS

Added in API level 27

public static final int KEYBOARD_PRESS

The user has pressed a virtual or software keyboard key.

Constant Value: 3 (0x00000003)

KEYBOARD_RELEASE

Added in API level 27

public static final int KEYBOARD_RELEASE

The user has released a virtual keyboard key.

Constant Value: 7 (0x00000007)

KEYBOARD_TAP

Added in API level 8

public static final int KEYBOARD_TAP

The user has pressed a soft keyboard key.

Constant Value: 3 (0x00000003)

LONG_PRESS

Added in API level 3

public static final int LONG_PRESS

The user has performed a long press on an object that is resulting in an action being performed.

Constant Value: 0 (0x00000000)

NO_HAPTICS

Added in API level 34

public static final int NO_HAPTICS

No haptic feedback should be performed. Applications may use this value to indicate skipping a call to View#performHapticFeedback entirely, or else rely that it will immediately return false.

Constant Value: -1 (0xffffffff)

REJECT

Added in API level 30

public static final int REJECT

A haptic effect to signal the rejection or failure of a user interaction.

Constant Value: 17 (0x00000011)

SEGMENT_FREQUENT_TICK

Added in API level 34

public static final int SEGMENT_FREQUENT_TICK

The user is switching between a series of many potential choices, for example minutes on a clock face, or individual percentages. This constant is expected to be very soft, so as not to be uncomfortable when performed a lot in quick succession. If the device can\u2019t make a suitably soft vibration, then it may not make any vibration.

Some specializations of this constant exist for specific actions, notably CLOCK_TICK and TEXT_HANDLE_MOVE.

SEGMENT_TICK

Added in API level 34

public static final int SEGMENT_TICK

The user is switching between a series of potential choices, for example items in a list or discrete points on a slider.

See also SEGMENT_FREQUENT_TICK for cases where density of choices is high, and the haptics should be lighter or suppressed for a better user experience.

Constant Value: 26 (0x0000001a)

TEXT_HANDLE_MOVE

Added in API level 27

public static final int TEXT_HANDLE_MOVE

The user has performed a selection/insertion handle move on text field.

Constant Value: 9 (0x00000009)

TOGGLE_OFF

Added in API level 34

public static final int TOGGLE_OFF

The user has toggled a switch or button into the off position.

Constant Value: 22 (0x00000016)

TOGGLE_ON

Added in API level 34

public static final int TOGGLE_ON

The user has toggled a switch or button into the on position.

Constant Value: 21 (0x00000015)

VIRTUAL_KEY

Added in API level 5

public static final int VIRTUAL_KEY

The user has pressed on a virtual on-screen key.

Constant Value: 1 (0x00000001)

VIRTUAL_KEY_RELEASE

Added in API level 27

public static final int VIRTUAL_KEY_RELEASE

The user has released a virtual key.

Constant Value: 8 (0x00000008)