Added in API level 30

VerifiedKeyEvent

class VerifiedKeyEvent : VerifiedInputEvent, Parcelable
kotlin.Any
   ↳ android.view.VerifiedInputEvent
   ↳ android.view.VerifiedKeyEvent

KeyEvent that has been verified by the system. The data contained in this class is always a subset of a KeyEvent. Use this class to check which data has been confirmed by the system to be authentic. Most applications do not need to use this class. {@see android.hardware.input.InputManager#verifyInputEvent}

Summary

Inherited constants
Public methods
Int

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

Int

The action of this key event.

Long

Retrieve the time of the most recent key down event, in the android.os.SystemClock#uptimeMillis time base, but in nanoseconds.

Boolean?
getFlag(flag: Int)

Get a specific flag of this key event, if possible.

Int

Retrieve the key code of the key event.

Int

Returns the state of the meta keys.

Int

Retrieve the repeat count of the event.

Int

Retrieve the hardware key id of this key event.

Int

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Inherited functions
Properties
static Parcelable.Creator<VerifiedKeyEvent!>

Public methods

describeContents

Added in API level 30
fun describeContents(): Int
Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 30
fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj the reference object with which to compare.
o This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getAction

Added in API level 30
fun getAction(): Int

The action of this key event. May be either KeyEvent#ACTION_DOWN or KeyEvent#ACTION_UP.

Return
Int Value is android.view.KeyEvent#ACTION_DOWN, or android.view.KeyEvent#ACTION_UP

getDownTimeNanos

Added in API level 30
fun getDownTimeNanos(): Long

Retrieve the time of the most recent key down event, in the android.os.SystemClock#uptimeMillis time base, but in nanoseconds. If this is a down event, this will be the same as VerifiedInputEvent#getEventTimeNanos().

getFlag

Added in API level 30
fun getFlag(flag: Int): Boolean?

Get a specific flag of this key event, if possible. Return null if the flag value could not be checked.

Parameters
flag Int: the flag of interest
Return
Boolean? Boolean(true) if the key event has the requested flag Boolean(false) if the key event does not have the requested flag null if the flag value could not be checked

getKeyCode

Added in API level 30
fun getKeyCode(): Int

Retrieve the key code of the key event.

getMetaState

Added in API level 30
fun getMetaState(): Int

Returns the state of the meta keys.

Return
Int an integer in which each bit set to 1 represents a pressed meta key

getRepeatCount

Added in API level 30
fun getRepeatCount(): Int

Retrieve the repeat count of the event. For key down events, this is the number of times the key has repeated with the first down starting at 0 and counting up from there. For key up events, this is always equal to zero. For multiple key events, this is the number of down/up pairs that have occurred.

getScanCode

Added in API level 30
fun getScanCode(): Int

Retrieve the hardware key id of this key event. These values are not reliable and vary from device to device.

hashCode

Added in API level 30
fun hashCode(): Int
Return
Int a hash code value for this object.

writeToParcel

Added in API level 30
fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.
flags Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES

Properties

CREATOR

Added in API level 30
static val CREATOR: Parcelable.Creator<VerifiedKeyEvent!>