NavigationEventCallback



Callback for handling NavigationEvents.

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

Summary

Public constructors

NavigationEventCallback(isEnabled: Boolean, isPassThrough: Boolean)
Cmn

Public properties

Boolean
Cmn
Boolean

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

Cmn

Public constructors

NavigationEventCallback(isEnabled: Boolean, isPassThrough: Boolean = false)
Parameters
isEnabled: Boolean

The enabled state for this callback.

isPassThrough: Boolean = false

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

Public functions

onEventCancelled

open fun onEventCancelled(): Unit

Callback for handling NavigationEventDispatcher.dispatchOnCancelled.

onEventCompleted

open fun onEventCompleted(): Unit

Callback for handling NavigationEventDispatcher.dispatchOnCompleted.

onEventProgressed

open fun onEventProgressed(event: NavigationEvent): Unit

Callback for handling NavigationEventDispatcher.dispatchOnProgressed.

onEventStarted

open fun onEventStarted(event: NavigationEvent): Unit

Callback for handling NavigationEventDispatcher.dispatchOnStarted.

remove

fun remove(): Unit

Public properties

isEnabled

var isEnabledBoolean

isPassThrough

val isPassThroughBoolean

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