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

UserInvitationViewModelContract

interface UserInvitationViewModelContract : SendbirdViewModelContract, UserInvitationTopBarActionContract

The ViewModel contract for UserInvitationScreen.

Since

1.0.0

Inheritors

Properties

Link copied to clipboard
abstract val channelState: StateFlow<UikitGroupChannel>

The StateFlow of the UikitGroupChannel.

Link copied to clipboard
abstract val inviteEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow of the SimpleSendbirdEventState for the invite request.

Link copied to clipboard
abstract val loadMoreEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow of the SimpleSendbirdEventState for the loadMore request.

Link copied to clipboard
abstract val userListState: StateFlow<List<UikitUser>>

The StateFlow of the list of UikitUser.

Functions

Link copied to clipboard
abstract override fun invite(userIds: List<String>)

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

Link copied to clipboard
abstract fun loadMore()

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

Link copied to clipboard
abstract fun notifyInviteEventProcessed()

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

Link copied to clipboard
abstract fun notifyLoadMoreEventProcessed()

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