SavedStateRegistry

public SavedStateRegistry()

Creates an empty SavedStateRegistry.

public SavedStateRegistry(@NonNull Bundle initialState)

Creates a SavedStateRegistry initialized with initialState.

@MainThread
public final SavedState consumeRestoredStateForKey(@NonNull String key)

Consumes the saved state previously supplied by a SavedStateProvider registered with the given key.

If the registered SavedStateProvider implements SavedStateRestorer, the state is restored automatically during restoration, and calls to this method with the same key return null.

This call clears the internal reference to the returned saved state. Subsequent calls with the same key return null.

All unconsumed values are preserved during state saving.

public final SavedStateRegistry.SavedStateProvider getSavedStateProvider(@NonNull String key)

Returns the SavedStateProvider previously registered with registerSavedStateProvider, or null if no provider has been registered with the given key.

@MainThread
public final boolean isRestored()

Returns true if state has been restored and can be safely consumed with consumeRestoredStateForKey, false otherwise.

@MainThread
public final void registerSavedStateProvider(
    @NonNull String key,
    @NonNull SavedStateRegistry.SavedStateProvider provider
)

Registers a SavedStateProvider with the given key.

This SavedStateProvider will be called during state saving. The returned state is associated with the given key and can be consumed after restoration via consumeRestoredStateForKey.

If the registered provider implements SavedStateRestorer, its SavedStateRestorer.restoreState method is automatically invoked during state restoration, or immediately if state has already been restored.

If a provider was already registered with the given key, it is replaced with the new provider.

public void restoreState(Bundle savedState)

Called to restore the state of a component.

@MainThread
public final void runOnNextRecreation(
    @NonNull Class<@NonNull SavedStateRegistry.AutoRecreated> clazz
)

Executes the given class when the owning component restarted.

The given class will be automatically instantiated via default constructor and method AutoRecreated.onRecreated will be called. It is called as part of dispatching of androidx.lifecycle.Lifecycle.Event.ON_CREATE event.

public @NonNull SavedState saveState()

Called to retrieve the state from a component before it is killed so the state can be retrieved later from SavedStateRegistry.consumeRestoredStateForKey.

@MainThread
public final void unregisterSavedStateProvider(@NonNull String key)

Unregisters a component previously registered with the given key.