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

Builder

@Beta(2020, 12) 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

allowVignettes

fun allowVignettes(allowVignettes: List<String>): RouteDescriptor.Builder

Specifies countries in which all toll roads and vignettes will be allowed.

avoidAreas

fun avoidAreas(areaCoordinates: List<BoundingBox>): RouteDescriptor.Builder

Specifies areas which will be avoided.

avoidType

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

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

avoidVignettes

fun avoidVignettes(avoidVignettes: List<String>): RouteDescriptor.Builder

Specifies countries in which all toll roads and vignettes will be avoided.

build

fun build(): RouteDescriptor

Returns new instance of RouteDescriptor.

departAt

fun departAt(departAt: String): RouteDescriptor.Builder

Specifies the date and time of the departure from the origin point.

report

fun report(reportType: ReportType): RouteDescriptor.Builder

Specifies which data should be reported for diagnosis purposes.

routeRepresentation

fun routeRepresentation(routeRepresentation: RouteRepresentation): RouteDescriptor.Builder

Specifies the representation of the set of routes.

routeType

fun routeType(routeType: RouteType): RouteDescriptor.Builder

Specifies the type of route requested.

sectionType

fun sectionType(sectionType: SectionType): RouteDescriptor.Builder

Specifies which of the section types is reported.

traffic

fun traffic(traffic: Boolean): RouteDescriptor.Builder

Specifies whether the traffic information will be considered.

travelMode

fun travelMode(travelMode: TravelMode): RouteDescriptor.Builder

Specifies the mode of travel for the requested route.

vehicleHeading

fun vehicleHeading(vehicleHeading: Int): RouteDescriptor.Builder

Specifies the directional heading of the vehicle in degrees starting at true North and continuing in a clockwise direction.