ConversationData


public final class ConversationData
extends Object implements Parcelable

java.lang.Object
   ↳ android.app.personalcontext.hint.ConversationData


A snapshot of a conversation's data at a specific moment in time.

This data represents the state of a conversation as displayed on-screen in a messaging application. It includes not only the visible chat messages, but also contextual metadata about the conversation's UI, such as the app's ComponentName, the conversation title, the text in the input box, and whether the keyboard is visible.

Summary

Nested classes

class ConversationData.Builder

Builder for ConversationData

Inherited constants

Fields

public static final Creator<ConversationData> CREATOR

Public methods

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object o)

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

List<ChatMessageData> getChatMessages()

Returns the chat messages in the conversation.

ComponentName getComponentName()

Returns the component name of the activity that contains the conversation.

String getConversationTitle()

Returns the title of the conversation.

AutofillId getInputBoxAutofillId()

Returns the autofill id of the input box in the conversation.

String getInputBoxText()

Returns the text in the input box.

long getProcessingEndTimestampMillis()

Returns the timestamp when the conversation finished processing in milliseconds since epoch.

long getProcessingStartTimestampMillis()

Returns the timestamp when the message was first seen and the processing of the conversation started in milliseconds since epoch.

boolean hasNewMessage()

Returns whether there is a new message in view.

int hashCode()

Returns a hash code value for the object.

boolean isKeyboardShown()

Returns whether the keyboard was shown at the time the conversation was parsed.

boolean isLastMessageFromTheUser()

Returns whether the last message in the conversation is from the user.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Fields

CREATOR

Added in version 37.2
public static final Creator<ConversationData> CREATOR

Public methods

describeContents

Added in version 37.2
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

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.

getChatMessages

Added in version 37.2
public List<ChatMessageData> getChatMessages ()

Returns the chat messages in the conversation.

The list will be sorted by order of earliest appearance in the conversation, matching what the user sees in the UI. It is possible for this list to be empty.

Returns
List<ChatMessageData> This value cannot be null.

getComponentName

Added in version 37.2
public ComponentName getComponentName ()

Returns the component name of the activity that contains the conversation.

Returns
ComponentName This value cannot be null.

getConversationTitle

Added in version 37.2
public String getConversationTitle ()

Returns the title of the conversation.

Returns
String This value cannot be null.

getInputBoxAutofillId

Added in version 37.2
public AutofillId getInputBoxAutofillId ()

Returns the autofill id of the input box in the conversation.

This may be null if the input box was not found or if autofill is disabled.

Returns
AutofillId

getInputBoxText

Added in version 37.2
public String getInputBoxText ()

Returns the text in the input box.

Returns
String This value cannot be null.

getProcessingEndTimestampMillis

Added in version 37.2
public long getProcessingEndTimestampMillis ()

Returns the timestamp when the conversation finished processing in milliseconds since epoch.

Returns
long

getProcessingStartTimestampMillis

Added in version 37.2
public long getProcessingStartTimestampMillis ()

Returns the timestamp when the message was first seen and the processing of the conversation started in milliseconds since epoch.

Returns
long

hasNewMessage

Added in version 37.2
public boolean hasNewMessage ()

Returns whether there is a new message in view.

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.

isKeyboardShown

Added in version 37.2
public boolean isKeyboardShown ()

Returns whether the keyboard was shown at the time the conversation was parsed.

An understander can use this signal to determine how to best present results to avoid overlapping the keyboard.

Returns
boolean

isLastMessageFromTheUser

Added in version 37.2
public boolean isLastMessageFromTheUser ()

Returns whether the last message in the conversation is from the user.

Returns
boolean

toString

Added in version 37.2
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in version 37.2
public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest Parcel: This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.
Value is either 0 or a combination of the following: