orbit-core/org.orbitmvi.orbit/ContainerHost

ContainerHost

interface ContainerHost<STATE : Any, SIDE_EFFECT : Any>(source)

Apply this interface to anything you want to become an orbit container host. Typically this will be an Android ViewModel but it can be applied to simple presenters etc.

Extension functions intent and orbit are provided as a convenient way of launching orbit intents on the container.

Properties

container

abstract val container: Container<STATE, SIDE_EFFECT>

The orbit Container instance.

Functions

blockingIntent

fun <STATE : Any, SIDE_EFFECT : Any> ContainerHost<STATE, SIDE_EFFECT>.blockingIntent(registerIdling: Boolean = true, transformer: suspend Syntax<STATE, SIDE_EFFECT>.() -> Unit)

Build and execute an intent on Container in a blocking manner, without dispatching.

intent

open fun intent(registerIdling: Boolean = true, transformer: suspend Syntax<STATE, SIDE_EFFECT>.() -> Unit): Job

Build and execute an intent on Container.

subIntent

open suspend fun subIntent(transformer: suspend Syntax<STATE, SIDE_EFFECT>.() -> Unit)

Used for parallel decomposition or subdivision of a larger intent into smaller parts.