VerifiedKeyEvent

public final class VerifiedKeyEvent
extends VerifiedInputEvent implements Parcelable

java.lang.Object
   ↳ 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.

Summary

Inherited constants

Fields

public static final Creator<VerifiedKeyEvent> CREATOR

Inherited fields

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

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

int getAction()

The action of this key event.

long getDownTimeNanos()

Retrieve the time of the most recent key down event, in the SystemClock.uptimeMillis() time base, but in nanoseconds.

Boolean getFlag(int flag)

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

int getKeyCode()

Retrieve the key code of the key event.

int getMetaState()

Returns the state of the meta keys.

int getRepeatCount()

Retrieve the repeat count of the event.

int getScanCode()

Retrieve the hardware key id of this key event.

int hashCode()

Returns a hash code value for the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in API level 30
public static final Creator<VerifiedKeyEvent> CREATOR

Public methods

describeContents

Added in API level 30
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 30
public boolean equals (Object o)

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
o Object: This value may be null.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getAction

Added in API level 30
public int getAction ()

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

Returns
int Value is KeyEvent.ACTION_DOWN, or KeyEvent.ACTION_UP

getDownTimeNanos

Added in API level 30
public long getDownTimeNanos ()

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

Returns
long

getFlag

Added in API level 30
public Boolean getFlag (int flag)

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

Returns
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
public int getKeyCode ()

Retrieve the key code of the key event.

Returns
int

getMetaState

Added in API level 30
public int getMetaState ()

Returns the state of the meta keys.

Returns
int an integer in which each bit set to 1 represents a pressed meta key

getRepeatCount

Added in API level 30
public int getRepeatCount ()

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.

Returns
int

getScanCode

Added in API level 30
public int getScanCode ()

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

Returns
int

hashCode

Added in API level 30
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

writeToParcel

Added in API level 30
public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES