CapturedText


public final class CapturedText
extends Object implements Parcelable

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

class CapturedText.Builder

Builder for CapturedText

Inherited constants

Fields

public static final Creator<CapturedText> 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.

String getResourceId()

Returns the view's fully qualified resource ID.

String getViewId()

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

Rect getViewNodeBoundingBox()

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

String getViewNodeDescription()

Returns the accessibility content description of the UI element.

long getViewNodeLastSeenMillis()

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

long getViewNodeLastUpdatedMillis()

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

String getViewNodeText()

Returns the actual text from the UI element.

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

Fields

CREATOR

Added in version 37.2
public static final Creator<CapturedText> CREATOR

Public methods

describeContents

Added in version 37.2
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

Added in version 37.2
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: the reference object with which to compare.

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

getResourceId

Added in version 37.2
public String getResourceId ()

Returns the view's fully qualified resource ID.

Returns
String This value cannot be null.

getViewId

Added in version 37.2
public String getViewId ()

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

Returns
String This value cannot be null.

getViewNodeBoundingBox

Added in version 37.2
public Rect getViewNodeBoundingBox ()

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

Returns
Rect This value cannot be null.

getViewNodeDescription

Added in version 37.2
public String getViewNodeDescription ()

Returns the accessibility content description of the UI element.

Returns
String This value cannot be null.

getViewNodeLastSeenMillis

Added in version 37.2
public long getViewNodeLastSeenMillis ()

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.

Returns
long

getViewNodeLastUpdatedMillis

Added in version 37.2
public long getViewNodeLastUpdatedMillis ()

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

Returns
long

getViewNodeText

Added in version 37.2
public String getViewNodeText ()

Returns the actual text from the UI element.

Returns
String This value cannot be null.

hashCode

Added in version 37.2
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.

toString

Added in version 37.2
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in version 37.2
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: