RoutingStatus

data class RoutingStatus(val status: Status, val currentStep: Int)

Combines the current navigation Status with the index of the active route step.

This data class is emitted by the routing system to describe the user’s real-time position relative to an active route. Consumers use it to update navigation UI, trigger voice announcements, and detect when rerouting or arrival events occur.

See also

Constructors

Properties

currentStep

val currentStep: Int

Zero-based index of the route step the user is currently navigating. Increments as the user progresses through the route’s turn-by-turn instructions.

status

val status: Status

Types: Status

The current navigation state indicating the user’s relationship to the route.

Functions

toJSObject

fun RoutingStatus.toJSObject(): JSObject