SendbirdUIKit-Compose/com.sendbird.uikit.compose.channels.group.settings/ChannelSettingsViewModelContract

ChannelSettingsViewModelContract

interface ChannelSettingsViewModelContract : SendbirdViewModelContract

The ViewModel contract for ChannelSettingsScreen.

Since

1.0.0-beta.2

Inheritors

Properties

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

The StateFlow of the UikitGroupChannel.

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

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

The StateFlow of the SimpleSendbirdEventState for the updateChannel request.

Functions

Link copied to clipboard
abstract fun leaveChannel()

Leaves the current channel. The result will be notified by leaveChannelEventState.

Link copied to clipboard
abstract fun notifyLeaveChannelEventProcessed()

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

Notifies that the updateChannel event has been processed to reset updateChannelEventState to SendbirdEventState.Idle state.

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

Sets the push trigger option for the current user.

Link copied to clipboard
abstract fun updateChannel(params: GroupChannelUpdateParams)

Updates the channel description with the given params.

Link copied to clipboard
abstract fun updateChannelCover(file: File)

Updates the channel cover image with the given file.

Link copied to clipboard
abstract fun updateChannelName(name: String)

Updates the channel name with the given name.