NavigationEventInput

Kotlin |Java

public abstract class NavigationEventInput

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()`

Protected methods
`final void`	`@MainThread dispatchOnCancelled()` Call `dispatchOnCancelled` on the connected dispatcher.
`final void`	`@MainThread dispatchOnCompleted()` Call `dispatchOnCompleted` on the connected dispatcher.
`final void`	`@MainThread dispatchOnProgressed(@NonNull NavigationEvent event)` Call `dispatchOnProgressed` on the connected dispatcher.
`final void`	`@MainThread dispatchOnStarted(@NonNull NavigationEvent event)` Call `dispatchOnStarted` on the connected dispatcher.
`void`	`@MainThread @EmptySuper onAdded(@NonNull NavigationEventDispatcher dispatcher)` Called after this `NavigationEventInput` is added to `dispatcher`.
`void`	`@MainThread @EmptySuper onHasEnabledCallbacksChanged(boolean hasEnabledCallbacks)` Callback that will be notified when the connected dispatcher's `hasEnabledCallbacks` changes.
`void`	`@MainThread @EmptySuper onRemoved()` Called after this `NavigationEventInput` is removed from a `NavigationEventDispatcher`.

public NavigationEventInput()

@MainThread
protected final void dispatchOnCancelled()

Call dispatchOnCancelled on the connected dispatcher.

@MainThread
protected final void dispatchOnCompleted()

Call dispatchOnCompleted on the connected dispatcher.

@MainThread
protected final void dispatchOnProgressed(@NonNull NavigationEvent event)

Call dispatchOnProgressed on the connected dispatcher.

Parameters
`@NonNull NavigationEvent event`	The event to dispatch.

@MainThread
protected final void dispatchOnStarted(@NonNull NavigationEvent event)

Call dispatchOnStarted on the connected dispatcher.

Parameters
`@NonNull NavigationEvent event`	The event to dispatch.

@MainThread
@EmptySuper
protected void onAdded(@NonNull NavigationEventDispatcher dispatcher)

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
`@NonNull NavigationEventDispatcher dispatcher`	The `NavigationEventDispatcher` that this input is now added to.

@MainThread
@EmptySuper
protected void onHasEnabledCallbacksChanged(boolean hasEnabledCallbacks)

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

Parameters
`boolean hasEnabledCallbacks`	Whether the connected dispatcher has any enabled callbacks.

@MainThread
@EmptySuper
protected void onRemoved()