viewmodel-savedstate/com.hoc081098.kmp.viewmodel/SavedStateHandle

SavedStateHandle

actual typealias SavedStateHandle = androidx.lifecycle.SavedStateHandle
expect class SavedStateHandle

A multiplatform alias for androidx.lifecycle.SavedStateHandle from the androidx.lifecycle:lifecycle-viewmodel-savedstate library.

On Android

This is a key-value map that will let you write and retrieve objects to and from the saved state. These values will persist after the process is killed by the system and remain available via the same object.

You can read a value from it via get or observe it via StateFlow returned by getStateFlow. You can write a value to it via set.

On other platforms

This acts as a simple key-value map.

Type-safe access to SavedStateHandle

You can use SafeSavedStateHandle with NonNullSavedStateHandleKey and NullableSavedStateHandleKey to enable type-safe access to SavedStateHandle

See also

actual class SavedStateHandle

Constructors

Link copied to clipboard
expect constructor(initialState: Map<String, Any?>)

Creates a handle with the given initial arguments.

expect constructor()

Creates a handle with the empty state.

actual constructor(initialState: Map<String, Any?>)
actual constructor()

Properties

Link copied to clipboard

Functions

Link copied to clipboard
@MainThread
expect operator fun contains(key: String): Boolean
@MainThread
actual operator fun contains(key: String): Boolean
Link copied to clipboard
@MainThread
expect operator fun <T> get(key: String): T?

Returns a value associated with the given key.

@MainThread
actual operator fun <T> get(key: String): T?
Link copied to clipboard
@MainThread
expect fun <T> getStateFlow(key: String, initialValue: T): StateFlow<T>

Returns a StateFlow that will emit the currently active value associated with the given key.

@MainThread
actual fun <T> getStateFlow(key: String, initialValue: T): StateFlow<T>
Link copied to clipboard
@MainThread
expect fun keys(): Set<String>

Returns all keys contained in this SavedStateHandle.

@MainThread
actual fun keys(): Set<String>
Link copied to clipboard
@MainThread
expect fun <T> remove(key: String): T?

Removes a value associated with the given key. If there is a StateFlow associated with the given key, they will be removed as well.

@MainThread
actual fun <T> remove(key: String): T?
Link copied to clipboard
inline fun <R> SavedStateHandle.safe(block: (SafeSavedStateHandle) -> R): R

Enables type-safe access to SavedStateHandle. You can use this with NonNullSavedStateHandleKeys and NullableSavedStateHandleKeys.

Link copied to clipboard
@MainThread
expect operator fun <T> set(key: String, value: T?)

Associate the given value with the key. On Android, the value must have a type that could be stored in android.os.Bundle. On other platforms, the value can be of any type.

@MainThread
actual operator fun <T> set(key: String, value: T?)