# SavedStateRegistry.SavedStateProvider

Artifact: [androidx.savedstate:savedstate](https://developer.android.com/jetpack/androidx/releases/savedstate) [View Source](https://cs.android.com/search?q=file:androidx/savedstate/SavedStateRegistry.+class:androidx.savedstate.SavedStateRegistry.SavedStateProvider) Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/savedstate#1.0.0)

*** ** * ** ***

Common/AllAndroid/JVM
- Cmn

  ```
  fun interface SavedStateRegistry.SavedStateProvider
  ```
Known direct subclasses [SavedStateValue](https://developer.android.com/reference/kotlin/androidx/savedstate/SavedStateValue)

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/savedstate/SavedStateValue` | Interface representing a saved state component holding a `https://developer.android.com/reference/kotlin/androidx/savedstate/SavedStateValue#value()`. |

*** ** * ** ***

Contributes to the saved state.

Implementations can optionally implement `https://developer.android.com/reference/kotlin/androidx/savedstate/SavedStateRegistry.SavedStateRestorer` to receive and restore state during the state restoration phase.

## Summary

| ### Public functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/savedstate/SavedState` | `https://developer.android.com/reference/kotlin/androidx/savedstate/SavedStateRegistry.SavedStateProvider#saveState()()` Called to retrieve the state from a component before it is killed so the state can be retrieved later from `https://developer.android.com/reference/kotlin/androidx/savedstate/SavedStateRegistry#consumeRestoredStateForKey(kotlin.String)`. | Cmn android |

## Public functions

### saveState

Cmn android Added in [1.0.0](https://developer.android.com/jetpack/androidx/releases/savedstate#1.0.0)

```
fun saveState(): SavedState
```

Called to retrieve the state from a component before it is killed so the state can be retrieved later from `https://developer.android.com/reference/kotlin/androidx/savedstate/SavedStateRegistry#consumeRestoredStateForKey(kotlin.String)`.

| Returns |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/savedstate/SavedState` | The `https://developer.android.com/reference/kotlin/androidx/savedstate/SavedState` containing the saved state. |