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

Message

@Immutable

data class Message(val id: String = "", val cid: String = "", val text: String = "", val html: String = "", val parentId: String? = null, val command: String? = null, val attachments: List<Attachment> = listOf(), val mentionedUsersIds: List<String> = listOf(), val mentionedUsers: List<User> = listOf(), val replyCount: Int = 0, val deletedReplyCount: Int = 0, val reactionCounts: Map<String, Int> = mapOf(), val reactionScores: Map<String, Int> = mapOf(), val reactionGroups: Map<String, ReactionGroup> = mapOf(), val syncStatus: SyncStatus = SyncStatus.COMPLETED, val type: String = "", val latestReactions: List<Reaction> = listOf(), val ownReactions: List<Reaction> = listOf(), val createdAt: Date? = null, val updatedAt: Date? = null, val deletedAt: Date? = null, val updatedLocallyAt: Date? = null, var createdLocallyAt: Date? = null, val user: User = User(), val extraData: Map<String, Any> = mapOf(), val silent: Boolean = false, val shadowed: Boolean = false, val i18n: Map<String, String> = mapOf(), val showInChannel: Boolean = false, val channelInfo: ChannelInfo? = null, val replyTo: Message? = null, val replyMessageId: String? = null, val pinned: Boolean = false, val pinnedAt: Date? = null, val pinExpires: Date? = null, val pinnedBy: User? = null, val threadParticipants: List<User> = emptyList(), val skipPushNotification: Boolean = false, val skipEnrichUrl: Boolean = false, val moderationDetails: MessageModerationDetails? = null, val moderation: Moderation? = null, val messageTextUpdatedAt: Date? = null, val poll: Poll? = null, val restrictedVisibility: List<String> = emptyList()) : CustomObject, ComparableFieldProvider

Model holding data about a message.

Constructors

Message

constructor(id: String = "", cid: String = "", text: String = "", html: String = "", parentId: String? = null, command: String? = null, attachments: List<Attachment> = listOf(), mentionedUsersIds: List<String> = listOf(), mentionedUsers: List<User> = listOf(), replyCount: Int = 0, deletedReplyCount: Int = 0, reactionCounts: Map<String, Int> = mapOf(), reactionScores: Map<String, Int> = mapOf(), reactionGroups: Map<String, ReactionGroup> = mapOf(), syncStatus: SyncStatus = SyncStatus.COMPLETED, type: String = "", latestReactions: List<Reaction> = listOf(), ownReactions: List<Reaction> = listOf(), createdAt: Date? = null, updatedAt: Date? = null, deletedAt: Date? = null, updatedLocallyAt: Date? = null, createdLocallyAt: Date? = null, user: User = User(), extraData: Map<String, Any> = mapOf(), silent: Boolean = false, shadowed: Boolean = false, i18n: Map<String, String> = mapOf(), showInChannel: Boolean = false, channelInfo: ChannelInfo? = null, replyTo: Message? = null, replyMessageId: String? = null, pinned: Boolean = false, pinnedAt: Date? = null, pinExpires: Date? = null, pinnedBy: User? = null, threadParticipants: List<User> = emptyList(), skipPushNotification: Boolean = false, skipEnrichUrl: Boolean = false, moderationDetails: MessageModerationDetails? = null, moderation: Moderation? = null, messageTextUpdatedAt: Date? = null, poll: Poll? = null, restrictedVisibility: List<String> = emptyList())

Types

Builder

class Builder

Companion

object Companion

Properties

attachments

val attachments: List<Attachment>

The list of message attachments

channelInfo

val channelInfo: ChannelInfo? = null

Contains information about the channel where the message was sent.

cid

val cid: String

Channel unique identifier in : format

command

val command: String? = null

Contains provided slash command

createdAt

val createdAt: Date? = null

When the message was created

createdLocallyAt

var createdLocallyAt: Date?

When the message was created locally

deletedAt

val deletedAt: Date? = null

When the message was deleted

deletedReplyCount

val deletedReplyCount: Int = 0

The number of deleted replies to this message

extraData

open override val extraData: Map<String, Any>

All the custom data provided for this message

html

val html: String

The message text formatted as HTML

i18n

val i18n: Map<String, String>

Mapping with translations. Key language contains the original language key. Other keys contain translations.

val id: String

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

latestReactions

val latestReactions: List<Reaction>

List of the latest reactions to this message

mentionedUsers

val mentionedUsers: List<User>

The list of user mentioned in the message

mentionedUsersIds

val mentionedUsersIds: List<String>

The list of user mentioned in the message

messageTextUpdatedAt

val messageTextUpdatedAt: Date? = null

Date when the message text was updated

moderation

val moderation: Moderation? = null

Contains moderation details of the message. (used by moderation v2)

moderationDetails

val moderationDetails: MessageModerationDetails? = null

Contains moderation details of the message. (used by moderation v1)

originalLanguage

val originalLanguage: String

Retrieves the original language of the message.

ownReactions

val ownReactions: List<Reaction>

List of reactions of authenticated user to this message

parentId

val parentId: String? = null

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

pinExpires

val pinExpires: Date? = null

Date when pinned message expires

pinned

val pinned: Boolean = false

Whether message is pinned or not

pinnedAt

val pinnedAt: Date? = null

Date when the message got pinned

pinnedBy

val pinnedBy: User? = null

Contains user who pinned the message

poll

val poll: Poll? = null

Contains poll configuration

reactionCounts

val reactionCounts: Map<String, Int>

A mapping between reaction type and the count, ie like:10, heart:4

reactionGroups

val reactionGroups: Map<String, ReactionGroup>

A mapping between reaction type and the ReactionGroup.

reactionScores

val reactionScores: Map<String, Int>

A mapping between reaction type and the reaction score, ie like:10, heart:4

replyCount

val replyCount: Int = 0

The number of replies to this message

replyMessageId

val replyMessageId: String? = null

The ID of the quoted message, if the message is a quoted reply.

replyTo

val replyTo: Message? = null

Contains quoted message

restrictedVisibility

val restrictedVisibility: List<String>

List of user ids that are allowed to see the message

shadowed

val shadowed: Boolean = false

If the message was sent by shadow banned user

showInChannel

val showInChannel: Boolean = false

Whether thread reply should be shown in the channel as well

silent

val silent: Boolean = false

Whether message is silent or not

skipEnrichUrl

val skipEnrichUrl: Boolean = false

If the message should skip enriching the URL. If URl is not enriched, it will not be displayed as a link attachment. Used when sending or updating a message. False by default.

skipPushNotification

val skipPushNotification: Boolean = false

If the message should skip triggering a push notification when sent. Used when sending a new message. False by default.

syncStatus

val syncStatus: SyncStatus

If the message has been synced to the servers, default is synced

text

val text: String

The text of this message

threadParticipants

val threadParticipants: List<User>

The list of users who participate in thread