CapturedText


class CapturedText : Parcelable
kotlin.Any
   ↳ android.app.personalcontext.hint.CapturedText

Represents text content captured from a single UI element (a "view node") on the user's screen.

This data originates from the Android Content Capture framework.

Summary

Nested classes

Builder for CapturedText.

Inherited constants
Public methods
Int

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

Boolean
equals(other: Any?)

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

String

Returns the view's fully qualified resource ID.

String

Returns a unique identifier for the UI element (e.g., Autofill ID).

Rect

Returns the screen relative bounding box of the text element, in pixels.

String

Returns the accessibility content description of the UI element.

Long

Returns the timestamp when the view node was last seen on screen by the Content Capture framework in milliseconds since epoch.

Long

Returns the timestamp when the view node was last updated in milliseconds since epoch.

String

Returns the actual text from the UI element.

Int

Returns a hash code value for the object.

String

Returns a string representation of the object.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<CapturedText!>

Public 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 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.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getResourceId

fun getResourceId(): String

Returns the view's fully qualified resource ID.

Return
String This value cannot be null.

getViewId

fun getViewId(): String

Returns a unique identifier for the UI element (e.g., Autofill ID).

Return
String This value cannot be null.

getViewNodeBoundingBox

fun getViewNodeBoundingBox(): Rect

Returns the screen relative bounding box of the text element, in pixels.

Return
Rect This value cannot be null.

getViewNodeDescription

fun getViewNodeDescription(): String

Returns the accessibility content description of the UI element.

Return
String This value cannot be null.

getViewNodeLastSeenMillis

fun getViewNodeLastSeenMillis(): Long

Returns the timestamp when the view node was last seen on screen by the Content Capture framework in milliseconds since epoch. This is 0 for nodes that are still in the view hierarchy.

getViewNodeLastUpdatedMillis

fun getViewNodeLastUpdatedMillis(): Long

Returns the timestamp when the view node was last updated in milliseconds since epoch.

getViewNodeText

fun getViewNodeText(): String

Returns the actual text from the UI element.

Return
String 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 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.
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:

Properties

CREATOR

static val CREATOR: Parcelable.Creator<CapturedText!>