OnBackInvokedInput

Artifact: androidx.navigationevent:navigationevent

Added in 1.0.1

Kotlin |Java

android

@RequiresApi(value = 33)
sealed class OnBackInvokedInput : NavigationEventInput

kotlin.Any
↳	androidx.navigationevent.NavigationEventInput
	↳	androidx.navigationevent.OnBackInvokedInput

Known direct subclasses

OnBackInvokedDefaultInput, OnBackInvokedOverlayInput

`OnBackInvokedDefaultInput`	Provides input to a `NavigationEventDispatcher` by registering an `OnBackInvokedCallback` with the `OnBackInvokedDispatcher.PRIORITY_DEFAULT` priority to `onBackInvokedDispatcher`.
`OnBackInvokedOverlayInput`	Provides input to a `NavigationEventDispatcher` by registering an `OnBackInvokedCallback` with the `OnBackInvokedDispatcher.PRIORITY_OVERLAY` priority to `onBackInvokedDispatcher`.

Provides input to a NavigationEventDispatcher by registering an OnBackInvokedCallback to the passed in onBackInvokedDispatcher.

Summary

Protected constructors
`OnBackInvokedInput( onBackInvokedDispatcher: OnBackInvokedDispatcher, onBackInvokedCallbackPriority: Int )`	android

Protected functions
`open Unit`	`onHasEnabledHandlersChanged(hasEnabledHandlers: Boolean)` Called when the enabled state of handlers in the connected `NavigationEventDispatcher` changes.	android
`open Unit`	`onRemoved()` Called after this `NavigationEventInput` is removed from a `NavigationEventDispatcher`.	android

Inherited functions

From androidx.navigationevent.NavigationEventInput

`Unit`	`@MainThread dispatchOnBackCancelled()` Notifies the dispatcher that the ongoing `TRANSITIONING_BACK` navigation gesture has been cancelled.	android
`Unit`	`@MainThread dispatchOnBackCompleted()` Notifies the dispatcher that the ongoing `TRANSITIONING_BACK` navigation gesture has completed.	android
`Unit`	`@MainThread dispatchOnBackProgressed(event: NavigationEvent)` Notifies the dispatcher that an ongoing `TRANSITIONING_BACK` navigation gesture has progressed.	android
`Unit`	`@MainThread dispatchOnBackStarted(event: NavigationEvent)` Notifies the dispatcher that a `TRANSITIONING_BACK` navigation gesture has started.	android
`Unit`	`@MainThread dispatchOnForwardCancelled()` Notifies the dispatcher that the ongoing `TRANSITIONING_FORWARD` navigation gesture has been cancelled.	android
`Unit`	`@MainThread dispatchOnForwardCompleted()` Notifies the dispatcher that the ongoing `TRANSITIONING_FORWARD` navigation gesture has completed.	android
`Unit`	`@MainThread dispatchOnForwardProgressed(event: NavigationEvent)` Notifies the dispatcher that an ongoing `TRANSITIONING_FORWARD` navigation gesture has progressed.	android
`Unit`	`@MainThread dispatchOnForwardStarted(event: NavigationEvent)` Notifies the dispatcher that a `TRANSITIONING_FORWARD` navigation gesture has started.	android
`open Unit`	`@MainThread @EmptySuper onAdded(dispatcher: NavigationEventDispatcher)` Called after this `NavigationEventInput` is added to `dispatcher`.	android
`open Unit`	`@MainThread @EmptySuper onHistoryChanged(history: NavigationEventHistory)` Called when the `NavigationEventHistory` state in the connected `NavigationEventDispatcher` changes.	android

Protected constructors

OnBackInvokedInput

android

protected OnBackInvokedInput(
    onBackInvokedDispatcher: OnBackInvokedDispatcher,
    onBackInvokedCallbackPriority: Int
)

Parameters
`onBackInvokedDispatcher: OnBackInvokedDispatcher`	the `OnBackInvokedDispatcher` to use.
`onBackInvokedCallbackPriority: Int`	the priority to use.

Protected functions

onHasEnabledHandlersChanged

android

protected open fun onHasEnabledHandlersChanged(hasEnabledHandlers: Boolean): Unit

Called when the enabled state of handlers in the connected NavigationEventDispatcher changes.

This allows the input to enable or disable its own event sourcing. For example, a system back gesture input might only register for gestures when hasEnabledHandlers is true.

The exact set of handlers this reflects depends on the Priority this input was registered with.

Parameters
`hasEnabledHandlers: Boolean`	Whether the connected dispatcher has any enabled handlers matching this input's priority scope.

onRemoved

android

protected open fun onRemoved(): Unit

Called after this NavigationEventInput is removed from a NavigationEventDispatcher. This can happen when calling NavigationEventDispatcher.removeInput or NavigationEventDispatcher.dispose on the containing NavigationEventDispatcher.