navigation-ux-state/com.mapbox.dash.state/TripState

TripState

data class TripState(val waypoints: List<DestinationSearchResult> = emptyList(), val markers: List<Marker> = emptyList(), val routes: List<NavigationRoute> = emptyList(), val fasterRoutes: List<FasterRouteMetadata> = emptyList(), val routeWithChargers: NavigationRoute? = null, val currentLegIndex: Int = 0, savedState: TripState? = null)

Constructors

constructor(waypoints: List<DestinationSearchResult> = emptyList(), markers: List<Marker> = emptyList(), routes: List<NavigationRoute> = emptyList(), fasterRoutes: List<FasterRouteMetadata> = emptyList(), routeWithChargers: NavigationRoute? = null, currentLegIndex: Int = 0, savedState: TripState? = null)

Properties

canAddRegularWaypoint

val TripState.canAddRegularWaypoint: Boolean

canRemoveRegularWaypoint

val TripState.canRemoveRegularWaypoint: Boolean

currentLegIndex

val currentLegIndex: Int = 0

val fasterRoutes: List<FasterRouteMetadata>

val isFinalLeg: Boolean

val TripState.isNotEmpty: Boolean

val markers: List<Marker>

val route: NavigationRoute?

val routes: List<NavigationRoute>

routeWithChargers

val routeWithChargers: NavigationRoute? = null

val waypoints: List<DestinationSearchResult>

Functions

fun commit(): TripState

Applies changes from editing mode, if any, and cleans up saved state.

fun edit(): TripState

Saves current state and switches to editing mode. It's possible to switch to editing mode only once, all subsequent calls will be ignored.

getArrivalWaypoint

fun getArrivalWaypoint(state: State): DestinationSearchResult?

fun revert(): TripState

Drops current changes and switches back to the saved state.