LifecycleOwner

Kotlin |Java

interface LifecycleOwner

androidx.lifecycle.LifecycleOwner

Known Direct Subclasses

ComponentActivity, Fragment, LifecycleRegistryOwner, LifecycleService, NavBackStackEntry, OnBackPressedDispatcherOwner, ProcessLifecycleOwner, SavedStateRegistryOwner

ComponentActivity	Base class for activities that enables composition of higher level components.
Fragment	Static library support version of the framework's `android.app.Fragment`.
LifecycleRegistryOwner
LifecycleService	A Service that is also a `LifecycleOwner`.
NavBackStackEntry	Representation of an entry in the back stack of a `NavController`.
OnBackPressedDispatcherOwner	A class that has an `OnBackPressedDispatcher` that allows you to register a `OnBackPressedCallback` for handling the system back button.
ProcessLifecycleOwner	Class that provides lifecycle for the whole application process.
SavedStateRegistryOwner	A scope that owns `SavedStateRegistry`

Known Indirect Subclasses

AbstractProgressFragment, AbstractProgressFragment, AmbientModeSupport, AmbientModeSupport, AppCompatActivity, AppCompatActivity, AppCompatActivity, AppCompatDialogFragment, AppCompatDialogFragment, BaseLeanbackPreferenceFragmentCompat, BaseLeanbackPreferenceFragmentCompat, BaseSupportFragment, and 64 others.

AbstractProgressFragment	The base class for Fragments that handle dynamic feature installation.
AbstractProgressFragment	The base class for Fragments that handle dynamic feature installation.
AmbientModeSupport	Use this as a headless Fragment to add ambient support to an Activity on Wearable devices.
AmbientModeSupport	Use this as a headless Fragment to add ambient support to an Activity on Wearable devices.
AppCompatActivity	Base class for activities that wish to use some of the newer platform features on older Android devices.
AppCompatActivity	Base class for activities that wish to use some of the newer platform features on older Android devices.
AppCompatActivity	Base class for activities that wish to use some of the newer platform features on older Android devices.
AppCompatDialogFragment	A special version of `DialogFragment` which uses an `AppCompatDialog` in place of a platform-styled dialog.
AppCompatDialogFragment	A special version of `DialogFragment` which uses an `AppCompatDialog` in place of a platform-styled dialog.
BaseLeanbackPreferenceFragmentCompat	This fragment provides a preference fragment with leanback-style behavior, suitable for embedding into broader UI elements.
BaseLeanbackPreferenceFragmentCompat	This fragment provides a preference fragment with leanback-style behavior, suitable for embedding into broader UI elements.
BaseSupportFragment	Base class for leanback Fragments.
BaseSupportFragment	Base class for leanback Fragments.
BrandedSupportFragment	Fragment class for managing search and branding using a view that implements `TitleViewAdapter.Provider`.
BrandedSupportFragment	Fragment class for managing search and branding using a view that implements `TitleViewAdapter.Provider`.
BrowseSupportFragment	A fragment for creating Leanback browse screens.
BrowseSupportFragment	A fragment for creating Leanback browse screens.
ComponentActivity	Base class for activities that enables composition of higher level components.
ComponentActivity	Base class for activities that enables composition of higher level components.
DefaultProgressFragment	The default androidx.fragment.app.Fragment to display during installation progress.
DefaultProgressFragment	The default androidx.fragment.app.Fragment to display during installation progress.
DetailsSupportFragment	A fragment for creating Leanback details screens.
DetailsSupportFragment	A fragment for creating Leanback details screens.
DialogFragment	Static library support version of the framework's `android.app.DialogFragment`.
DialogFragment	Static library support version of the framework's `android.app.DialogFragment`.
DynamicNavHostFragment	The NavHostFragment for dynamic features.
DynamicNavHostFragment	The NavHostFragment for dynamic features.
EditTextPreferenceDialogFragmentCompat
EditTextPreferenceDialogFragmentCompat
ErrorSupportFragment	A fragment for displaying an error indication.
ErrorSupportFragment	A fragment for displaying an error indication.
Fragment	Static library support version of the framework's `android.app.Fragment`.
FragmentActivity	Base class for activities that want to use the support-based `Fragments`.
FragmentActivity	Base class for activities that want to use the support-based `Fragments`.
FragmentActivity	Base class for activities that want to use the support-based `Fragments`.
GuidedStepSupportFragment	A GuidedStepSupportFragment is used to guide the user through a decision or series of decisions.
GuidedStepSupportFragment	A GuidedStepSupportFragment is used to guide the user through a decision or series of decisions.
LeanbackEditTextPreferenceDialogFragmentCompat	Implemented a dialog to input text.
LeanbackEditTextPreferenceDialogFragmentCompat	Implemented a dialog to input text.
LeanbackListPreferenceDialogFragmentCompat	Implemented a dialog to show `ListPreference` or `MultiSelectListPreference`.
LeanbackListPreferenceDialogFragmentCompat	Implemented a dialog to show `ListPreference` or `MultiSelectListPreference`.
LeanbackPreferenceDialogFragmentCompat	A fragment that shows `DialogPreference`, for example or `androidx.preference.MultiSelectListPreference`.
LeanbackPreferenceDialogFragmentCompat	A fragment that shows `DialogPreference`, for example or `androidx.preference.MultiSelectListPreference`.
LeanbackPreferenceFragmentCompat	This fragment provides a fully decorated leanback-style preference fragment, including a list background and header.
LeanbackPreferenceFragmentCompat	This fragment provides a fully decorated leanback-style preference fragment, including a list background and header.
LeanbackSettingsFragmentCompat	This fragment provides a container for displaying a `LeanbackPreferenceFragmentCompat`
LeanbackSettingsFragmentCompat	This fragment provides a container for displaying a `LeanbackPreferenceFragmentCompat`
ListFragment	Static library support version of the framework's `android.app.ListFragment`.
ListFragment	Static library support version of the framework's `android.app.ListFragment`.
ListPreferenceDialogFragmentCompat
ListPreferenceDialogFragmentCompat
MediaRouteChooserDialogFragment	Media route chooser dialog fragment.
MediaRouteChooserDialogFragment	Media route chooser dialog fragment.
MediaRouteControllerDialogFragment	Media route controller dialog fragment.
MediaRouteControllerDialogFragment	Media route controller dialog fragment.
MediaRouteDiscoveryFragment	Media route discovery fragment.
MediaRouteDiscoveryFragment	Media route discovery fragment.
MultiSelectListPreferenceDialogFragmentCompat
MultiSelectListPreferenceDialogFragmentCompat
NavBackStackEntry	Representation of an entry in the back stack of a `NavController`.
NavHostFragment	NavHostFragment provides an area within your layout for self-contained navigation to occur.
NavHostFragment	NavHostFragment provides an area within your layout for self-contained navigation to occur.
OnboardingSupportFragment	An OnboardingSupportFragment provides a common and simple way to build onboarding screen for applications.
OnboardingSupportFragment	An OnboardingSupportFragment provides a common and simple way to build onboarding screen for applications.
PlaybackSupportFragment	A fragment for displaying playback controls and related content.
PlaybackSupportFragment	A fragment for displaying playback controls and related content.
PreferenceDialogFragmentCompat	Abstract base class which presents a dialog associated with a `DialogPreference`.
PreferenceDialogFragmentCompat	Abstract base class which presents a dialog associated with a `DialogPreference`.
PreferenceFragmentCompat	A PreferenceFragmentCompat is the entry point to using the Preference library.
PreferenceFragmentCompat	A PreferenceFragmentCompat is the entry point to using the Preference library.
SearchSupportFragment	A fragment to handle searches.
SearchSupportFragment	A fragment to handle searches.
VerticalGridSupportFragment	A fragment for creating leanback vertical grids.
VerticalGridSupportFragment	A fragment for creating leanback vertical grids.
VideoSupportFragment	Subclass of `PlaybackSupportFragment` that is responsible for providing a `SurfaceView` and rendering video.
VideoSupportFragment	Subclass of `PlaybackSupportFragment` that is responsible for providing a `SurfaceView` and rendering video.

