NavigationEventInput

Kotlin |Java

Known direct subclasses

`DirectNavigationEventInput`	An input that can send events to a `NavigationEventDispatcher`.
`OnBackInvokedInput`	Provides input from OnBackInvokedCallback to the given `NavigationEventDispatcher`.

A class that can send events to a NavigationEventDispatcher.

Summary

Public constructors
`NavigationEventInput()`	Cmn

Protected functions
`Unit`	`@MainThread dispatchOnCancelled()` Call `dispatchOnCancelled` on the connected dispatcher.	Cmn
`Unit`	`@MainThread dispatchOnCompleted()` Call `dispatchOnCompleted` on the connected dispatcher.	Cmn
`Unit`	`@MainThread dispatchOnProgressed(event: NavigationEvent)` Call `dispatchOnProgressed` on the connected dispatcher.	Cmn
`Unit`	`@MainThread dispatchOnStarted(event: NavigationEvent)` Call `dispatchOnStarted` on the connected dispatcher.	Cmn
`open Unit`	`@MainThread @EmptySuper onAdded(dispatcher: NavigationEventDispatcher)` Called after this `NavigationEventInput` is added to `dispatcher`.	Cmn
`open Unit`	`@MainThread @EmptySuper onHasEnabledCallbacksChanged(hasEnabledCallbacks: Boolean)` Callback that will be notified when the connected dispatcher's `hasEnabledCallbacks` changes.	Cmn
`open Unit`	`@MainThread @EmptySuper onRemoved()` Called after this `NavigationEventInput` is removed from a `NavigationEventDispatcher`.	Cmn

Cmn

NavigationEventInput()

Cmn

@MainThread
protected fun dispatchOnCancelled(): Unit

Call dispatchOnCancelled on the connected dispatcher.

Cmn

@MainThread
protected fun dispatchOnCompleted(): Unit

Call dispatchOnCompleted on the connected dispatcher.

Cmn

@MainThread
protected fun dispatchOnProgressed(event: NavigationEvent): Unit

Call dispatchOnProgressed on the connected dispatcher.

Parameters
`event: NavigationEvent`	The event to dispatch.

Cmn

@MainThread
protected fun dispatchOnStarted(event: NavigationEvent): Unit

Call dispatchOnStarted on the connected dispatcher.

Parameters
`event: NavigationEvent`	The event to dispatch.

Cmn

@MainThread
@EmptySuper
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.

Cmn

@MainThread
@EmptySuper
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.

Cmn

@MainThread
@EmptySuper
protected open fun onRemoved(): Unit