ContainerHost

interface ContainerHost<STATE : Any, SIDE_EFFECT : Any>

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

Link copied to clipboard
abstract val container: Container<STATE, SIDE_EFFECT>

The orbit Container instance.

Extensions

Link copied to clipboard
fun <STATE : Any, SIDE_EFFECT : Any> ContainerHost<STATE, SIDE_EFFECT>.intent(registerIdling: Boolean = true, transformer: suspend SimpleSyntax<STATE, SIDE_EFFECT>.() -> Unit)

Build and execute an intent on Container.