ConversationData
class ConversationData : Parcelable
| kotlin.Any | |
| ↳ | 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 | |
|---|---|
|
Builder for |
|
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| Boolean |
Indicates whether some other object is "equal to" this one. |
| MutableList<ChatMessageData!> |
Returns the chat messages in the conversation. |
| ComponentName |
Returns the component name of the activity that contains the conversation. |
| String |
Returns the title of the conversation. |
| AutofillId? |
Returns the autofill id of the input box in the conversation. |
| String |
Returns the text in the input box. |
| Long |
Returns the timestamp when the conversation finished processing in milliseconds since epoch. |
| Long |
Returns the timestamp when the message was first seen and the processing of the conversation started in milliseconds since epoch. |
| Boolean |
Returns whether there is a new message in view. |
| Int |
hashCode()Returns a hash code value for the object. |
| Boolean |
Returns whether the keyboard was shown at the time the conversation was parsed. |
| Boolean |
Returns whether the last message in the conversation is from the user. |
| String |
toString()Returns a string representation of the object. |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<ConversationData!> | |
Public methods
describeContents
fun describeContents(): Int
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.
| Return | |
|---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or
|
equals
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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
fun getChatMessages(): MutableList<ChatMessageData!>
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.
| Return | |
|---|---|
MutableList<ChatMessageData!> |
This value cannot be null. |
getComponentName
fun getComponentName(): ComponentName
Returns the component name of the activity that contains the conversation.
| Return | |
|---|---|
ComponentName |
This value cannot be null. |
getConversationTitle
fun getConversationTitle(): String
Returns the title of the conversation.
| Return | |
|---|---|
String |
This value cannot be null. |
getInputBoxAutofillId
fun getInputBoxAutofillId(): AutofillId?
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.
getInputBoxText
fun getInputBoxText(): String
Returns the text in the input box.
| Return | |
|---|---|
String |
This value cannot be null. |
getProcessingEndTimestampMillis
fun getProcessingEndTimestampMillis(): Long
Returns the timestamp when the conversation finished processing in milliseconds since epoch.
getProcessingStartTimestampMillis
fun getProcessingStartTimestampMillis(): Long
Returns the timestamp when the message was first seen and the processing of the conversation started in milliseconds since epoch.
hasNewMessage
fun hasNewMessage(): Boolean
Returns whether there is a new message in view.
hashCode
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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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. |
isKeyboardShown
fun isKeyboardShown(): Boolean
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.
isLastMessageFromTheUser
fun isLastMessageFromTheUser(): Boolean
Returns whether the last message in the conversation is from the user.
toString
fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
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_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following:
|