Citymapper SDK/com.citymapper.sdk.navigation.progress/RouteProgress

RouteProgress

Constructors

fun RouteProgress(route: Route, legProgress: LegProgress?, isArrived: Boolean, navigationSessionId: String?, pathGeometrySegments: PathGeometrySegments)

Properties

distanceMetersRemaining

val distanceMetersRemaining: Double?

distanceRemaining

val distanceRemaining: Distance?

durationRemaining

val durationRemaining: Duration?

durationSecondsRemaining

val durationSecondsRemaining: Int?

isArrived

val isArrived: Boolean

If true, the route has been completed by the user. The SDK will provide no further guidance events.

isNavigating

val isNavigating: Boolean

true if this RouteProgress represent the state of the active navigation session.

legProgress

val legProgress: LegProgress?

Progress along the leg of the route that the user is currently on. May be null in cases where we do not yet have a confident prediction of the user's current location

navigationSessionId

val navigationSessionId: String?

An internal identifier representing the active navigation session (if this RouteProgress represents the state of the active navigation).

pathGeometrySegments

val pathGeometrySegments: PathGeometrySegments

The path geometry of the route broken down in to segments of the same travel mode and progress type (past or future) for easier rendering.

route

val route: Route

The entire route the user is currently travelling along