OnBackInvokedOverlayInput

Artifact: androidx.navigationevent:navigationevent

Kotlin |Java

@RequiresApi(value = 33)
public final class OnBackInvokedOverlayInput extends OnBackInvokedInput

java.lang.Object
↳	androidx.navigationevent.NavigationEventInput
	↳	androidx.navigationevent.OnBackInvokedInput
		↳	androidx.navigationevent.OnBackInvokedOverlayInput

Provides input to a NavigationEventDispatcher by registering an OnBackInvokedCallback with the OnBackInvokedDispatcher.PRIORITY_OVERLAY priority to onBackInvokedDispatcher. The input will unregister this callback when there's no enabled NavigationEventHandler with NavigationEventDispatcher.PRIORITY_OVERLAY priority.

Summary

Public constructors
`OnBackInvokedOverlayInput( @NonNull OnBackInvokedDispatcher onBackInvokedDispatcher )`

Inherited methods

From androidx.navigationevent.NavigationEventInput

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

From androidx.navigationevent.OnBackInvokedInput

`void`	`onHasEnabledHandlersChanged(boolean hasEnabledHandlers)` Called when the enabled state of handlers in the connected `NavigationEventDispatcher` changes.
`void`	`onRemoved()` Called after this `NavigationEventInput` is removed from a `NavigationEventDispatcher`.

Public constructors

OnBackInvokedOverlayInput

Added in 1.0.0-alpha09

public OnBackInvokedOverlayInput(
    @NonNull OnBackInvokedDispatcher onBackInvokedDispatcher
)

Parameters
`@NonNull OnBackInvokedDispatcher onBackInvokedDispatcher`	the `OnBackInvokedDispatcher` to use.