nunav-sdk-android/net.graphmasters.nunavsdk/DestinationConfiguration

DestinationConfiguration

data class DestinationConfiguration(val latitude: Double, val longitude: Double, val label: String? = null, val id: String? = null, val arrivalHeading: Double? = null, val arrivalTimeSlot: ArrivalTimeSlot? = null, val avoidTollRoad: Boolean? = null, val countryConfiguration: CountryConfiguration? = null, val contextToken: String? = null)

Configures the destination of the requested navigation. The latitude and longitude are mandatory because they are used to determine the geographical location of the destination.

Constructors

constructor(latitude: Double, longitude: Double, label: String? = null, id: String? = null, arrivalHeading: Double? = null, arrivalTimeSlot: ArrivalTimeSlot? = null, avoidTollRoad: Boolean? = null, countryConfiguration: CountryConfiguration? = null, contextToken: String? = null)

Properties

arrivalHeading

val arrivalHeading: Double? = null

The heading from which the user is supposed to get to the destination.

arrivalTimeSlot

val arrivalTimeSlot: ArrivalTimeSlot? = null

The time slot the driver is expected to arrive in at the destination. Shown as a badge on the maneuver card. Provide ArrivalTimeSlot.start alone for an exact target time, or both ArrivalTimeSlot.start and ArrivalTimeSlot.end for a window. The timestamps are displayed as-is.

avoidTollRoad

val avoidTollRoad: Boolean? = null

If true only toll-free roads will be considered when routing to this destination. When null the trip-wide RoutingConfiguration.avoidTollRoad value is used as a fallback.

contextToken

val contextToken: String? = null

The context token used to provide additional information to the routing service for this specific destination. This can guide users individually to their destination, e.g. to a specific parking spot. When null the trip-wide RoutingConfiguration.contextToken value is used as a fallback.

countryConfiguration

val countryConfiguration: CountryConfiguration? = null

The country configuration used when routing to this destination. When null the trip-wide RoutingConfiguration.countryConfiguration value is used as a fallback.

val id: String? = null

An optional identifier for the destination. If this is an identifier known by the backend, special routing configurations can be provided by the service for specific destinations.

label

val label: String? = null

A display name for the destination. Will be displayed at the end of the navigation.

latitude

val latitude: Double

The latitude the navigation should end at.

longitude

val longitude: Double

The longitude the navigation should end at.