ContextHint

Kotlin |Java

abstract class ContextHint

kotlin.Any
↳	android.app.personalcontext.hint.ContextHint

Known Direct Subclasses

AttributionHint, AutofillInlineRequestHint, CallHint, ConversationHint, InsightReferenceHint, MessagesHint, NotificationHint, RecentViewHint, TextClassificationHint, UserInputHint

AttributionHint	A hint representing a request to show attribution information for an insight.
AutofillInlineRequestHint	A hint representing an incoming request from the autofill framework for inline suggestions for use by augmented autofill.
CallHint	A hint that contains call related information (e.g. "phone call", "video call", etc.).
ConversationHint	A hint that contains a conversation-related event.
InsightReferenceHint	A hint that contains a reference to a `ContextInsight`.
MessagesHint	A hint that contains a list of chat messages from a single conversation.
NotificationHint	A hint that contains a notification-related event.
RecentViewHint	A hint that provides information about text content that is currently or was recently visible on the user's screen.
TextClassificationHint	A hint that contains a text classification request from selected text.
UserInputHint	A hint that provides information about the text a user is actively typing or entering into an input field.

A ContextHint holds information about the device or user that may be useful to an understander. Hints are forwarded to refiners and understanders in the personal context service. Refiners may emit new hints, based on existing hints. Understanders emit android.service.personalcontext.insight.ContextInsights.

This is an abstract base class for all hints. Only built-in hints classes are supported. Users of this class can use instanceof to determine the type of the hint.

Summary

Public methods
open Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
open MutableSet<ContextHint!>	`getAttributionHints()` Gets the attribution hints used to create this hint.
Long	`getCreationTimeMillis()` Gets the time this hint was created in milliseconds since epoch.
UUID	`getHintId()` Returns the unique ID of this hint.
open String	`getHintTypeName()` Gets the type name of the hint.
open Long	`getPublishedTimeMillis()` Gets the time when the hint was published in milliseconds since epoch.
open String?	`getPublishingPackage()` Gets the package name of the package that published this hint.
open Int	`hashCode()` Returns a hash code value for the object.
open String	`toString()` Returns a string representation of the object.

Public methods

equals

Added in API level 37.2

open 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.

getAttributionHints

Added in API level 37.2

open fun getAttributionHints(): MutableSet<ContextHint!>

Gets the attribution hints used to create this hint. This is empty for hints that have not been published yet.

Return
`MutableSet<ContextHint!>`	This value cannot be `null`.

getCreationTimeMillis

Added in API level 37.2

fun getCreationTimeMillis(): Long

Gets the time this hint was created in milliseconds since epoch.

getHintId

Added in API level 37.2

fun getHintId(): UUID

Returns the unique ID of this hint.

Return
`UUID`	This value cannot be `null`.

getHintTypeName

Added in API level 37.2

open fun getHintTypeName(): String

Gets the type name of the hint. For BundleHint this is the type name that was provided in the builder. For all other hints it is the canonical class name.

Return
`String`	This value cannot be `null`.

getPublishedTimeMillis

Added in API level 37.2

open fun getPublishedTimeMillis(): Long

Gets the time when the hint was published in milliseconds since epoch. This is 0 for hints that have not been published yet.

getPublishingPackage

Added in API level 37.2

open fun getPublishingPackage(): String?

Gets the package name of the package that published this hint. This is null for hints that have not been published yet.

hashCode

Added in API level 37.2

open 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

open fun toString(): String

Returns a string representation of the object.

Return
`String`	a string representation of the object.