NavigationEventCallback

Kotlin |Java

public abstract class NavigationEventCallback

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( boolean isEnabled, @NonNull NavigationEventPriority priority )`

Public methods
`final @NonNull NavigationEventPriority`	`getPriority()` The priority of this callback.
`final boolean`	`isEnabled()`
`final boolean`	`isPassThrough()` Whether this callback should consume the callback from the `NavigationEventDispatcher` or allow it to continue.
`void`	`onEventCancelled()` Callback for handling the `NavigationEventDispatcher.dispatchOnCancelled` callback.
`void`	`onEventCompleted()` Callback for handling the `NavigationEventDispatcher.dispatchOnCompleted` callback.
`void`	`onEventProgressed(@NonNull NavigationEvent event)` Callback for handling the `NavigationEventDispatcher.dispatchOnProgressed` callback.
`void`	`onEventStarted(@NonNull NavigationEvent event)` Callback for handling the `NavigationEventDispatcher.dispatchOnStarted` callback.
`final void`	`remove()` Cleans up all tracked `AutoCloseable` resources associated with this `NavigationEventCallback`.
`final void`	`setEnabled(boolean isEnabled)`
`final void`	`setPassThrough(boolean isPassThrough)` Whether this callback should consume the callback from the `NavigationEventDispatcher` or allow it to continue.

public NavigationEventCallback(
    boolean isEnabled,
    @NonNull NavigationEventPriority priority
)

Parameters
`boolean isEnabled`	The default enabled state for this callback.
`@NonNull NavigationEventPriority priority`	The priority this callback should be registered with.

public final @NonNull NavigationEventPriority getPriority()

The priority of this callback.

public final boolean isEnabled()

public final boolean isPassThrough()

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

public void onEventCancelled()

public void onEventCompleted()

public void onEventProgressed(@NonNull NavigationEvent event)

public void onEventStarted(@NonNull NavigationEvent event)

public final void remove()

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.

public final void setEnabled(boolean isEnabled)

public final void setPassThrough(boolean isPassThrough)

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