SendbirdUIKit-Compose/com.sendbird.uikit.compose.channels.group.list/ChannelsViewModelContract

ChannelsViewModelContract

interface ChannelsViewModelContract : SendbirdViewModelContract

The ViewModel contract for ChannelsScreen.

Since

1.0.0

Inheritors

Properties

Link copied to clipboard
abstract val channelsEventState: StateFlow<ChannelsEvent>

The StateFlow of the ChannelsEvent.

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

The StateFlow of the SimpleSendbirdEventState for the leaveChannel 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 setMyPushTriggerOptionEventState: StateFlow<SimpleSendbirdEventState>

The StateFlow of the SimpleSendbirdEventState for the setMyPushTriggerOption request.

Link copied to clipboard
abstract val totalChannelsState: StateFlow<List<UikitGroupChannel>>

The StateFlow of the list of UikitGroupChannel.

Functions

Link copied to clipboard
abstract fun leaveChannel(url: String)

Requests to leave the channel. The result will be notified by leaveChannelEventState.

Link copied to clipboard
abstract fun loadMore()

Requests to load more channels. This should be called when the user scrolls to the end of the list.

Link copied to clipboard
abstract fun notifyLeaveChannelEventProcessed()

Notifies that the leaveChannel event has been processed to reset leaveChannelEventState 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.

abstract fun notifySetMyPushTriggerOptionEventProcessed()

Notifies that the setMyPushTriggerOption event has been processed to reset setMyPushTriggerOptionEventState to SendbirdEventState.Idle state.

Link copied to clipboard
abstract fun setMyPushTriggerOption(url: String, option: GroupChannel.PushTriggerOption)

Requests to set the push trigger option for the current user for a specific channel.