viewmodel-savedstate/com.hoc081098.kmp.viewmodel.safe/SafeSavedStateHandle

SafeSavedStateHandle

value class SafeSavedStateHandle(val savedStateHandle: SavedStateHandle)

A wrapper of SavedStateHandle that provides type-safe access with NonNullSavedStateHandleKeys and NullableSavedStateHandleKeys.

Constructors

SafeSavedStateHandle

constructor(savedStateHandle: SavedStateHandle)

Properties

savedStateHandle

val savedStateHandle: SavedStateHandle

Functions

operator fun <T : Any> get(key: NonNullSavedStateHandleKey<T>): T

operator fun <T : Any> get(key: NullableSavedStateHandleKey<T>): T?

Get a value associated with the given key.

fun <T : Any> SafeSavedStateHandle.getLiveData(key: NonNullSavedStateHandleKey<T>): LiveData<T>

fun <T : Any> SafeSavedStateHandle.getLiveData(key: NullableSavedStateHandleKey<T>): LiveData<T?>

fun <T : Any> getStateFlow(key: NonNullSavedStateHandleKey<T>): StateFlow<T>

fun <T : Any> getStateFlow(key: NullableSavedStateHandleKey<T>): StateFlow<T?>

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

inline fun <T : Any> ~~remove~~(key: NonNullSavedStateHandleKey<T>): Nothing

Always throws UnsupportedOperationException.

inline fun <T : Any> remove(key: NullableSavedStateHandleKey<T>)

Removes a value associated with the given key.

inline operator fun <T : Any> set(key: NonNullSavedStateHandleKey<T>, value: T)

inline operator fun <T : Any> set(key: NullableSavedStateHandleKey<T>, value: T?)

Associate the given value with the key.