UserInputText
public
final
class
UserInputText
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.app.personalcontext.hint.UserInputText |
Represents information about the text a user is actively typing or entering into an input field within an application.
This data is collected by the Content Capture framework by observing user interactions with input fields.
Summary
Nested classes | |
|---|---|
class |
UserInputText.Builder
Builder for |
Constants | |
|---|---|
int |
FIELD_TYPE_SEARCH_BOX
The user input is captured from a search box. |
int |
FIELD_TYPE_UNKNOWN
The field type is unknown. |
int |
USER_INPUT_TEXT_SOURCE_CLICKED
The user input text source is a clicked suggestion provided outside of the host application. |
int |
USER_INPUT_TEXT_SOURCE_INFERRED
The user input text source is not typed directly by the user, but inferred from the UI. |
int |
USER_INPUT_TEXT_SOURCE_TYPED
The user input text source is typed by the user. |
int |
USER_INPUT_TEXT_SOURCE_UNKNOWN
The user input text source is unknown. |
Inherited constants |
|---|
Fields | |
|---|---|
public
static
final
Creator<UserInputText> |
CREATOR
|
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
|
getFieldType()
Returns the type of the input field in which the user entered the text. |
String
|
getText()
Returns the text content entered by the user. |
int
|
getUserInputTextSource()
Returns the source of the user input text. |
Rect
|
getViewNodeBoundingBox()
Returns the screen relative bounding box of the input field. |
int
|
hashCode()
Returns a hash code value for the object. |
String
|
toString()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
Constants
FIELD_TYPE_SEARCH_BOX
public static final int FIELD_TYPE_SEARCH_BOX
The user input is captured from a search box.
Constant Value: 1 (0x00000001)
FIELD_TYPE_UNKNOWN
public static final int FIELD_TYPE_UNKNOWN
The field type is unknown.
Constant Value: 0 (0x00000000)
USER_INPUT_TEXT_SOURCE_CLICKED
public static final int USER_INPUT_TEXT_SOURCE_CLICKED
The user input text source is a clicked suggestion provided outside of the host application.
e.g. a clicked autofill suggestion in a messaging app.
Constant Value: 3 (0x00000003)
USER_INPUT_TEXT_SOURCE_INFERRED
public static final int USER_INPUT_TEXT_SOURCE_INFERRED
The user input text source is not typed directly by the user, but inferred from the UI.
e.g. text in a search box after tapping suggested text in the host application.
Constant Value: 2 (0x00000002)
USER_INPUT_TEXT_SOURCE_TYPED
public static final int USER_INPUT_TEXT_SOURCE_TYPED
The user input text source is typed by the user.
Constant Value: 1 (0x00000001)
USER_INPUT_TEXT_SOURCE_UNKNOWN
public static final int USER_INPUT_TEXT_SOURCE_UNKNOWN
The user input text source is unknown.
Constant Value: 0 (0x00000000)
Fields
Public methods
describeContents
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(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
|
equals
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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: the reference object with which to compare. |
| Returns | |
|---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getFieldType
public int getFieldType ()
Returns the type of the input field in which the user entered the text.
| Returns | |
|---|---|
int |
Value is one of the following: |
getText
public String getText ()
Returns the text content entered by the user.
| Returns | |
|---|---|
String |
This value cannot be null. |
getUserInputTextSource
public int getUserInputTextSource ()
Returns the source of the user input text.
| Returns | |
|---|---|
int |
Value is one of the following: |
getViewNodeBoundingBox
public Rect getViewNodeBoundingBox ()
Returns the screen relative bounding box of the input field.
| Returns | |
|---|---|
Rect |
This value cannot be null. |
hashCode
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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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. |
toString
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
String |
a string representation of the object. |
writeToParcel
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 the following:
|
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2026-08-28 UTC.