Builder

class Builder(itinerary: Itinerary)

Important: This is a Public Preview API. It may be changed or removed at any time.

Constructors

Link copied to clipboard
fun Builder(itinerary: Itinerary)

Functions

Link copied to clipboard
fun allowVignettes(allowVignettes: List<String>): RoutingOptions.Builder

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

Link copied to clipboard
fun alternativeType(alternativeType: AlternativeType): RoutingOptions.Builder

When maxAlternatives is greater than 0, allows to specify the objective of computing alternative routes: finding routes that are significantly different than the reference route, or finding routes that are better than the reference route.

Link copied to clipboard
fun arriveAt(arriveAt: Date): RoutingOptions.Builder

Specifies the desired arrival time for the route to calculate in RFC 3339 format with an optional time zone offset. Example:

Link copied to clipboard
fun avoidAreas(areas: List<GeoBoundingBox>): RoutingOptions.Builder

Specifies areas which will be avoided.

Link copied to clipboard
fun avoidType(avoidTypes: List<AvoidType>): RoutingOptions.Builder

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

Link copied to clipboard
fun avoidVignettes(avoidVignettes: List<String>): RoutingOptions.Builder

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

Link copied to clipboard
fun build(): RoutingOptions

Construct a new RoutingOptions.

Link copied to clipboard
fun combustionVehicleDescriptor(combustionVehicleDescriptor: CombustionVehicleDescriptor): RoutingOptions.Builder

Specifies parameters for a combustion vehicle.

Link copied to clipboard
fun considerTraffic(considerTraffic: Boolean): RoutingOptions.Builder

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

Link copied to clipboard
fun departAt(departAt: Date): RoutingOptions.Builder

Specifies the departure time in RFC 3339 format with an optional time zone offset. Example:

Link copied to clipboard
fun electricVehicleDescriptor(electricVehicleDescriptor: ElectricVehicleDescriptor): RoutingOptions.Builder

Specifies parameters for an electric vehicle.

Link copied to clipboard
fun extras(extras: Any): RoutingOptions.Builder

Specifies Any which can be used to provide additional data to a custom implementation of RoutingApi.

Link copied to clipboard
fun hilliness(hilliness: Hilliness): RoutingOptions.Builder

Specifies the hilliness type for route calculation.

Link copied to clipboard
fun includeExtendedRouteRepresentation(includeExtendedRouteRepresentation: Boolean): RoutingOptions.Builder

Specifies the extended route representation for the route calculation.

Link copied to clipboard
fun instructionAnnouncementPoints(instructionAnnouncementPoints: AnnouncementPoints): RoutingOptions.Builder

Specifies whether to include announcement points in instructions. If specified, the instruction will include up to three additional fine-grained announcement points, each with its own location, maneuver type, and distance to the instruction point.

Link copied to clipboard
fun instructionPhonetics(instructionPhonetics: InstructionPhoneticsType): RoutingOptions.Builder

Specifies whether to include the phonetic transcription of street names, signpost text, and road numbers in the instructions in the response.

Link copied to clipboard
fun instructionRoadShieldReferences(instructionRoadShieldReferences: RoadShieldReferences): RoutingOptions.Builder

Specifies whether to include road shield references into the external road shields atlas.

Link copied to clipboard
fun instructionType(instructionType: InstructionType): RoutingOptions.Builder

Specifies the instruction type for the route calculation.

Link copied to clipboard
fun language(language: Locale): RoutingOptions.Builder

Specifies the language used for route calculation.

Link copied to clipboard
fun maxAlternatives(maxAlternatives: Int): RoutingOptions.Builder

Specifies the maximum number of route alternatives to be calculated by the service.

Link copied to clipboard
fun minDeviationDistance(minDeviationDistance: Int): RoutingOptions.Builder

All alternative routes returned will follow the reference route from the origin point of the calculateRoute Request for at least this number of meters. This can only be used when reconstructing a route. The minDeviationDistance parameter cannot be used in conjunction with arriveAt.

Link copied to clipboard
fun minDeviationTime(minDeviationTime: Int): RoutingOptions.Builder

All alternative routes returned will follow the reference route from the origin point of the calculateRoute Request for at least this number of seconds. This can only be used when reconstructing a route. The minDeviationTime parameter cannot be used in conjunction with arriveAt.

Link copied to clipboard
fun reportType(reportType: ReportType): RoutingOptions.Builder

Specifies if the report should be provided in the RoutingResult.

Link copied to clipboard
fun routeRepresentation(routeRepresentation: RouteRepresentation): RoutingOptions.Builder

Specifies the route representation for the route calculation.

Link copied to clipboard
fun routeType(routeType: RouteType): RoutingOptions.Builder

Specifies the type of route requested.

Link copied to clipboard
fun sectionTypes(sectionTypes: List<SectionType>): RoutingOptions.Builder

Specifies which of the section types is reported in the result. It can be called multiple times.

Link copied to clipboard
fun supportingPoints(supportingPoints: List<List<GeoCoordinate>>): RoutingOptions.Builder

A list of base route points to be used as input for route reconstruction.

Link copied to clipboard
fun trackingId(trackingId: String): RoutingOptions.Builder

Specifies an identifier for the request. The value should be unique for each request. The value must match the regular expression '^a-zA-Z0-9-{1,100}$'. If specified, the same value is sent back in the similar-named response header. Otherwise, a generated value may be sent back.

Link copied to clipboard
fun trafficInformation(trafficInformation: TrafficInformation): RoutingOptions.Builder

Specifies whether to return additional travel times using different types of traffic information (none, historic, live) as well as the default best-estimate travel time.

Link copied to clipboard
fun travelMode(travelMode: TravelMode): RoutingOptions.Builder

Specifies the mode of travel for the requested route.

Link copied to clipboard
fun vehicleHeading(vehicleHeading: Int): RoutingOptions.Builder

Specifies the vehicle heading for route calculation.

Link copied to clipboard
fun windingness(windingness: Windingness): RoutingOptions.Builder

Specifies the windingness type for route calculation.