DirectNavigationEventInput

Artifact: androidx.navigationevent:navigationevent

Kotlin |Java

public final class DirectNavigationEventInput extends NavigationEventInput

java.lang.Object
↳	androidx.navigationevent.NavigationEventInput
	↳	androidx.navigationevent.DirectNavigationEventInput

An input that can send events to a NavigationEventDispatcher. Instead of subclassing NavigationEventInput, users can create instances of this class and use it directly.

Summary

Public constructors
`DirectNavigationEventInput()`

Public methods
`final void`	`@MainThread backCancelled()` Dispatch a back cancelled event with the connected dispatcher.
`final void`	`@MainThread backCompleted()` Dispatch a back completed event with the connected dispatcher.
`final void`	`@MainThread backProgressed(@NonNull NavigationEvent event)` Dispatch a back progressed event with the connected dispatcher.
`final void`	`@MainThread backStarted(@NonNull NavigationEvent event)` Dispatch a back started event with the connected dispatcher.
`final void`	`@MainThread forwardCancelled()` Dispatch a forward cancelled event with the connected dispatcher.
`final void`	`@MainThread forwardCompleted()` Dispatch a forward completed event with the connected dispatcher.
`final void`	`@MainThread forwardProgressed(@NonNull NavigationEvent event)` Dispatch a forward progressed event with the connected dispatcher.
`final void`	`@MainThread forwardStarted(@NonNull NavigationEvent event)` Dispatch a forward started event with the connected dispatcher.

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 onHasEnabledHandlersChanged(boolean hasEnabledHandlers)` Called when the enabled state of handlers in the connected `NavigationEventDispatcher` changes.
`void`	`@MainThread @EmptySuper onHistoryChanged(@NonNull NavigationEventHistory history)` Called when the `NavigationEventHistory` state in the connected `NavigationEventDispatcher` changes.
`void`	`@MainThread @EmptySuper onRemoved()` Called after this `NavigationEventInput` is removed from a `NavigationEventDispatcher`.

Public constructors

DirectNavigationEventInput

Added in 1.0.0-alpha09

public DirectNavigationEventInput()

Public methods

backCancelled

Added in 1.0.0-alpha09

@MainThread
public final void backCancelled()

Dispatch a back cancelled event with the connected dispatcher.

backCompleted

Added in 1.0.0-alpha09

@MainThread
public final void backCompleted()

Dispatch a back completed event with the connected dispatcher.

backProgressed

Added in 1.0.0-alpha09

@MainThread
public final void backProgressed(@NonNull NavigationEvent event)

Dispatch a back progressed event with the connected dispatcher.

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

backStarted

Added in 1.0.0-alpha09

@MainThread
public final void backStarted(@NonNull NavigationEvent event)

Dispatch a back started event with the connected dispatcher.

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

forwardCancelled

Added in 1.0.0-alpha09

@MainThread
public final void forwardCancelled()

Dispatch a forward cancelled event with the connected dispatcher.

forwardCompleted

Added in 1.0.0-alpha09

@MainThread
public final void forwardCompleted()

Dispatch a forward completed event with the connected dispatcher.

forwardProgressed

Added in 1.0.0-alpha09

@MainThread
public final void forwardProgressed(@NonNull NavigationEvent event)

Dispatch a forward progressed event with the connected dispatcher.

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

forwardStarted

Added in 1.0.0-alpha09

@MainThread
public final void forwardStarted(@NonNull NavigationEvent event)

Dispatch a forward started event with the connected dispatcher.

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