stream-chat-android-ui-components/io.getstream.chat.android.ui.viewmodel.messages/MessageListViewModel/Event

Event

sealed class Event

Represents events coming from the View class.

Inheritors

Types

BackButtonPressed

object BackButtonPressed : MessageListViewModel.Event

When the back button is pressed.

BanUser

data class BanUser(val user: User, val reason: String? = null, val timeout: Int? = null) : MessageListViewModel.Event

When the user bans another user.

BottomEndRegionReached

data class BottomEndRegionReached(val messageId: String?) : MessageListViewModel.Event

When the newest loaded message in the list has been reached and there's still newer messages to be loaded.

DeleteMessage

data class DeleteMessage(val message: Message, val hard: Boolean = false) : MessageListViewModel.Event

When the user deletes a message.

DownloadAttachment

data class DownloadAttachment(val downloadAttachmentCall: () -> Call<Unit>) : MessageListViewModel.Event

When the user downloads an attachment.

EndRegionReached

object EndRegionReached : MessageListViewModel.Event

When the oldest loaded message in the list has been reached.

FlagMessage

data class FlagMessage(val message: Message, val resultHandler: (Result<Flag>) -> Unit = { }) : MessageListViewModel.Event

When the user flags a message.

GiphyActionSelected

data class GiphyActionSelected(val action: GiphyAction) : MessageListViewModel.Event

When the user selects a Giphy message. e.g. send, shuffle or cancel.

LastMessageRead

object LastMessageRead : MessageListViewModel.Event

When the newest message in the channel has been read.

MarkAsUnreadMessage

data class MarkAsUnreadMessage(val message: Message) : MessageListViewModel.Event

When the user marks a message as unread.

MessageReaction

data class MessageReaction(val message: Message, val reactionType: String) : MessageListViewModel.Event

When the user leaves a reaction to a message.

MuteUser

data class MuteUser(val user: User) : MessageListViewModel.Event

When the user mutes a user.

PinMessage

data class PinMessage(val message: Message) : MessageListViewModel.Event

When the user pins a message.

RemoveAttachment

data class RemoveAttachment(val messageId: String, val attachment: Attachment) : MessageListViewModel.Event

When the user removes an attachment from a message that was previously sent.

RemoveShadowBanFromUser

data class RemoveShadowBanFromUser(val user: User) : MessageListViewModel.Event

When the user removes the shadow ban from another user.

ReplyAttachment

data class ReplyAttachment(val cid: String, val repliedMessageId: String) : MessageListViewModel.Event

When the user is replying to a single attachment. Usually triggered when replying from gallery.

ReplyMessage

data class ReplyMessage(val cid: String, val repliedMessage: Message) : MessageListViewModel.Event

When the user replies to a message.

RetryMessage

data class RetryMessage(val message: Message) : MessageListViewModel.Event

Retry sending a message that has failed to send.

ShadowBanUser

data class ShadowBanUser(val user: User, val reason: String? = null, val timeout: Int? = null) : MessageListViewModel.Event

When the user shadow bans another user.

ShowMessage

data class ShowMessage(val messageId: String, val parentMessageId: String?) : MessageListViewModel.Event

When we need to display a particular message to the user. Usually triggered by clicking on pinned messages and replied messages.

ThreadModeEntered

data class ThreadModeEntered(val parentMessage: Message) : MessageListViewModel.Event

When the users enters thread mode.

UnbanUser

data class UnbanUser(val user: User) : MessageListViewModel.Event

When the user unbans another user.

UnmuteUser

data class UnmuteUser(val user: User) : MessageListViewModel.Event

When the user unmutes a user.

UnpinMessage

data class UnpinMessage(val message: Message) : MessageListViewModel.Event

When the user unpins a message.