DirectNavigationEventInput

Artifact: androidx.navigationevent:navigationevent

Kotlin |Java

Cmn

class DirectNavigationEventInput : NavigationEventInput

kotlin.Any
↳	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()`	Cmn

Public functions
`Unit`	`@MainThread backCancelled()` Dispatch a back cancelled event with the connected dispatcher.	Cmn
`Unit`	`@MainThread backCompleted()` Dispatch a back completed event with the connected dispatcher.	Cmn
`Unit`	`@MainThread backProgressed(event: NavigationEvent)` Dispatch a back progressed event with the connected dispatcher.	Cmn
`Unit`	`@MainThread backStarted(event: NavigationEvent)` Dispatch a back started event with the connected dispatcher.	Cmn
`Unit`	`@MainThread forwardCancelled()` Dispatch a forward cancelled event with the connected dispatcher.	Cmn
`Unit`	`@MainThread forwardCompleted()` Dispatch a forward completed event with the connected dispatcher.	Cmn
`Unit`	`@MainThread forwardProgressed(event: NavigationEvent)` Dispatch a forward progressed event with the connected dispatcher.	Cmn
`Unit`	`@MainThread forwardStarted(event: NavigationEvent)` Dispatch a forward started event with the connected dispatcher.	Cmn

Inherited functions

From androidx.navigationevent.NavigationEventInput

`Unit`	`@MainThread dispatchOnBackCancelled()` Notifies the dispatcher that the ongoing `TRANSITIONING_BACK` navigation gesture has been cancelled.	Cmn
`Unit`	`@MainThread dispatchOnBackCompleted()` Notifies the dispatcher that the ongoing `TRANSITIONING_BACK` navigation gesture has completed.	Cmn
`Unit`	`@MainThread dispatchOnBackProgressed(event: NavigationEvent)` Notifies the dispatcher that an ongoing `TRANSITIONING_BACK` navigation gesture has progressed.	Cmn
`Unit`	`@MainThread dispatchOnBackStarted(event: NavigationEvent)` Notifies the dispatcher that a `TRANSITIONING_BACK` navigation gesture has started.	Cmn
`Unit`	`@MainThread dispatchOnForwardCancelled()` Notifies the dispatcher that the ongoing `TRANSITIONING_FORWARD` navigation gesture has been cancelled.	Cmn
`Unit`	`@MainThread dispatchOnForwardCompleted()` Notifies the dispatcher that the ongoing `TRANSITIONING_FORWARD` navigation gesture has completed.	Cmn
`Unit`	`@MainThread dispatchOnForwardProgressed(event: NavigationEvent)` Notifies the dispatcher that an ongoing `TRANSITIONING_FORWARD` navigation gesture has progressed.	Cmn
`Unit`	`@MainThread dispatchOnForwardStarted(event: NavigationEvent)` Notifies the dispatcher that a `TRANSITIONING_FORWARD` navigation gesture has started.	Cmn
`open Unit`	`@MainThread @EmptySuper onAdded(dispatcher: NavigationEventDispatcher)` Called after this `NavigationEventInput` is added to `dispatcher`.	Cmn
`open Unit`	`@MainThread @EmptySuper onHasEnabledHandlersChanged(hasEnabledHandlers: Boolean)` Called when the enabled state of handlers in the connected `NavigationEventDispatcher` changes.	Cmn
`open Unit`	`@MainThread @EmptySuper onHistoryChanged(history: NavigationEventHistory)` Called when the `NavigationEventHistory` state in the connected `NavigationEventDispatcher` changes.	Cmn
`open Unit`	`@MainThread @EmptySuper onRemoved()` Called after this `NavigationEventInput` is removed from a `NavigationEventDispatcher`.	Cmn

Public constructors

DirectNavigationEventInput

Cmn

Added in 1.0.0-alpha09

DirectNavigationEventInput()

Public functions

backCancelled

Cmn

Added in 1.0.0-alpha09

@MainThread
fun backCancelled(): Unit

Dispatch a back cancelled event with the connected dispatcher.

backCompleted

Cmn

Added in 1.0.0-alpha09

@MainThread
fun backCompleted(): Unit

Dispatch a back completed event with the connected dispatcher.

backProgressed

Cmn

Added in 1.0.0-alpha09

@MainThread
fun backProgressed(event: NavigationEvent): Unit

Dispatch a back progressed event with the connected dispatcher.

Parameters
`event: NavigationEvent`	The `NavigationEvent` to dispatch.

backStarted

Cmn

Added in 1.0.0-alpha09

@MainThread
fun backStarted(event: NavigationEvent): Unit

Dispatch a back started event with the connected dispatcher.

Parameters
`event: NavigationEvent`	The `NavigationEvent` to dispatch.

forwardCancelled

Cmn

Added in 1.0.0-alpha09

@MainThread
fun forwardCancelled(): Unit

Dispatch a forward cancelled event with the connected dispatcher.

forwardCompleted

Cmn

Added in 1.0.0-alpha09

@MainThread
fun forwardCompleted(): Unit

Dispatch a forward completed event with the connected dispatcher.

forwardProgressed

Cmn

Added in 1.0.0-alpha09

@MainThread
fun forwardProgressed(event: NavigationEvent): Unit

Dispatch a forward progressed event with the connected dispatcher.

Parameters
`event: NavigationEvent`	The `NavigationEvent` to dispatch.

forwardStarted

Cmn

Added in 1.0.0-alpha09

@MainThread
fun forwardStarted(event: NavigationEvent): Unit

Dispatch a forward started event with the connected dispatcher.

Parameters
`event: NavigationEvent`	The `NavigationEvent` to dispatch.