core/ui/com.shifthackz.aisdv1.core.mvi/BaseMviViewModel

BaseMviViewModel

abstract class BaseMviViewModel<S : MviState, I : MviIntent, E : MviEffect>(initialState: S, val effectDispatcher: CoroutineDispatcher) : ViewModel, MviViewModel<S, I, E> (source)

Coordinates BaseMviViewModel behavior in the SDAI core UI layer.

Author

Dmitriy Moroz

Constructors

BaseMviViewModel

constructor(initialState: S, effectDispatcher: CoroutineDispatcher)

Properties

_effect

private val _effect: Channel<E>

Exposes the _effect value used by the SDAI core UI layer.

_state

private val _state: MutableStateFlow<S>

Exposes the _state value used by the SDAI core UI layer.

currentState

protected val currentState: S

Exposes the currentState value used by the SDAI core UI layer.

effect

open override val effect: Flow<E>

Exposes the effect value used by the SDAI core UI layer.

effectDispatcher

private val effectDispatcher: CoroutineDispatcher

Exposes the effectDispatcher value used by the SDAI core UI layer.

state

open override val state: StateFlow<S>

Exposes the state value used by the SDAI core UI layer.

Functions

addCloseable

expect open fun addCloseable(closeable: AutoCloseable)

expect fun addCloseable(key: String, closeable: AutoCloseable)

clear

@MainThread

internal expect fun clear()

emitEffect

protected fun emitEffect(effect: E)

Executes the emitEffect step in the SDAI core UI layer.

emitState

protected fun emitState(state: S)

Executes the emitState step in the SDAI core UI layer.

getCloseable

expect fun <T : AutoCloseable> getCloseable(key: String): T?

launch

protected fun launch(dispatcher: CoroutineDispatcher, start: CoroutineStart = CoroutineStart.DEFAULT, block: suspend CoroutineScope.() -> Unit): Job

Executes the launch step in the SDAI core UI layer.

onCleared

protected expect open fun onCleared()

processIntent

abstract fun processIntent(intent: I)

Executes the processIntent step in the SDAI core UI layer.

updateState

protected fun updateState(mutation: (S) -> S)

Performs the SDAI side effect handled by updateState.