SavedStateRegistryController

Artifact: androidx.savedstate:savedstate

Added in 1.0.0

Kotlin |Java

Cmn
```
class SavedStateRegistryController
```

An API for SavedStateRegistryOwner implementations to control SavedStateRegistry.

SavedStateRegistryOwner should call performRestore to restore state of SavedStateRegistry and performSave to gather SavedState from it.

Summary

Public companion functions
`SavedStateRegistryController`	`create(owner: SavedStateRegistryOwner)` Creates a `SavedStateRegistryController`.	Cmn android

Public functions
`Unit`	`@MainThread performAttach()` Perform the initial, one time attachment necessary to configure this `SavedStateRegistry`.	Cmn android
`Unit`	`@MainThread performRestore(savedState: SavedState?)` An interface for an owner of this `SavedStateRegistry` to restore saved state.	Cmn android
`Unit`	`@MainThread performSave(outBundle: SavedState)` An interface for an owner of this `SavedStateRegistry` to perform state saving, it will call all registered providers and merge with unconsumed state.	Cmn android

Public properties
`SavedStateRegistry`	`savedStateRegistry` The `SavedStateRegistry` owned by this controller	Cmn android

Public companion functions

create

Cmn android

Added in 1.2.0

fun create(owner: SavedStateRegistryOwner): SavedStateRegistryController

Creates a SavedStateRegistryController.

It should be called during construction time of SavedStateRegistryOwner

Public functions

performAttach

Cmn android

Added in 1.2.0

@MainThread
fun performAttach(): Unit

Perform the initial, one time attachment necessary to configure this SavedStateRegistry. This must be called when the owner's Lifecycle is Lifecycle.State.INITIALIZED and before you call performRestore.

performRestore

Cmn android

@MainThread
fun performRestore(savedState: SavedState?): Unit

An interface for an owner of this SavedStateRegistry to restore saved state.

Parameters
`savedState: SavedState?`	restored state

performSave

Cmn android

@MainThread
fun performSave(outBundle: SavedState): Unit

An interface for an owner of this SavedStateRegistry to perform state saving, it will call all registered providers and merge with unconsumed state.

Parameters
`outBundle: SavedState`	SavedState in which to place a saved state

Public properties

savedStateRegistry

Cmn android

Added in 1.0.0

val savedStateRegistry: SavedStateRegistry

The SavedStateRegistry owned by this controller