OnBackPressedDispatcherOwner

Kotlin |Java

interface OnBackPressedDispatcherOwner : LifecycleOwner

androidx.activity.OnBackPressedDispatcherOwner

Known Direct Subclasses ComponentActivity ComponentActivity Base class for activities that enables composition of higher level components.

Known Indirect Subclasses AppCompatActivity, FragmentActivity, WatchFaceConfigActivity AppCompatActivity Base class for activities that wish to use some of the newer platform features on older Android devices. FragmentActivity Base class for activities that want to use the support-based Fragments. WatchFaceConfigActivity Config activity for the watch face, which supports complication and provider selection, as well as userStyle configuration.

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

Summary

Public methods
abstract OnBackPressedDispatcher	getOnBackPressedDispatcher() Retrieve the OnBackPressedDispatcher that should handle the system back button.

Inherited functions
From class LifecycleOwner Lifecycle getLifecycle() Returns the Lifecycle of the provider.

Public methods

getOnBackPressedDispatcher

@NonNull abstract fun getOnBackPressedDispatcher(): OnBackPressedDispatcher

Retrieve the OnBackPressedDispatcher that should handle the system back button.

Return
OnBackPressedDispatcher	The OnBackPressedDispatcher.