SavedStateViewModelFactory

Kotlin |Java

class SavedStateViewModelFactory : KeyedFactory

androidx.lifecycle.SavedStateViewModelFactory

androidx.lifecycle.ViewModelProvider.Factory that can create ViewModels accessing and contributing to a saved state via SavedStateHandle received in a constructor. If defaultArgs bundle was passed into the constructor, it will provide default values in SavedStateHandle.

If ViewModel is instance of androidx.lifecycle.AndroidViewModel, it looks for a constructor that receives an Application and SavedStateHandle (in this order), otherwise it looks for a constructor that receives SavedStateHandle only. androidx.lifecycle.AndroidViewModel is only supported if you pass a non-null Application instance.

Summary

Public constructors
<init>(@Nullable application: Application?, @NonNull owner: SavedStateRegistryOwner) Creates SavedStateViewModelFactory.
<init>(@Nullable application: Application?, @NonNull owner: SavedStateRegistryOwner, @Nullable defaultArgs: Bundle?) Creates SavedStateViewModelFactory.

Public methods
T	create(@NonNull key: String, @NonNull modelClass: Class<T>)
T	create(@NonNull modelClass: Class<T>)

Public constructors

<init>

SavedStateViewModelFactory(
    @Nullable application: Application?, 
    @NonNull owner: SavedStateRegistryOwner)

Creates SavedStateViewModelFactory.

androidx.lifecycle.ViewModel created with this factory can access to saved state scoped to the given activity.

Parameters
application	Application?: an application. If null, AndroidViewModel instances will not be supported.
owner	SavedStateRegistryOwner: SavedStateRegistryOwner that will provide restored state for created ViewModels

<init>

SavedStateViewModelFactory(
    @Nullable application: Application?, 
    @NonNull owner: SavedStateRegistryOwner, 
    @Nullable defaultArgs: Bundle?)

Creates SavedStateViewModelFactory.

androidx.lifecycle.ViewModel created with this factory can access to saved state scoped to the given activity.

Parameters
application	Application?: an application. If null, AndroidViewModel instances will not be supported.
owner	SavedStateRegistryOwner: SavedStateRegistryOwner that will provide restored state for created ViewModels
defaultArgs	Bundle?: values from this Bundle will be used as defaults by SavedStateHandle if there is no previously saved state or previously saved state misses a value by such key.

Public methods

create

@NonNull fun <T : ViewModel!> create(
    @NonNull key: String, 
    @NonNull modelClass: Class<T>
): T

create

@NonNull fun <T : ViewModel!> create(@NonNull modelClass: Class<T>): T