SendbirdUIKit-Compose/com.sendbird.uikit.compose.channels.group.detail/ChannelViewModel

ChannelViewModel

class ChannelViewModel(repository: ChannelScreenResourceRepository, savedStateHandle: SavedStateHandle) : ViewModel, ChannelViewModelContract

ViewModel class for ChannelScreen.

Since

1.0.0

Constructors

ChannelViewModel

constructor(repository: ChannelScreenResourceRepository, savedStateHandle: SavedStateHandle)

Types

object Companion

Properties

deleteMessageEventState

open override val deleteMessageEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow for the deleteMessage request.

open override val hasNext: Boolean

The flag to check if there is a next page. Refer to ChannelScreenResourceRepository.hasNext.

open override val hasPrevious: Boolean

The flag to check if there is a previous page. Refer to ChannelScreenResourceRepository.hasPrevious.

open override val initialized: StateFlow<Boolean>

The flag to check if the channel is initialized.

loadNextEventState

open override val loadNextEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow for the loadNext request.

loadPreviousEventState

open override val loadPreviousEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow for the loadPrevious request.

messagesEventState

open override val messagesEventState: StateFlow<MessagesEvent>

The StateFlow of the MessagesEvent.

resendMessageEventState

open override val resendMessageEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow for the resendMessage request.

sendFileMessageEventState

open override val sendFileMessageEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow for the sendFileMessage request.

sendUserMessageEventState

open override val sendUserMessageEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow for the sendUserMessage request.

totalMessagesState

open override val totalMessagesState: StateFlow<List<UikitBaseMessage>>

The StateFlow of the list of UikitBaseMessage to display.

open override val uiState: StateFlow<SendbirdScreenUiState>

The StateFlow of the SendbirdScreenUiState.

updateUserMessageEventState

open override val updateUserMessageEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow for the updateUserMessage request.

Functions

open override fun deleteMessage(message: UikitBaseMessage)

Deletes a message with a given message. Deleting is only allowed for a message with ChatBaseMessage type.

open override fun loadInitial(startingPoint: Long)

Loads the initial messages.

open override fun loadNext()

Loads the messages to the latest direction to fetch newer messages.

open override fun loadPrevious()

Loads the messages to the previous direction to fetch older messages.

notifyDeleteMessageEventProcessed

open override fun notifyDeleteMessageEventProcessed()

Notifies that the deleteMessage event has been processed to reset deleteMessageEventState to SendbirdEventState.Idle state.

notifyLoadNextEventProcessed

open override fun notifyLoadNextEventProcessed()

Notifies that the loadNext event has been processed to reset loadNextEventState to SendbirdEventState.Idle state.

notifyLoadPreviousEventProcessed

open override fun notifyLoadPreviousEventProcessed()

Notifies that the loadPrevious event has been processed to reset loadPreviousEventState to SendbirdEventState.Idle state.

notifyResendMessageEventProcessed

open override fun notifyResendMessageEventProcessed()

Notifies that the resendMessage event has been processed to reset resendMessageEventState to SendbirdEventState.Idle state.

notifySendFileMessageEventProcessed

open override fun notifySendFileMessageEventProcessed()

Notifies that the sendFileMessage event has been processed to reset sendFileMessageEventState to SendbirdEventState.Idle state.

notifySendUserMessageEventProcessed

open override fun notifySendUserMessageEventProcessed()

Notifies that the sendUserMessage event has been processed to reset sendUserMessageEventState to SendbirdEventState.Idle state.

notifyUpdateUserMessageEventProcessed

open override fun notifyUpdateUserMessageEventProcessed()

Notifies that the updateUserMessage event has been processed to reset updateUserMessageEventState to SendbirdEventState.Idle state.

@VisibleForTesting(otherwise = 4)

open override fun onCleared()

open override fun prepare()

The preparation process required for the screen. This contains the Chat SDK's connection by SendbirdChat.connect and getting the channel object ready if necessary.

open override fun resendMessage(message: UikitBaseMessage)

Resends a message with a given message. Resending is only allowed for a message with ChatBaseMessage type.

sendFileMessage

open override fun sendFileMessage(file: File)

Sends a file message with a given file.

sendUserMessage

open override fun sendUserMessage(message: String)

Sends a user message with a given message.

open override fun setTyping(isTyping: Boolean)

Sets the typing status.

updateUserMessage

open override fun updateUserMessage(messageId: Long, message: String)

Updates a message with a given messageId and message.