PrivateBusOptions (API Reference)
Class PrivateBusOptions
All the options to specify how a private bus route should be calculated.
-
Field Summary
FieldsModifier and TypeFieldDescriptionDeprecated.The options explicitly allowed by user for route calculations.Deprecated.Options to specify restrictions for route calculations.Deprecated.Detailed bus specifications such as dimensions and weight.Deprecated.Specifies the last character of a vehicle's license plate, typically used to evaluate traffic restrictions in certain environmental or low-emission zones.Deprecated.Segments with restriction on maximum baseSpeed.intDeprecated.Specifies the number of occupants in the vehicle, including driver, can affect the vehicle's ability to use HOV/carpool restricted lanes.Deprecated.Specifies the common route calculation options.Deprecated.Customize textual content returned from the route calculation, such as localization, format, and unit system.Deprecated.Options to specify how the tolls should be calculated, such as transponders, vehicle category, and emission type. -
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
routeOptions
Deprecated.Specifies the common route calculation options.
-
textOptions
Deprecated.Customize textual content returned from the route calculation, such as localization, format, and unit system.
-
avoidanceOptions
Deprecated.Options to specify restrictions for route calculations. By default no restrictions are applied.
-
tollOptions
Deprecated.Options to specify how the tolls should be calculated, such as transponders, vehicle category, and emission type.
-
allowOptions
Deprecated.The options explicitly allowed by user for route calculations. By default no options are opt in.
-
occupantsNumber
public int occupantsNumberDeprecated.Specifies the number of occupants in the vehicle, including driver, can affect the vehicle's ability to use HOV/carpool restricted lanes. Shouldn't be less than 1 or greater than 255. Defaults to 1.
Note: This parameter has no effect unless HOV and/or HOT lane usage is enabled via
allowOptionsand such lanes are available in the selected country. -
lastCharacterOfLicensePlate
Deprecated.Specifies the last character of a vehicle's license plate, typically used to evaluate traffic restrictions in certain environmental or low-emission zones. In cities like Bogotá, Mexico City, or Jakarta, specific license plate digits may be restricted on certain days or in certain areas to reduce congestion and emissions. When this value is provided, the HERE SDK considers it during route calculation to avoid roads or areas where your vehicle may be restricted based on local regulations. Example usage: "7", when the license plate of a vehicle looks like "B-ET-182487".
If this value is not set, such license plate-based restrictions are ignored, and routing is performed without considering them.
-
maxSpeedOnSegments
Deprecated.Segments with restriction on maximum baseSpeed.
-
busSpecifications
Deprecated.Detailed bus specifications such as dimensions and weight.
Note: Some members of
bus_specificationshave limited value range.BusSpecifications.grossWeightInKilogramsmust not be negative.BusSpecifications.heightInCentimetersmust be in the range [0, 5000].BusSpecifications.widthInCentimetersmust be in the range [0, 5000].BusSpecifications.lengthInCentimetersmust be in the range [0, 30000]. The validation of the range is done in the method that takesPrivateBusOptionsas parameter.
-
-
Constructor Details
-
PrivateBusOptions
public PrivateBusOptions()Deprecated.Creates a new instance.
-
-
Method Details
Will be removed in v4.28.0. Use
RoutingOptionsclass instead.