SavedStateConfigurationKt

Added in 1.3.0

Kotlin |Java

public final class SavedStateConfigurationKt

Summary

Public methods
`static final @NonNull SavedStateConfiguration`	`SavedStateConfiguration( @NonNull SavedStateConfiguration from, @NonNull Function1<@NonNull SavedStateConfiguration.Builder, Unit> builderAction )` Creates an instance of `SavedStateConfiguration` configured from the optionally given `from` and adjusted with `builderAction`.

Public methods

SavedStateConfiguration

Artifact: androidx.savedstate:savedstate

View Source

Added in 1.3.0

public static final @NonNull SavedStateConfiguration SavedStateConfiguration(
    @NonNull SavedStateConfiguration from,
    @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`.
`@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.