Skip to Content

Status

enum Status : Enum<Status>

Represents the user’s navigation state relative to an active route.

The RoutingStatusRepository continuously evaluates the user’s position against the current route geometry and emits the appropriate status. This drives core navigation behaviors such as step progression, off-route detection, and arrival notification.

See also

RoutingStatus
RoutingStatusRepository

Entries

ON_ROUTEON_ROUTE
The user is following the route within the expected tolerance corridor.
OUT_OF_ROUTEOUT_OF_ROUTE
The user has deviated from the route beyond the tolerance threshold. Typically triggers a reroute request.
NO_ROUTENO_ROUTE
No route is currently active. The user is not in a navigation session.
FINISHEDFINISHED
The user has reached the destination and the navigation session is complete.

Properties

entries

val entries: EnumEntries<Status>

Returns a representation of an immutable list of all enum entries, in the order they’re declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): Status

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<Status>

Returns an array containing the constants of this enum type, in the order they’re declared.

Last updated on