OnBackInvokedDispatcher  |  API reference  |  Android Developers (original) (raw)

interface OnBackInvokedDispatcher

Dispatcher to register [OnBackInvokedCallback](/reference/kotlin/android/window/OnBackInvokedCallback) instances for handling back invocations. It also provides interfaces to update the attributes of [OnBackInvokedCallback](/reference/kotlin/android/window/OnBackInvokedCallback). Attribute updates are proactively pushed to the window manager if they change the dispatch target (a.k.a. the callback to be invoked next), or its behavior.

Summary

Constants

PRIORITY_OVERLAY

static val PRIORITY_OVERLAY: Int

Priority level of [OnBackInvokedCallback](/reference/kotlin/android/window/OnBackInvokedCallback)s for overlays such as menus and navigation drawers that should receive back dispatch before non-overlays.

Value: 1000000

PRIORITY_SYSTEM_NAVIGATION_OBSERVER

static val PRIORITY_SYSTEM_NAVIGATION_OBSERVER: Int

Priority level of [OnBackInvokedCallback](/reference/kotlin/android/window/OnBackInvokedCallback)s designed to observe system-level back handling.

Callbacks registered with this priority are invoked only when a back event is not consumed by any other registered [OnBackInvokedCallback](/reference/kotlin/android/window/OnBackInvokedCallback) with a priority of [PRIORITY_DEFAULT](#PRIORITY%5FDEFAULT:kotlin.Int) or higher. This means they are called when the system is about to perform its default back navigation action, such as finishing the current activity or executing a back-to-home animation.

These callbacks are purely observational. They do not consume the back event and cannot intercept it. Their invocation has no impact on the normal back navigation flow, making them suitable for logging, analytics, or triggering actions that should not prevent the system's own back handling.

The invocation order for multiple callbacks registered with this priority is undefined.

On API level 36 only, there is a restriction that only one callback with [PRIORITY_SYSTEM_NAVIGATION_OBSERVER](#PRIORITY%5FSYSTEM%5FNAVIGATION%5FOBSERVER:kotlin.Int) can be registered at a time. On API level 37 and higher, the number of registered observer callbacks is unrestricted.

Value: -2

Public methods

registerOnBackInvokedCallback

abstract fun registerOnBackInvokedCallback(
    priority: Int,
    callback: OnBackInvokedCallback
): Unit

Registers a [OnBackInvokedCallback](/reference/kotlin/android/window/OnBackInvokedCallback). Within the same priority level, callbacks are invoked in the reverse order in which they are registered. Higher priority callbacks are invoked before lower priority ones.