PromptInsight


public final class PromptInsight
extends ContextInsight

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

class PromptInsight.Builder

Builder for PromptInsight

Public methods

boolean equals(Object o)

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

int getCount()

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

InsightDisplayDetails getDetails()

Returns the InsightDisplayDetails of this insight.

PendingIntent getPromptIntent()

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

boolean hasCount()

Returns a boolean indicating if a count was provided.

int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

Inherited methods

Public methods

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.

getCount

Added in version 37.2
public int getCount ()

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

Returns
int

getDetails

Added in version 37.2
public InsightDisplayDetails getDetails ()

Returns the InsightDisplayDetails of this insight.

Returns
InsightDisplayDetails This value cannot be null.

getPromptIntent

Added in version 37.2
public PendingIntent getPromptIntent ()

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

Returns
PendingIntent This value may be null.

hasCount

Added in version 37.2
public boolean hasCount ()

Returns a boolean indicating if a count was provided.

Returns
boolean

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.