SendbirdUIKit-Compose/com.sendbird.uikit.compose.channels.group.invitation/UserInvitationViewModel

UserInvitationViewModel

class UserInvitationViewModel(repository: UserInvitationScreenResourceRepository, savedStateHandle: SavedStateHandle) : ViewModel, UserInvitationViewModelContract

ViewModel class for UserInvitationScreen.

Since

1.0.0

Constructors

UserInvitationViewModel

constructor(repository: UserInvitationScreenResourceRepository, savedStateHandle: SavedStateHandle)

Types

object Companion

Properties

open override val channelState: StateFlow<UikitGroupChannel>

The StateFlow of the UikitGroupChannel.

inviteEventState

open override val inviteEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow of the SimpleSendbirdEventState for the invite request.

loadMoreEventState

open override val loadMoreEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow of the SimpleSendbirdEventState for the loadMore request.

open override val uiState: StateFlow<SendbirdScreenUiState>

The StateFlow of the SendbirdScreenUiState.

open override val userListState: StateFlow<List<UikitUser>>

The StateFlow of the list of UikitUser.

Functions

open override fun invite(userIds: List<String>)

Requests to invite users to the channel. The result will be notified by UserInvitationViewModelContract.inviteEventState.

open override fun loadMore()

Requests to load more users. This should be called when the user list scrolls to the bottom and requires more users.

notifyInviteEventProcessed

open override fun notifyInviteEventProcessed()

Notifies that the invite event has been processed to reset inviteEventState to SendbirdEventState.Idle state.

notifyLoadMoreEventProcessed

open override fun notifyLoadMoreEventProcessed()

Notifies that the loadMore event has been processed to reset loadMoreEventState to SendbirdEventState.Idle state.

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.