Added in API level 37.2

PromptInsight

class PromptInsight : ContextInsight
kotlin.Any
   ↳ android.app.personalcontext.insight.ContextInsight
   ↳ android.app.personalcontext.insight.PromptInsight

An insight that acts as a stand-in for data that will be provided on-demand by the understander during disambiguation.

Some renderers will accept a PromptInsight as a placeholder instead of the final insight. When the user interacts with the PromptInsight (e.g. tapping on it), the renderer will ask the understander to disambiguate the insight. At this point the understander can present a UI to the user. Once the understander has finished dismabiguating, the resulting insight will be delivered to the renderer to handle in its place.

A PromptInsight must have display information to show to the user. It may also include a count of items the user can expect to see during that disambiguation step .

Summary

Nested classes

Builder for PromptInsight.
Public methods
Boolean
equals(other: Any?)

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

Gets a count of the number of options that will be presented.
InsightDisplayDetails

Returns the InsightDisplayDetails of this insight.
PendingIntent?

Returns the PendingIntent to launch when the user interacts with the prompt.
Boolean

Returns a boolean indicating if a count was provided.
Int

Returns a hash code value for the object.
String

Returns a string representation of the object.
Inherited functions

Public methods

equals

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

getCount

Added in API level 37.2
fun getCount(): Int

Gets a count of the number of options that will be presented. If hasCount() returns false then the value of this is meaningless.

getDetails

Added in API level 37.2
fun getDetails(): InsightDisplayDetails

Returns the InsightDisplayDetails of this insight.

Return
InsightDisplayDetails This value cannot be null.

getPromptIntent

Added in API level 37.2
fun getPromptIntent(): PendingIntent?

Returns the PendingIntent to launch when the user interacts with the prompt.

Return
PendingIntent? This value may be null.

hasCount

Added in API level 37.2
fun hasCount(): Boolean

Returns a boolean indicating if a count was provided.

hashCode

Added in API level 37.2
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

Added in API level 37.2
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.