stream-chat-android-ui-common/io.getstream.chat.android.common.composer/MessageComposerController

MessageComposerController

class MessageComposerController( channelId: String, chatClient: ChatClient = ChatClient.instance(), maxAttachmentCount: Int = AttachmentConstants.MAX_ATTACHMENTS_COUNT, maxAttachmentSize: Long = AttachmentConstants.MAX_UPLOAD_FILE_SIZE)

Controller responsible for handling the composing and sending of messages.

It acts as a central place for both the core business logic and state required to create and send messages, handle attachments, message actions and more.

If you require more state and business logic, compose this Controller with your code and apply the necessary changes.

Parameters

channelId

The ID of the channel we're chatting in.

chatClient

The client used to communicate to the API.

maxAttachmentCount

The maximum number of attachments that can be sent in a single message.

maxAttachmentSize

Tne maximum file size of each attachment in bytes. By default, 100 MB for Stream CDN.

Constructors

MessageComposerController

fun MessageComposerController( channelId: String, chatClient: ChatClient = ChatClient.instance(), maxAttachmentCount: Int = AttachmentConstants.MAX_ATTACHMENTS_COUNT, maxAttachmentSize: Long = AttachmentConstants.MAX_UPLOAD_FILE_SIZE)

Properties

alsoSendToChannel

val alsoSendToChannel: MutableStateFlow<Boolean>

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

channelState

val channelState: Flow<ChannelState>

Holds information about the current state of the Channel.

commandSuggestions

val commandSuggestions: MutableStateFlow<List<Command>>

Represents the list of commands that can be executed for the channel.

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?>

Represents a Flow that holds the last active MessageAction that is either the Edit, Reply.

mentionSuggestions

val mentionSuggestions: MutableStateFlow<List<User>>

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

messageActions

val messageActions: MutableStateFlow<Set<MessageAction>>

Set of currently active message actions. These are used to display different UI in the composer, as well as help us decorate the message with information, such as the quoted message id.

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.

state

val state: MutableStateFlow<MessageComposerState>

Full message composer state holding all the required information.

typingUpdatesBuffer

var typingUpdatesBuffer: TypingUpdatesBuffer

Buffers typing updates.

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

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

Builds a new Message to send to our API. If isInEditMode is true, we use the current action's message and apply the given changes.

clearData

fun clearData()

Clears all the data from the input - both the current input value and the selectedAttachments.

dismissMessageActions

fun dismissMessageActions()

Dismisses all message actions from the UI and clears the input if isInEditMode is true.

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, by calling setMessageMode.

onCleared

fun onCleared()

Cancels any pending work when the parent ViewModel is about to be destroyed.

performMessageAction

fun performMessageAction(messageAction: MessageAction)

Handles selected messageAction. We only have three actions we can react to in the composer:

removeSelectedAttachment

fun removeSelectedAttachment(attachment: Attachment)

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

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

fun sendMessage(message: Message)

Sends a given message using our Stream API. Based on isInEditMode, we either edit an existing message, or we send a new message, using ChatClient. In case the message is a moderated message the old one is deleted before the replacing one is sent.

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.

toggleCommandsVisibility

fun toggleCommandsVisibility()

Toggles the visibility of the command suggestion list popup.