{% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

Class Index

These are all the API classes. See all API packages.

A  C  D  E  H  I  L  M  O  P  S  T  V  

A

AbstractSavedStateViewModelFactory

Skeleton of androidx.lifecycle.ViewModelProvider.KeyedFactory that creates SavedStateHandle for every requested ViewModel.

AdapterClass
AndroidViewModel

Application context aware ViewModel.

C

CreationExtras

Simple map-like object that passed in ViewModelProvider.Factory.create to provide an additional information to a factory.

CreationExtras.Empty

Empty CreationExtras

CreationExtras.Key

Key for the elements of CreationExtras.

D

DefaultLifecycleObserver

Callback interface for listening to LifecycleOwner state changes.

E

ErrorMessages
EventMethod
EventMethodCall

H

HasDefaultViewModelProviderFactory

Interface that marks a ViewModelStoreOwner as having a default ViewModelProvider.Factory for use with ViewModelProvider.

I

InitializerViewModelFactoryBuilder

DSL for constructing a new ViewModelProvider.Factory

InputModel

L

Lifecycle

Defines an object that has an Android Lifecycle.

Lifecycle.Event
Lifecycle.State

Lifecycle states.

LifecycleCoroutineScope

CoroutineScope tied to a Lifecycle and Dispatchers.Main.immediate

LifecycleDestroyedException

A CancellationException that indicates that the Lifecycle associated with an operation reached the Lifecycle.State.DESTROYED state before the operation could complete.

LifecycleEventObserver

Class that can receive any lifecycle change and dispatch it to the receiver.

LifecycleObserver

Marks a class as a LifecycleObserver.

LifecycleObserverInfo
LifecycleOwner

A class that has an Android lifecycle.

LifecycleProcessor
LifecycleRegistry

An implementation of Lifecycle that can handle multiple observers.

LifecycleRegistryOwner

This interface is deprecated.

Use androidx.appcompat.app.AppCompatActivity which extends LifecycleOwner, so there are no use cases for this class.

LifecycleService

A Service that is also a LifecycleOwner.

LiveData

LiveData is a data holder class that can be observed within a given lifecycle.

LiveDataScope

Interface that allows controlling a LiveData from a coroutine block.

M

MediatorLiveData

LiveData subclass which may observe other LiveData objects and react on OnChanged events from them.

MutableCreationExtras

Mutable implementation of CreationExtras

MutableLiveData

LiveData which publicly exposes setValue and postValue method.

O

Observer

A simple callback that can receive from LiveData.

ObserversCollector
OnLifecycleEvent

This annotation is deprecated.

This annotation required the usage of code generation or reflection, which should be avoided.

P

ProcessLifecycleInitializer

Initializes ProcessLifecycleOwner using androidx.startup.

ProcessLifecycleOwner

Class that provides lifecycle for the whole application process.

S

SavedStateHandle

A handle to saved state passed down to androidx.lifecycle.ViewModel.

SavedStateViewModelFactory

androidx.lifecycle.ViewModelProvider.Factory that can create ViewModels accessing and contributing to a saved state via SavedStateHandle received in a constructor.

ServiceLifecycleDispatcher

Helper class to dispatch lifecycle events for a Service.

T

TestLifecycleOwner

Create a LifecycleOwner that allows changing the state via the handleLifecycleEvent method or currentState property.

V

Validator
ViewModel

ViewModel is a class that is responsible for preparing and managing the data for an Activity or a Fragment.

ViewModelFactoryDsl
ViewModelInitializer

Holds a ViewModel class and initializer for that class

ViewModelLazy

An implementation of Lazy used by androidx.fragment.app.Fragment.viewModels and androidx.activity.ComponentActivity.viewmodels.

ViewModelProvider

A utility class that provides ViewModels for a scope.

ViewModelProvider.AndroidViewModelFactory

Factory which may create AndroidViewModel and ViewModel, which have an empty constructor.

ViewModelProvider.Factory

Implementations of Factory interface are responsible to instantiate ViewModels.

ViewModelProvider.NewInstanceFactory

Simple factory, which calls empty constructor on the give class.

ViewModelStore

Class to store ViewModels.

ViewModelStoreOwner

A scope that owns ViewModelStore.