stream-chat-android-core/io.getstream.chat.android.models/DraftMessage

DraftMessage

@Immutable

data class DraftMessage( val id: String = "", val cid: String = "", val text: String = "", val parentId: String? = null, val attachments: List<Attachment> = listOf(), val mentionedUsersIds: List<String> = listOf(), val extraData: Map<String, Any> = mapOf(), val silent: Boolean = false, val showInChannel: Boolean = false, val replyMessage: Message? = null) : CustomObject, ComparableFieldProvider

Model holding data about a draft message.

Constructors

constructor( id: String = "", cid: String = "", text: String = "", parentId: String? = null, attachments: List<Attachment> = listOf(), mentionedUsersIds: List<String> = listOf(), extraData: Map<String, Any> = mapOf(), silent: Boolean = false, showInChannel: Boolean = false, replyMessage: Message? = null)

Types

Properties

val attachments: List<Attachment>

The list of message attachments

val cid: String

Channel unique identifier in : format

open override val extraData: Map<String, Any>

All the custom data provided for this message

The unique string identifier of the message. This is either created by Stream or set on the client side when the message is added.

mentionedUsersIds

val mentionedUsersIds: List<String>

The list of user mentioned in the message

val parentId: String? = null

The ID of the parent message, if the message is a thread reply

val replyMessage: Message? = null

The message that is being replied to.

val showInChannel: Boolean = false

Whether thread reply should be shown in the channel as well

val silent: Boolean = false

Whether message is silent or not

val text: String

The text of this message

Functions

getComparableField

open override fun getComparableField(fieldName: String): Comparable<*>?

Gets a comparable fields from a name.

fun identifierHash(): Long

Identifier of message. The message can't be considered the same if the id of the message AND the id of a quoted message are not the same.

fun newBuilder(): DraftMessage.Builder

open override fun toString(): String

Inherited functions

open fun <T> getExtraValue(key: String, default: T): T

Returns the value associated with the given key, or default if the key is not present in the extraData.