OnBackPressedDispatcherOwner

Artifact: androidx.activity:activity

View Source

Added in 1.0.0

---

Kotlin |Java

interface OnBackPressedDispatcherOwner : LifecycleOwner

Known direct subclasses

ComponentActivity, ComponentDialog

ComponentActivity	Base class for activities that enables composition of higher level components.
ComponentDialog	Base class for dialogs that enables composition of higher level components.

Known indirect subclasses

AlertDialog, AppCompatActivity, AppCompatDialog, BaseCarAppActivity, CarAppActivity, FragmentActivity, LauncherActivity, MediaRouteChooserDialog, MediaRouteControllerDialog, PreviewActivity, SdkActivity, SubspaceTestingActivity

AlertDialog	A subclass of Dialog that can display one, two or three buttons.
AppCompatActivity	Base class for activities that wish to use some of the newer platform features on older Android devices.
AppCompatDialog	Base class for AppCompat themed android.app.Dialogs.
BaseCarAppActivity	Core logic for CarAppLibrary Activity interaction with a host.
CarAppActivity	The class representing a car app activity in the main display.
FragmentActivity	Base class for activities that want to use the support-based Fragments.
LauncherActivity	This class handles providing the right launcher activity when running native applications and Car App Library applications.
MediaRouteChooserDialog	This class implements the route chooser dialog for MediaRouter.
MediaRouteControllerDialog	This class implements the route controller dialog for MediaRouter.
PreviewActivity	Activity used to run @Composable previews from Android Studio.
SdkActivity	Activity to start for SDKs running locally.
SubspaceTestingActivity	Custom test class that should be used for testing SubspaceComposable content.

---

A class that has an OnBackPressedDispatcher that allows you to register a OnBackPressedCallback for handling the system back button.

It is expected that classes that implement this interface route the system back button to the dispatcher

See also
OnBackPressedDispatcher

Summary

Public properties
OnBackPressedDispatcher	onBackPressedDispatcher The OnBackPressedDispatcher that should handle the system back button.

Inherited properties
From androidx.lifecycle.LifecycleOwner Lifecycle lifecycle

Public properties

onBackPressedDispatcher

Added in 1.0.0

val onBackPressedDispatcher: OnBackPressedDispatcher

The OnBackPressedDispatcher that should handle the system back button.