A class that has an Android lifecycle. These events can be used by custom components to handle lifecycle changes without implementing any code inside the Activity or the Fragment.

Summary

Public methods
abstract Lifecycle	`getLifecycle()` Returns the Lifecycle of the provider.

Extension functions

From androidx.lifecycle

suspend T	`LifecycleOwner.whenCreated(block: suspend CoroutineScope.() -> T)` Runs the given block when the LifecycleOwner's Lifecycle is at least in Lifecycle.State.CREATED state.
suspend T	`LifecycleOwner.whenResumed(block: suspend CoroutineScope.() -> T)` Runs the given block when the LifecycleOwner's Lifecycle is at least in Lifecycle.State.RESUMED state.
suspend T	`LifecycleOwner.whenStarted(block: suspend CoroutineScope.() -> T)` Runs the given block when the LifecycleOwner's Lifecycle is at least in Lifecycle.State.STARTED state.
suspend R	`LifecycleOwner.withCreated(crossinline block: () -> R)` Run block with this LifecycleOwner's Lifecycle in a Lifecycle.State of at least Lifecycle.State.CREATED and resume with the result.
suspend R	`LifecycleOwner.withResumed(crossinline block: () -> R)` Run block with this LifecycleOwner's Lifecycle in a Lifecycle.State of at least Lifecycle.State.RESUMED and resume with the result.
suspend R	`LifecycleOwner.withStarted(crossinline block: () -> R)` Run block with this LifecycleOwner's Lifecycle in a Lifecycle.State of at least Lifecycle.State.STARTED and resume with the result.
suspend R	`LifecycleOwner.withStateAtLeast(state: Lifecycle.State, crossinline block: () -> R)` Run block with this LifecycleOwner's Lifecycle in a Lifecycle.State of at least state and resume with the result.

Extension properties

From androidx.lifecycle

LifecycleCoroutineScope

lifecycleScope

CoroutineScope tied to this LifecycleOwner's Lifecycle.

Public methods

getLifecycle

@NonNull abstract fun getLifecycle(): Lifecycle

Returns the Lifecycle of the provider.

Return
`Lifecycle`	The lifecycle of the provider.