OnBackInvokedOverlayInput

Artifact: androidx.navigationevent:navigationevent

View Source

Added in 1.0.0

---

Kotlin |Java

Common/AllAndroid/JVMJavaScript

• android

  @RequiresApi(value = 33)
  class OnBackInvokedOverlayInput : OnBackInvokedInput

kotlin.Any
↳	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(     onBackInvokedDispatcher: OnBackInvokedDispatcher )	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 onHasEnabledForwardHandlersChanged(hasEnabledForwardHandlers: Boolean) Called when the enabled state of forward handlers in the connected NavigationEventDispatcher changes. android open Unit @MainThread @EmptySuper onHasEnabledHandlersChanged(hasEnabledHandlers: Boolean) Called when the enabled state of handlers (either back or forward) in the connected NavigationEventDispatcher changes. android open Unit @MainThread @EmptySuper onHistoryChanged(history: NavigationEventHistory) Called when the NavigationEventHistory state in the connected NavigationEventDispatcher changes. android
From androidx.navigationevent.OnBackInvokedInput open Unit onHasEnabledBackHandlersChanged(hasEnabledBackHandlers: Boolean) Called when the enabled state of back handlers in the connected NavigationEventDispatcher changes. android open Unit onRemoved() Called after this NavigationEventInput is removed from a NavigationEventDispatcher. android

Inherited properties

From androidx.navigationevent.NavigationEventInput Boolean hasEnabledBackHandlers Tracks whether the connected NavigationEventDispatcher has any enabled NavigationEventHandler for back navigation matching this input's priority scope. android Boolean hasEnabledForwardHandlers Tracks whether the connected NavigationEventDispatcher has any enabled NavigationEventHandler for forward navigation matching this input's priority scope. android Boolean hasEnabledHandlers Tracks whether the connected NavigationEventDispatcher has any enabled NavigationEventHandler matching this input's priority scope. android

Public constructors

OnBackInvokedOverlayInput

android

Added in 1.0.0

OnBackInvokedOverlayInput(
    onBackInvokedDispatcher: OnBackInvokedDispatcher
)

Parameters
onBackInvokedDispatcher: OnBackInvokedDispatcher	the OnBackInvokedDispatcher to use.