SavedStateConfigurationKt

Added in 1.3.0-alpha10

public final class SavedStateConfigurationKt

Summary

Public methods
static final @NonNull SavedStateConfiguration

Creates an instance of SavedStateConfiguration configured from the optionally given from and adjusted with builderAction.

Public methods

SavedStateConfiguration

public static final @NonNull SavedStateConfiguration SavedStateConfiguration(
    @NonNull SavedStateConfiguration from,
    @ExtensionFunctionType @NonNull Function1<@NonNull SavedStateConfiguration.Builder, Unit> builderAction
)

Creates an instance of SavedStateConfiguration configured from the optionally given from and adjusted with builderAction.

import androidx.savedstate.serialization.SavedStateConfiguration
import androidx.savedstate.serialization.decodeFromSavedState
import androidx.savedstate.serialization.encodeToSavedState

val config = SavedStateConfiguration {
    serializersModule = SerializersModule {
        polymorphic(Any::class) { subclass(String::class) }
    }
}
val value = "foo"
val encoded =
    encodeToSavedState(
        serializer = PolymorphicSerializer(Any::class),
        value = value,
        configuration = config
    )
val decoded =
    decodeFromSavedState(
        deserializer = PolymorphicSerializer(Any::class),
        savedState = encoded,
        configuration = config
    )
Parameters
@NonNull SavedStateConfiguration from

An optional initial SavedStateConfiguration to start with. Defaults to SavedStateConfiguration.DEFAULT.
@ExtensionFunctionType @NonNull Function1<@NonNull SavedStateConfiguration.Builder, Unit> builderAction

A lambda function to configure the Builder for additional customization.
Returns
@NonNull SavedStateConfiguration

A new SavedStateConfiguration instance configured based on the provided parameters.