Builder

class Builder(route: DirectionsRoute)

Builder for RouteProgress

Parameters

route

DirectionsRoute currently is used for the navigation session

Constructors

Builder

fun Builder(route: DirectionsRoute)

DirectionsRoute currently is used for the navigation session

Functions

bannerInstructions

fun bannerInstructions(bannerInstructions: BannerInstructions?): RouteProgress.Builder

Current banner instruction.

build

fun build(): RouteProgress

Build new instance of RouteProgress

currentLegProgress

fun currentLegProgress(legProgress: RouteLegProgress?): RouteProgress.Builder

RouteLegProgress object with information about the particular leg the user is currently on.

currentState

fun currentState(currentState: RouteProgressState): RouteProgress.Builder

The current state of progress along the route.

distanceRemaining

fun distanceRemaining(distanceRemaining: Float): RouteProgress.Builder

The distance remaining in meters until the user reaches the end of the route.

distanceTraveled

fun distanceTraveled(distanceTraveled: Float): RouteProgress.Builder

Total distance traveled in meters along the route.

durationRemaining

fun durationRemaining(durationRemaining: Double): RouteProgress.Builder

The duration remaining in seconds until the user reaches the end of the route

equals

open operator fun equals(other: Any?): Boolean

fractionTraveled

fun fractionTraveled(fractionTraveled: Float): RouteProgress.Builder

The fraction traveled along the current route.

hashCode

open fun hashCode(): Int

inTunnel

fun inTunnel(inTunnel: Boolean): RouteProgress.Builder

true if in a tunnel, false otherwise

remainingWaypoints

fun remainingWaypoints(remainingWaypoints: Int): RouteProgress.Builder

Number of waypoints remaining on the current route

routeGeometryWithBuffer

fun routeGeometryWithBuffer(routeGeometryWithBuffer: Geometry?): RouteProgress.Builder

Current DirectionsRoute geometry with a buffer that encompasses visible tile surface are while navigating.

toString

open fun toString(): String

upcomingRouteAlerts

fun upcomingRouteAlerts(upcomingRouteAlerts: List<UpcomingRouteAlert>): RouteProgress.Builder

List of upcoming route alerts with distances from current location to each of them.

upcomingStepPoints

fun upcomingStepPoints(upcomingStepPoints: List<Point>?): RouteProgress.Builder

The list of points that represent the upcoming step geometry.

voiceInstructions

fun voiceInstructions(voiceInstructions: VoiceInstructions?): RouteProgress.Builder

Current voice instruction.