NavigationEventCallback

Kotlin |Java

Call for handling NavigationEventDispatcher callbacks.

This class maintains its own isEnabled state and will only receive callbacks when enabled.

See also
`NavigationEventDispatcher`

Summary

Public constructors
`NavigationEventCallback( isEnabled: Boolean, priority: NavigationEventPriority )`	Cmn

Public functions
`open Unit`	`onEventCancelled()` Callback for handling the `NavigationEventDispatcher.dispatchOnCancelled` callback.	Cmn
`open Unit`	`onEventCompleted()` Callback for handling the `NavigationEventDispatcher.dispatchOnCompleted` callback.	Cmn
`open Unit`	`onEventProgressed(event: NavigationEvent)` Callback for handling the `NavigationEventDispatcher.dispatchOnProgressed` callback.	Cmn
`open Unit`	`onEventStarted(event: NavigationEvent)` Callback for handling the `NavigationEventDispatcher.dispatchOnStarted` callback.	Cmn
`Unit`	`remove()` Cleans up all tracked `AutoCloseable` resources associated with this `NavigationEventCallback`.	Cmn

Public properties
`Boolean`	`isEnabled`	Cmn
`Boolean`	`isPassThrough` Whether this callback should consume the callback from the `NavigationEventDispatcher` or allow it to continue.	Cmn
`NavigationEventPriority`	`priority` The priority of this callback.	Cmn

Cmn

NavigationEventCallback(
    isEnabled: Boolean,
    priority: NavigationEventPriority = NavigationEventPriority.Default
)

Parameters
`isEnabled: Boolean`	The default enabled state for this callback.
`priority: NavigationEventPriority = NavigationEventPriority.Default`	The priority this callback should be registered with.

Cmn

open fun onEventCancelled(): Unit

Cmn

open fun onEventCompleted(): Unit

Cmn

open fun onEventProgressed(event: NavigationEvent): Unit

Cmn

open fun onEventStarted(event: NavigationEvent): Unit

Cmn

fun remove(): Unit

Cleans up all tracked AutoCloseable resources associated with this NavigationEventCallback.

This method calls AutoCloseable.close on each tracked resource, ensuring that no lingering event registrations or resources remain active.

Cmn

var isEnabled: Boolean

Cmn

var isPassThrough: Boolean

Whether this callback should consume the callback from the NavigationEventDispatcher or allow it to continue.

Cmn

val priority: NavigationEventPriority

The priority of this callback.