sdk-routing / com.tomtom.online.sdk.routing.route / RouteDescriptor / Builder

Builder

@PublicPreview("2021.06") class Builder

Builder used to create an instance of RouteDescriptor. Once constructed, the user cannot change the field values.

Constructors

<init>

Builder()

Builder used to create an instance of RouteDescriptor. Once constructed, the user cannot change the field values.

Functions

avoidType

fun avoidType(avoidType: List<AvoidType>): RouteDescriptor.Builder

Specifies something that the route calculation should try to avoid when determining the route.

build

fun build(): RouteDescriptor

Returns a new instance of RouteDescriptor.

considerTraffic

fun considerTraffic(considerTraffic: Boolean): RouteDescriptor.Builder

Specifies whether the traffic information will be considered. The default value is true.

departAt

fun departAt(departAt: Date): RouteDescriptor.Builder

Specifies the departure time.

hilliness

fun hilliness(hilliness: Hilliness): RouteDescriptor.Builder

Specifies the hilliness type for route calculation.

routeType

fun routeType(routeType: RouteType): RouteDescriptor.Builder

Specifies the type of route requested.

travelMode

fun travelMode(travelMode: TravelMode): RouteDescriptor.Builder

Specifies the mode of travel for the requested route.

windingness

fun windingness(windingness: Windingness): RouteDescriptor.Builder

Specifies the windingness type for route calculation.