SendbirdUIKit-Compose/com.sendbird.uikit.compose.channels.group.members/MembersViewModelContract

MembersViewModelContract

interface MembersViewModelContract : SendbirdViewModelContract

The ViewModel contract for MembersScreen.

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 createChannelEventState: StateFlow<SendbirdEventState<UikitGroupChannel>>
Link copied to clipboard
abstract val loadMoreEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow of the SimpleSendbirdEventState for the loadMore request.

Link copied to clipboard
abstract val membersState: StateFlow<List<UikitMember>>

The StateFlow of the list of UikitMember.

Functions

Link copied to clipboard
abstract fun createChannel(user: UikitUser)

Requests to create a channel with the selected users. The result will be notified by MembersViewModelContract.createChannelEventState.

Link copied to clipboard
abstract fun loadMore()

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

Link copied to clipboard
abstract fun notifyCreateChannelEventProcessed()

Notifies that the createChannel event has been processed to reset createChannelEventState to SendbirdEventState.Idle state.

Link copied to clipboard
abstract fun notifyLoadNextEventStateIdle()

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