circuit-retained/com.slack.circuit.retained/RetainedStateRegistry

RetainedStateRegistry

interface RetainedStateRegistry(source)

Allows components to save and restore their state using the onRetainNonConfigurationInstance mechanism.

Inheritors

NoOpRetainedStateRegistry

Types

Entry

interface Entry

The registry entry which you get when you use registerValue.

Functions

consumeValue

abstract fun consumeValue(key: String): Any?

Returns the restored value for the given key. Once being restored the value is cleared, so you can't restore the same key twice.

forgetUnclaimedValues

abstract fun forgetUnclaimedValues()

Releases all currently unconsumed values. Useful as a GC mechanism for the registry.

forgetValue

abstract fun forgetValue(key: String)

Releases the values stored under key, dispatching forget callbacks to any that observe them. The single-key counterpart to forgetUnclaimedValues.

registerValue

abstract fun registerValue(key: String, valueProvider: RetainedValueProvider): RetainedStateRegistry.Entry

Registers the value provider.

saveAll

abstract fun saveAll(): Map<String, List<Any?>>

Executes all the registered value providers and combines these values into a map. We have a list of values for each key as it is allowed to have multiple providers for the same key.

saveValue

abstract fun saveValue(key: String)

Executes the value providers registered with the given key, and saves them for retrieval.