OrbitContainer
The heart of the Orbit MVI system. Represents an MVI container with its input and outputs. You can manipulate the container through the orbit function
Parameters
The container's internal state type.
The container's external (exposed) state type. When the same as INTERNAL_STATE, the container exposes its internal state directly.
The type of side effects posted by this container. Can be Nothing if this container never posts side effects.
Inheritors
Properties
A version of externalStateFlow ref-counted for the Syntax.repeatOnSubscription operator. Do not use when subscribing to state updates within your OrbitContainerHost.
A StateFlow of external state updates. Derived from stateFlow via transformState. Emits the latest state upon subscription and serves only distinct values (through equality comparison).
A version of sideEffectFlow ref-counted for the Syntax.repeatOnSubscription operator. Do not use when subscribing to state updates within your OrbitContainerHost.
A version of stateFlow ref-counted for the Syntax.repeatOnSubscription operator. Do not use when subscribing to state updates within your OrbitContainerHost.
Settings that the container was set up with
A Flow of one-off side effects posted from OrbitContainer. Caches side effects when there are no collectors. The size of the cache can be controlled via SettingsBuilder and determines if and when the orbit thread suspends when you post a side effect.
A StateFlow of internal state updates. Emits the latest state upon subscription and serves only distinct values (through equality comparison).
Functions
Executes an orbit intent inline, circumventing orbit's dispatching. The intents are built in the OrbitContainerHost using your chosen syntax.
Joins all in progress intents in the container. This suspends until all intents have completed.
Executes an orbit intent. The intents are built in the OrbitContainerHost using your chosen syntax.
Wraps an OrbitContainer with an external state transformation.