stream-chat-android-compose/io.getstream.chat.android.compose.viewmodel.messages/MessageComposerViewModel

MessageComposerViewModel

class MessageComposerViewModel(messageComposerController: MessageComposerController, storageHelper: AttachmentStorageHelper) : ViewModel

ViewModel responsible for handling the composing and sending of messages.

Delegates all state management and business logic to MessageComposerController, including persistence of picker selections and edit-mode state across process death.

Parameters

messageComposerController

The controller used to relay all the actions and fetch all the state.

storageHelper

Resolves deferred attachment files before sending.

Constructors

MessageComposerViewModel

constructor(messageComposerController: MessageComposerController, storageHelper: AttachmentStorageHelper)

Properties

inputFocusEvents

val inputFocusEvents: SharedFlow<Unit>

Emits each time the message input field should request focus (e.g. after a command is selected).

messageComposerState

val messageComposerState: StateFlow<MessageComposerState>

The full UI state that has all the required data.

messageInput

val messageInput: StateFlow<MessageInput>

UI state of the current composer input.

Functions

addAttachments

fun addAttachments(attachments: List<Attachment>)

Adds attachments to the staged attachment list.

addCloseable

open fun addCloseable(closeable: AutoCloseable)

fun addCloseable(key: String, closeable: AutoCloseable)

buildNewMessage

fun buildNewMessage(message: String = messageInput.value.text, attachments: List<Attachment> = emptyList()): Message

Builds a new Message to send to our API. Based on the internal state, we use the current action's message and apply the given changes.

cancelLinkPreview

fun cancelLinkPreview()

cancelRecording

fun cancelRecording()

clearActiveCommand

fun clearActiveCommand()

clearAttachments

fun clearAttachments()

Removes all staged attachments.

clearData

fun clearData()

Clears the input and the current state of the composer.

completeRecording

fun completeRecording(onComplete: (Result<Attachment>) -> Unit? = null)

createPoll

fun createPoll(createPollParams: CreatePollParams)

Creates a poll with the given createPollParams.

dismissMessageActions

fun dismissMessageActions()

Dismisses all message actions from the UI and clears the input based on the internal state.

getCloseable

fun <T : AutoCloseable> getCloseable(key: String): T?

holdRecording

fun holdRecording(offset: Pair<Float, Float>)

leaveThread

fun leaveThread()

Updates the UI state when leaving the thread, to switch back to the MessageMode.Normal message mode, by calling setMessageMode.

lockRecording

fun lockRecording()

pauseRecording

fun pauseRecording()

performMessageAction

fun performMessageAction(messageAction: MessageAction)

Handles the selected messageAction.

removeAttachment

fun removeAttachment(attachment: Attachment)

Removes attachment from the staged attachment list.

seekRecordingTo

fun seekRecordingTo(progress: Float)

selectCommand

fun selectCommand(command: Command)

Switches the message composer to the command input mode.

selectMention

fun selectMention(user: User)

Autocompletes the current text input with the mention from the selected user.

fun selectMention(mention: Mention)

Autocompletes the current text input with the mention from the selected mention.

sendMessage

fun sendMessage(message: Message, callback: Call.Callback<Message> = Call.Callback { /* no-op */ })

Sends a given message using our Stream API. Based on the internal state, we either edit an existing message, or we send a new message, using our API.

sendRecording

fun sendRecording()

setAlsoSendToChannel

fun setAlsoSendToChannel(alsoSendToChannel: Boolean)

Called when the "Also send as a direct message" checkbox is checked or unchecked.

setMessageInput

fun setMessageInput(value: String)

Called when the input changes and the internal state needs to be updated.

setMessageMode

fun setMessageMode(messageMode: MessageMode)

Called when the message mode changes and the internal state needs to be updated.

setTypingUpdatesBuffer

fun setTypingUpdatesBuffer(buffer: TypingUpdatesBuffer)

Sets the typing updates buffer.

startRecording

fun startRecording()

stopRecording

fun stopRecording()

toggleCommandsVisibility

fun toggleCommandsVisibility()

Toggles the visibility of the command suggestion list popup.

toggleRecordingPlayback

fun toggleRecordingPlayback()