MessagesHint

Kotlin |Java

class MessagesHint : ContextHint

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

A hint that contains a list of chat messages from a single conversation.

Used by messaging applications to directly provide chat messages to generate personal context suggestions for.

Messages should all originate from a single conversation. Mixing messages from multiple conversations may cause insights to be generated that are not relevant to the conversation the user is viewing.

Summary

Nested classes
	`Builder` Builder used to create a `MessagesHint`.

Public methods
Boolean	`equals(other: Any?)` Indicates whether some other object is "equal to" this one.
MutableList<ChatMessageData!>	`getChatMessages()` Returns a list of `ChatMessageData` objects.
String	`getPackageName()` Returns the package name of the application the messages are from.
Int	`hashCode()` Returns a hash code value for the object.
String	`toString()` Returns a string representation of the object.

Inherited functions

From class ContextHint

`MutableSet<ContextHint!>`	`getAttributionHints()` Gets the attribution hints used to create this hint. This is empty for hints that have not been published yet.
`Long`	`getCreationTimeMillis()` Gets the time this hint was created in milliseconds since epoch.
`UUID`	`getHintId()` Returns the unique ID of this hint.
`String`	`getHintTypeName()` 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.
`Long`	`getPublishedTimeMillis()` Gets the time when the hint was published in milliseconds since epoch. This is 0 for hints that have not been published yet.
`String?`	`getPublishingPackage()` Gets the package name of the package that published this hint. This is null for hints that have not been published yet.

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.

getChatMessages

Added in API level 37.2

fun getChatMessages(): MutableList<ChatMessageData!>

Returns a list of ChatMessageData objects.

Return
`MutableList<ChatMessageData!>`	This value cannot be `null`.

getPackageName

Added in API level 37.2

fun getPackageName(): String

Returns the package name of the application the messages are from.

The understander may use this to tailor the content or format of suggestions based on the application that is providing the messages.

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

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.