RecentViewHint


class RecentViewHint : ContextHint
kotlin.Any
   ↳ android.app.personalcontext.hint.ContextHint
   ↳ android.app.personalcontext.hint.RecentViewHint

A hint that provides information about text content that is currently or was recently visible on the user's screen.

This data originates from the Android Content Capture framework.

Summary

Nested classes

Builder used to create a RecentViewHint.

Public methods
Boolean
equals(other: Any?)

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

MutableList<CapturedText!>

Returns a list of CapturedText objects, each representing a piece of text captured from a UI element on the screen.

String?

Get the locus ID associated with the hint.

ComponentName

Get the component name of the source app activity associated with the hint.

Int

Returns a hash code value for the object.

String

Returns a string representation of the object.

Inherited functions

Public methods

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.

getCapturedTexts

fun getCapturedTexts(): MutableList<CapturedText!>

Returns a list of CapturedText objects, each representing a piece of text captured from a UI element on the screen.

Return
MutableList<CapturedText!> This value cannot be null.

getLocusId

fun getLocusId(): String?

Get the locus ID associated with the hint.

Return
String? This value may be null.

getSourceAppActivityComponentName

fun getSourceAppActivityComponentName(): ComponentName

Get the component name of the source app activity associated with the hint.

Return
ComponentName 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.