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

ChannelViewModel

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

ViewModel class for ChannelScreen.

Since

1.0.0-beta.1

Constructors

ChannelViewModel

constructor(repository: ChannelScreenResourceRepository, savedStateHandle: SavedStateHandle)

Types

object Companion

Properties

deleteMessageEventState

val deleteMessageEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow for the deleteMessage request.

val hasNext: Boolean

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

val hasPrevious: Boolean

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

var initialized: StateFlow<Boolean>

loadNextEventState

val loadNextEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow for the loadNext request.

loadPreviousEventState

val loadPreviousEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow for the loadPrevious request.

messagesEventState

val messagesEventState: StateFlow<MessagesEvent>

The StateFlow of the MessagesEvent.

resendMessageEventState

val resendMessageEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow for the resendMessage request.

sendFileMessageEventState

val sendFileMessageEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow for the sendFileMessage request.

sendUserMessageEventState

val sendUserMessageEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow for the sendUserMessage request.

open override val uiState: StateFlow<SendbirdScreenUiState>

The StateFlow of the SendbirdScreenUiState.

updateUserMessageEventState

val updateUserMessageEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow for the updateUserMessage request.

Functions

fun deleteMessage(message: UikitBaseMessage)

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

fun loadInitial(startingPoint: Long = Long.MAX_VALUE)

Loads the initial messages.

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

fun loadPrevious()

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

notifyDeleteMessageEventProcessed

fun notifyDeleteMessageEventProcessed()

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

notifyLoadNextEventProcessed

fun notifyLoadNextEventProcessed()

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

notifyLoadPreviousEventProcessed

fun notifyLoadPreviousEventProcessed()

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

notifyResendMessageEventProcessed

fun notifyResendMessageEventProcessed()

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

notifySendFileMessageEventProcessed

fun notifySendFileMessageEventProcessed()

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

notifySendUserMessageEventProcessed

fun notifySendUserMessageEventProcessed()

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

notifyUpdateUserMessageEventProcessed

fun notifyUpdateUserMessageEventProcessed()

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

protected 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.

fun resendMessage(message: UikitBaseMessage)

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

sendFileMessage

fun sendFileMessage(file: File)

Sends a file message with a given file.

sendUserMessage

fun sendUserMessage(message: String)

Sends a user message with a given message.

fun setTyping(isTyping: Boolean)

Sets the typing status.

updateUserMessage

fun updateUserMessage(messageId: Long, message: String)

Updates a message with a given messageId and message.