Builder

class Builder(route: DirectionsRoute)

Builder for RouteProgress

Parameters

route

DirectionsRoute currently is used for the navigation session

Constructors

Builder
Link copied to clipboard
fun Builder(route: DirectionsRoute)
DirectionsRoute currently is used for the navigation session

Functions

bannerInstructions
Link copied to clipboard
fun bannerInstructions(bannerInstructions: BannerInstructions?): RouteProgress.Builder
Current banner instruction.
build
Link copied to clipboard
fun build(): RouteProgress
Build new instance of RouteProgress
currentLegProgress
Link copied to clipboard
fun currentLegProgress(legProgress: RouteLegProgress?): RouteProgress.Builder
RouteLegProgress object with information about the particular leg the user is currently on.
currentState
Link copied to clipboard
fun currentState(currentState: RouteProgressState): RouteProgress.Builder
The current state of progress along the route.
distanceRemaining
Link copied to clipboard
fun distanceRemaining(distanceRemaining: Float): RouteProgress.Builder
The distance remaining in meters until the user reaches the end of the route.
distanceTraveled
Link copied to clipboard
fun distanceTraveled(distanceTraveled: Float): RouteProgress.Builder
Total distance traveled in meters along the route.
durationRemaining
Link copied to clipboard
fun durationRemaining(durationRemaining: Double): RouteProgress.Builder
The duration remaining in seconds until the user reaches the end of the route
equals
Link copied to clipboard
open operator fun equals(other: Any?): Boolean
fractionTraveled
Link copied to clipboard
fun fractionTraveled(fractionTraveled: Float): RouteProgress.Builder
The fraction traveled along the current route.
hashCode
Link copied to clipboard
open fun hashCode(): Int
inTunnel
Link copied to clipboard
fun inTunnel(inTunnel: Boolean): RouteProgress.Builder
true if in a tunnel, false otherwise
remainingWaypoints
Link copied to clipboard
fun remainingWaypoints(remainingWaypoints: Int): RouteProgress.Builder
Number of waypoints remaining on the current route
routeGeometryWithBuffer
Link copied to clipboard
fun routeGeometryWithBuffer(routeGeometryWithBuffer: Geometry?): RouteProgress.Builder
Current DirectionsRoute geometry with a buffer that encompasses visible tile surface are while navigating.
toString
Link copied to clipboard
open fun toString(): String
upcomingRouteAlerts
Link copied to clipboard
fun upcomingRouteAlerts(upcomingRouteAlerts: List<UpcomingRouteAlert>): RouteProgress.Builder
List of upcoming route alerts with distances from current location to each of them.
upcomingStepPoints
Link copied to clipboard
fun upcomingStepPoints(upcomingStepPoints: List<Point>?): RouteProgress.Builder
The list of points that represent the upcoming step geometry.
voiceInstructions
Link copied to clipboard
fun voiceInstructions(voiceInstructions: VoiceInstructions?): RouteProgress.Builder
Current voice instruction.