Package org.orbitmvi.orbit.viewmodel

Types

AndroidIdlingResource

class AndroidIdlingResource : IdlingResource

Functions

container

fun <STATE : Any, SIDE_EFFECT : Any> ViewModel.container(initialState: STATE, settings: Container.Settings = Container.Settings(), onCreate: (STATE) -> Unit? = null): Container<STATE, SIDE_EFFECT>

Creates a container scoped with ViewModelScope.

fun <STATE : Parcelable, SIDE_EFFECT : Any> ViewModel.container(initialState: STATE, savedStateHandle: SavedStateHandle, settings: Container.Settings = Container.Settings(idlingRegistry = AndroidIdlingResource()), onCreate: (STATE) -> Unit? = null): Container<STATE, SIDE_EFFECT>

Creates a container scoped with ViewModelScope and allows you to used the Android ViewModel's saved state support.

observe

fun <STATE : Any, SIDE_EFFECT : Any> ContainerHost<STATE, SIDE_EFFECT>.observe(lifecycleOwner: LifecycleOwner, state: suspend (STATE) -> Unit? = null, sideEffect: suspend (SIDE_EFFECT) -> Unit? = null)

Observe Container.stateFlow and Container.sideEffectFlow correctly on Android in one-line of code. These streams are observed when the view is in Lifecycle.State.STARTED.