TestNavigationEventCallback

Artifact: androidx.navigationevent:navigationevent-testing

View Source

Added in 1.0.0-alpha05

---

Kotlin |Java

Common/All

• Cmn

  class TestNavigationEventCallback : NavigationEventCallback

kotlin.Any
↳	androidx.navigationevent.NavigationEventCallback
	↳	androidx.navigationevent.testing.TestNavigationEventCallback

---

A test implementation of NavigationEventCallback that records received events and invocation counts.

This class is primarily used in tests to verify that specific navigation event callbacks are triggered as expected. It captures the NavigationEvent objects and counts how many times each callback is fired.

Summary

Public constructors
TestNavigationEventCallback(     isEnabled: Boolean,     isPassThrough: Boolean,     onEventStarted: TestNavigationEventCallback.(event: NavigationEvent) -> Unit,     onEventProgressed: TestNavigationEventCallback.(event: NavigationEvent) -> Unit,     onEventCancelled: TestNavigationEventCallback.() -> Unit,     onEventCompleted: TestNavigationEventCallback.() -> Unit )	Cmn

Public functions
open Unit	onEventCancelled() Callback for handling NavigationEventDispatcher.dispatchOnCancelled.	Cmn
open Unit	onEventCompleted() Callback for handling NavigationEventDispatcher.dispatchOnCompleted.	Cmn
open Unit	onEventProgressed(event: NavigationEvent) Callback for handling NavigationEventDispatcher.dispatchOnProgressed.	Cmn
open Unit	onEventStarted(event: NavigationEvent) Callback for handling NavigationEventDispatcher.dispatchOnStarted.	Cmn

Public properties
Int	cancelledInvocations The number of times cancelledInvocations has been invoked.	Cmn
Int	completedInvocations The number of times completedInvocations has been invoked.	Cmn
List<NavigationEvent>	progressedEvents A List of all events received by the onEventProgressed callback.	Cmn
Int	progressedInvocations The number of times progressedInvocations has been invoked.	Cmn
List<NavigationEvent>	startedEvents A List of all events received by the onEventStarted callback.	Cmn
Int	startedInvocations The number of times onEventStarted has been invoked.	Cmn

Inherited functions
From androidx.navigationevent.NavigationEventCallback Unit remove() Cmn

Inherited properties
From androidx.navigationevent.NavigationEventCallback Boolean isEnabled Controls whether this callback is active and should be considered for event dispatching. Cmn Boolean isPassThrough Whether this callback should consume the events from NavigationEventDispatcher or allow it to continue. Cmn

Public constructors

TestNavigationEventCallback

Cmn

Added in 1.0.0-alpha05

TestNavigationEventCallback(
    isEnabled: Boolean = true,
    isPassThrough: Boolean = false,
    onEventStarted: TestNavigationEventCallback.(event: NavigationEvent) -> Unit = {},
    onEventProgressed: TestNavigationEventCallback.(event: NavigationEvent) -> Unit = {},
    onEventCancelled: TestNavigationEventCallback.() -> Unit = {},
    onEventCompleted: TestNavigationEventCallback.() -> Unit = {}
)

Parameters
isEnabled: Boolean = true	Determines if the callback should process events. Defaults to true.
isPassThrough: Boolean = false	If true, events are passed to the next callback in the chain. Defaults to false.
onEventStarted: TestNavigationEventCallback.(event: NavigationEvent) -> Unit = {}	An optional lambda to execute when onEventStarted is called.
onEventProgressed: TestNavigationEventCallback.(event: NavigationEvent) -> Unit = {}	An optional lambda to execute when onEventProgressed is called.
onEventCancelled: TestNavigationEventCallback.() -> Unit = {}	An optional lambda to execute when onEventCancelled is called.
onEventCompleted: TestNavigationEventCallback.() -> Unit = {}	An optional lambda to execute when onEventCompleted is called.

Public functions

onEventCancelled

Cmn

open fun onEventCancelled(): Unit

Callback for handling NavigationEventDispatcher.dispatchOnCancelled.

onEventCompleted

Cmn

open fun onEventCompleted(): Unit

Callback for handling NavigationEventDispatcher.dispatchOnCompleted.

onEventProgressed

Cmn

open fun onEventProgressed(event: NavigationEvent): Unit

Callback for handling NavigationEventDispatcher.dispatchOnProgressed.

onEventStarted

Cmn

open fun onEventStarted(event: NavigationEvent): Unit

Callback for handling NavigationEventDispatcher.dispatchOnStarted.

Public properties

cancelledInvocations

Cmn

Added in 1.0.0-alpha05

val cancelledInvocations: Int

The number of times cancelledInvocations has been invoked.

completedInvocations

Cmn

Added in 1.0.0-alpha05

val completedInvocations: Int

The number of times completedInvocations has been invoked.

progressedEvents

Cmn

Added in 1.0.0-alpha05

val progressedEvents: List<NavigationEvent>

A List of all events received by the onEventProgressed callback.

progressedInvocations

Cmn

Added in 1.0.0-alpha05

val progressedInvocations: Int

The number of times progressedInvocations has been invoked.

startedEvents

Cmn

Added in 1.0.0-alpha05

val startedEvents: List<NavigationEvent>

A List of all events received by the onEventStarted callback.

startedInvocations

Cmn

Added in 1.0.0-alpha05

val startedInvocations: Int

The number of times onEventStarted has been invoked.