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

Message

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

Constructors

Message

fun Message( id: String = "", cid: String = "", text: String = "", html: String = "", parentId: String? = null, command: String? = null, attachments: MutableList<Attachment> = mutableListOf(), mentionedUsersIds: MutableList<String> = mutableListOf(), mentionedUsers: MutableList<User> = mutableListOf(), replyCount: Int = 0, reactionCounts: MutableMap<String, Int> = mutableMapOf(), reactionScores: MutableMap<String, Int> = mutableMapOf(), syncStatus: SyncStatus = SyncStatus.COMPLETED, syncDescription: MessageSyncDescription? = null, type: String = "", latestReactions: MutableList<Reaction> = mutableListOf(), ownReactions: MutableList<Reaction> = mutableListOf(), createdAt: Date? = null, updatedAt: Date? = null, deletedAt: Date? = null, updatedLocallyAt: Date? = null, createdLocallyAt: Date? = null, user: User = User(), extraData: MutableMap<String, Any> = mutableMapOf(), 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)

Types

Companion

object Companion

Properties

attachments

var attachments: MutableList<Attachment>

The list of message attachments

channelInfo

var channelInfo: ChannelInfo? = null

cid

var cid: String

Channel unique identifier in : format

command

var command: String? = null

Contains provided slash command

createdAt

var createdAt: Date? = null

When the message was created

createdLocallyAt

var createdLocallyAt: Date? = null

When the message was created locally

deletedAt

var deletedAt: Date? = null

When the message was deleted

extraData

open override var extraData: MutableMap<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.

var 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

var latestReactions: MutableList<Reaction>

List of the latest reactions to this message

mentionedUsers

var mentionedUsers: MutableList<User>

The list of user mentioned in the message

mentionedUsersIds

var mentionedUsersIds: MutableList<String>

The list of user mentioned in the message

ownReactions

var ownReactions: MutableList<Reaction>

List of reactions of authenticated user to this message

parentId

var parentId: String? = null

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

pinExpires

var pinExpires: Date? = null

Date when pinned message expires

pinned

var pinned: Boolean = false

Whether message is pinned or not

pinnedAt

var pinnedAt: Date? = null

Date when the message got pinned

pinnedBy

var pinnedBy: User? = null

Contains user who pinned the message

reactionCounts

var reactionCounts: MutableMap<String, Int>

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

reactionScores

var reactionScores: MutableMap<String, Int>

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

replyCount

var replyCount: Int = 0

The number of replies to this message

replyMessageId

var replyMessageId: String? = null

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

replyTo

var replyTo: Message? = null

Contains quoted message

shadowed

var shadowed: Boolean = false

If the message was sent by shadow banned user

showInChannel

var showInChannel: Boolean = false

Whether thread reply should be shown in the channel as well

silent

var silent: Boolean = false

Whether message is silent or not

skipEnrichUrl

var 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

var skipPushNotification: Boolean = false

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

syncDescription

var syncDescription: MessageSyncDescription? = null

Contains details related to syncStatus.

syncStatus

var syncStatus: SyncStatus

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

text

var text: String

The text of this message

threadParticipants

var threadParticipants: List<User>

The list of users who participate in thread

type

var type: String

Contains type of the message. Can be one of the following: regular, ephemeral, error, reply, system, deleted.

updatedAt

var updatedAt: Date? = null

When the message was updated

updatedLocallyAt

var updatedLocallyAt: Date? = null

When the message was updated locally

user

var user: User

The user who sent the message

Functions

getComparableField

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

Gets a comparable fields from a name.

Inherited functions

getExtraValue

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

putExtraValue

open fun putExtraValue(key: String, value: Any)

Extensions

addMyReaction

fun Message.addMyReaction(reaction: Reaction, enforceUnique: Boolean = false)

createdAfter

fun Message.createdAfter(that: Message): Boolean

Tests if this message was created after that message.

enrichWithCid

fun Message.enrichWithCid(cid: String): Message

getTranslation

fun Message.getTranslation(language: String): String

hasPendingAttachments

fun Message.hasPendingAttachments(): Boolean

isEphemeral

fun Message.isEphemeral(): Boolean

originalLanguage

val Message.originalLanguage: String

populateMentions

fun Message.populateMentions(channel: Channel)

Fills Message.mentionedUsersIds based on Message.text and Channel.members.

removeMyReaction

fun Message.removeMyReaction(reaction: Reaction)

shouldIncrementUnreadCount

fun Message.shouldIncrementUnreadCount( currentUserId: String, lastMessageAtDate: Date?, isChannelMuted: Boolean): Boolean

Function that parses if the unread count should be increased or not.

updateFailedMessage

fun Message.updateFailedMessage(chatError: ChatError): Message

Updates a message that whose request (Edition/Delete/Reaction update...) has failed.

updateMessageOnlineState

fun Message.updateMessageOnlineState(isOnline: Boolean): Message

Update the online state of a message.

updateUsers

fun Message.updateUsers(users: Map<String, User>): Message

Updates a message with more recent data of users. It updates author user, latestReactions, replyTo message, mentionedUsers, threadParticipants and pinnedBy user of this instance.

users

fun Message.users(): List<User>

wasCreatedAfter

fun Message.wasCreatedAfter(date: Date?): Boolean

wasCreatedAfterOrAt

fun Message.wasCreatedAfterOrAt(date: Date?): Boolean

wasCreatedBefore

fun Message.wasCreatedBefore(date: Date?): Boolean

wasCreatedBeforeOrAt

fun Message.wasCreatedBeforeOrAt(date: Date?): Boolean