Provides input from OnBackInvokedCallback to the given NavigationEventDispatcher.

Summary

Public constructors

OnBackInvokedInput(onBackInvokedDispatcher: OnBackInvokedDispatcher)
android

Protected functions

open Unit

Called after this NavigationEventInput is added to dispatcher.

android
open Unit
onHasEnabledCallbacksChanged(hasEnabledCallbacks: Boolean)

Callback that will be notified when the connected dispatcher's hasEnabledCallbacks changes.

android
open Unit

Called after this NavigationEventInput is removed from a NavigationEventDispatcher.

android

Inherited functions

From androidx.navigationevent.NavigationEventInput
Unit

Call dispatchOnCancelled on the connected dispatcher.

android
Unit

Call dispatchOnCompleted on the connected dispatcher.

android
Unit

Call dispatchOnProgressed on the connected dispatcher.

android
Unit

Call dispatchOnStarted on the connected dispatcher.

android

Public constructors

OnBackInvokedInput

OnBackInvokedInput(onBackInvokedDispatcher: OnBackInvokedDispatcher)

Protected functions

onAdded

protected open fun onAdded(dispatcher: NavigationEventDispatcher): Unit

Called after this NavigationEventInput is added to dispatcher. This can happen when calling NavigationEventDispatcher.addInput. A NavigationEventInput can only be added to one NavigationEventDispatcher at a time.

Parameters
dispatcher: NavigationEventDispatcher

The NavigationEventDispatcher that this input is now added to.

onHasEnabledCallbacksChanged

protected open fun onHasEnabledCallbacksChanged(hasEnabledCallbacks: Boolean): Unit

Callback that will be notified when the connected dispatcher's hasEnabledCallbacks changes.

Parameters
hasEnabledCallbacks: Boolean

Whether the connected dispatcher has any enabled callbacks.

onRemoved

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.