StoreConfigurationBuilder

A builder class for creating StoreConfigurations.

Properties

Link copied to clipboard

Provide the ActionShareBehavior for the store. For stores where actions are of type Nothing this must be set to ActionShareBehavior.Disabled. Will be set automatically when using the two-argument store builder.

Link copied to clipboard

A flag to indicate that clients may subscribe to this store even while it is not started. If you intend to stop and restart your store while the subscribers are present, set this to true.

Link copied to clipboard

Enables transaction serialization for state updates, making state updates atomic and suspendable.

Link copied to clipboard

A coroutine context overrides for the Store. This context will be merged with the one the store was launched with (e.g. viewModelScope).

Link copied to clipboard

Settings this to true enables additional Store validations and debug logging.

Link copied to clipboard

Designate the maximum capacity of MVIIntents waiting for processing in the pro.respawn.flowmvi.api.IntentReceiver's queue. Intents that overflow this capacity will be processed according to onOverflow. This should be either a positive value, or one of:

Link copied to clipboard

StoreLogger used for this store. If debuggable is true and logger has not been set, then PlatformStoreLogger will be used, else NoOpStoreLogger will be used.

Link copied to clipboard
var name: String?

Set the future name of the store. See Store.name for more info.

Link copied to clipboard
var onOverflow: BufferOverflow

Designate behavior for when IntentReceiver's MVIIntent pool overflows.

Link copied to clipboard

Declare that MVIIntents must be processed in parallel. All guarantees on the order of MVIIntents will be lost. Intents may still be dropped according to onOverflow. Intents are not obtained in parallel, just processed.