UserInputText
class UserInputText : Parcelable
| kotlin.Any | |
| ↳ | 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 | |
|---|---|
|
Builder for |
|
| Constants | |
|---|---|
| static Int |
The user input is captured from a search box. |
| static Int |
The field type is unknown. |
| static Int |
The user input text source is a clicked suggestion provided outside of the host application. |
| static Int |
The user input text source is not typed directly by the user, but inferred from the UI. |
| static Int |
The user input text source is typed by the user. |
| static Int |
The user input text source is unknown. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| Int |
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 |
Returns the source of the user input text. |
| Rect |
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. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<UserInputText!> | |
Constants
FIELD_TYPE_SEARCH_BOX
static val FIELD_TYPE_SEARCH_BOX: Int
The user input is captured from a search box.
Value: 1FIELD_TYPE_UNKNOWN
static val FIELD_TYPE_UNKNOWN: Int
The field type is unknown.
Value: 0USER_INPUT_TEXT_SOURCE_CLICKED
static val USER_INPUT_TEXT_SOURCE_CLICKED: Int
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.
Value: 3USER_INPUT_TEXT_SOURCE_INFERRED
static val USER_INPUT_TEXT_SOURCE_INFERRED: Int
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.
Value: 2USER_INPUT_TEXT_SOURCE_TYPED
static val USER_INPUT_TEXT_SOURCE_TYPED: Int
The user input text source is typed by the user.
Value: 1USER_INPUT_TEXT_SOURCE_UNKNOWN
static val USER_INPUT_TEXT_SOURCE_UNKNOWN: Int
The user input text source is unknown.
Value: 0Public methods
describeContents
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
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 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 | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getFieldType
fun getFieldType(): Int
Returns the type of the input field in which the user entered the text.
| Return | |
|---|---|
Int |
Value is one of the following: |
getText
fun getText(): String
Returns the text content entered by the user.
| Return | |
|---|---|
String |
This value cannot be null. |
getUserInputTextSource
fun getUserInputTextSource(): Int
Returns the source of the user input text.
| Return | |
|---|---|
Int |
Value is one of the following: |
getViewNodeBoundingBox
fun getViewNodeBoundingBox(): Rect
Returns the screen relative bounding box of the input field.
| Return | |
|---|---|
Rect |
This value cannot be null. |
hashCode
fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.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.
| Return | |
|---|---|
Int |
a hash code value for this object. |
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
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 the following:
|