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

MessageComposerViewModel

class MessageComposerViewModel(messageComposerController: MessageComposerController) : ViewModel

ViewModel responsible for handling the composing and sending of messages.

It relays all its core actions to a shared data source, as a central place for all the Composer logic. Additionally, all the core data that can be reused across our SDKs is available through shared data sources, while implementation-specific data is stored in respective in the ViewModel.

Parameters

messageComposerController

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

Constructors

MessageComposerViewModel

constructor(messageComposerController: MessageComposerController)

Properties

alsoSendToChannel

val alsoSendToChannel: MutableStateFlow<Boolean>

If the message will be shown in the channel after it is sent.

commandSuggestions

val commandSuggestions: MutableStateFlow<List<Command>>

Represents the list of commands to be displayed in the command suggestion list popup.

cooldownTimer

val cooldownTimer: MutableStateFlow<Int>

Represents the remaining time until the user is allowed to send the next message.

input

val input: MutableStateFlow<String>

UI state of the current composer input.

lastActiveAction

val lastActiveAction: Flow<MessageAction?>

Gets the active Edit or Reply action, whichever is last, to show on the UI.

mentionSuggestions

val mentionSuggestions: MutableStateFlow<List<User>>

Represents the list of users that can be used to autocomplete the current mention input.

messageComposerState

val messageComposerState: StateFlow<MessageComposerState>

The full UI state that has all the required data.

messageMode

val messageMode: MutableStateFlow<MessageMode>

Current message mode, either MessageMode.Normal or MessageMode.MessageThread. Used to determine if we're sending a thread reply or a regular message.

ownCapabilities

val ownCapabilities: StateFlow<Set<String>>

Holds information about the abilities the current user is able to exercise in the given channel.

selectedAttachments

val selectedAttachments: MutableStateFlow<List<Attachment>>

Represents the currently selected attachments, that are shown within the composer UI.

validationErrors

val validationErrors: MutableStateFlow<List<ValidationError>>

Represents the list of validation errors for the current text input and the currently selected attachments.

Functions

addSelectedAttachments

fun addSelectedAttachments(attachments: List<Attachment>)

Stores the selected attachments from the attachment picker. These will be shown in the UI, within the composer component. We upload and send these attachments once the user taps on the send button.

buildNewMessage

@JvmOverloads

fun buildNewMessage(message: String = input.value, attachments: List<Attachment> = selectedAttachments.value): 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.

cancelRecording

fun cancelRecording()

clearData

fun clearData()

Clears the input and the current state of the composer.

completeRecording

fun completeRecording()

createPoll

fun createPoll(pollConfig: PollConfig)

dismissMessageActions

fun dismissMessageActions()

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

dismissSuggestionsPopup

fun dismissSuggestionsPopup()

Dismisses the suggestions popup above the message composer.

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.

removeSelectedAttachment

fun removeSelectedAttachment(attachment: Attachment)

Removes a selected attachment from the list, when the user taps on the cancel/delete button.

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.

sendMessage

@JvmOverloads

fun sendMessage(message: Message = buildNewMessage(), 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.

startRecording

fun startRecording()

stopRecording

fun stopRecording()

toggleCommandsVisibility

fun toggleCommandsVisibility()

Toggles the visibility of the command suggestion list popup.

toggleRecordingPlayback

fun toggleRecordingPlayback()

Inherited functions

addCloseable

open fun addCloseable(closeable: AutoCloseable)

fun addCloseable(key: String, closeable: AutoCloseable)

bindView

@JvmName(name = "bind")

@JvmOverloads

fun MessageComposerViewModel.bindView(view: MessageComposerView, lifecycleOwner: LifecycleOwner, messageBuilder: () -> Message = { buildNewMessage() }, sendMessageButtonClickListener: (Message) -> Unit = this.sendMessageButtonClickListener, textInputChangeListener: (String) -> Unit = this.textInputChangeListener, attachmentSelectionListener: (List<Attachment>) -> Unit = this.attachmentSelectionListener, attachmentRemovalListener: (Attachment) -> Unit = this.attachmentRemovalListener, pollSubmissionListener: (PollConfig) -> Unit = this.pollSubmissionListener, mentionSelectionListener: (User) -> Unit = this.mentionSelectionListener, commandSelectionListener: (Command) -> Unit = this.commandSelectionListener, alsoSendToChannelSelectionListener: (Boolean) -> Unit = this.alsoSendToChannelSelectionListener, dismissActionClickListener: () -> Unit = this.dismissActionClickListener, commandsButtonClickListener: () -> Unit = this.commandsButtonClickListener, dismissSuggestionsListener: () -> Unit = this.dismissSuggestionsListener, audioRecordButtonHoldListener: () -> Unit = this.audioRecordButtonHoldListener, audioRecordButtonLockListener: () -> Unit = this.audioRecordButtonLockListener, audioRecordButtonCancelListener: () -> Unit = this.audioRecordButtonCancelListener, audioRecordButtonReleaseListener: () -> Unit = this.audioRecordButtonReleaseListener, audioDeleteButtonClickListener: () -> Unit = this.audioDeleteButtonClickListener, audioStopButtonClickListener: () -> Unit = this.audioStopButtonClickListener, audioPlaybackButtonClickListener: () -> Unit = this.audioPlaybackButtonClickListener, audioCompleteButtonClickListener: () -> Unit = this.audioCompleteButtonClickListener, audioSliderDragStartListener: (Float) -> Unit = this.audioSliderDragStartListener, audioSliderDragStopListener: (Float) -> Unit = this.audioSliderDragStopListener)

bindViewDefaults

@JvmName(name = "bindDefaults")

@JvmOverloads

fun MessageComposerViewModel.bindViewDefaults(view: MessageComposerView, lifecycleOwner: LifecycleOwner, messageBuilder: () -> Message = { buildNewMessage() }, sendMessageButtonClickListener: (Message) -> Unit? = null, textInputChangeListener: (String) -> Unit? = null, attachmentSelectionListener: (List<Attachment>) -> Unit? = null, attachmentRemovalListener: (Attachment) -> Unit? = null, pollSubmissionListener: (PollConfig) -> Unit? = null, mentionSelectionListener: (User) -> Unit? = null, commandSelectionListener: (Command) -> Unit? = null, alsoSendToChannelSelectionListener: (Boolean) -> Unit? = null, dismissActionClickListener: () -> Unit? = null, commandsButtonClickListener: () -> Unit? = null, dismissSuggestionsListener: () -> Unit? = null, audioRecordButtonHoldListener: () -> Unit? = null, audioRecordButtonLockListener: () -> Unit? = null, audioRecordButtonCancelListener: () -> Unit? = null, audioRecordButtonReleaseListener: () -> Unit? = null, audioDeleteButtonClickListener: () -> Unit? = null, audioStopButtonClickListener: () -> Unit? = null, audioPlaybackButtonClickListener: () -> Unit? = null, audioCompleteButtonClickListener: () -> Unit? = null, audioSliderDragStartListener: (Float) -> Unit? = null, audioSliderDragStopListener: (Float) -> Unit? = null)

Function which connects MessageComposerView to MessageComposerViewModel. As a result the view renders the state delivered by the ViewModel, and the ViewModel intercepts the user's actions automatically. The main difference with bindView is that listeners in this function do not override the default behaviour.

getCloseable

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