nunav-sdk-android/net.graphmasters.nunavsdk

Package-level declarations

Types

data class ArrivalTimeSlot(val start: Instant, val end: Instant? = null)

Describes when the driver is expected to arrive at the destination. Use start alone for an exact target time, or start together with end for a time window.

CountryConfiguration

sealed class CountryConfiguration

Configure the navigation to stay in or outside certain countries.

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.

NunavSdk

object NunavSdk

The main class to interact with the Nunav Navigation SDK. This class is used for configuring the SDK and starting navigation sessions.

OnNavigationFinishedListener

interface OnNavigationFinishedListener

A listener that triggers when a navigation is finished by reaching the destination.

OnStopReachedListener

interface OnStopReachedListener

A listener that triggers when an intermediate stop of a multi-stop navigation is reached. The final destination triggers OnNavigationFinishedListener instead.

RoutingConfiguration

data class RoutingConfiguration(val contextToken: String? = null, val transportMode: TransportMode = TransportMode.Car(), val avoidTollRoad: Boolean = false, val countryConfiguration: CountryConfiguration? = null)

The RoutingConfiguration struct is used to configure a routing session. It defines different factors that influence resulting routes.

SetDestinationsError

enum SetDestinationsError : Enum<SetDestinationsError>

Describes why a NunavSdk.startNavigation or NunavSdk.setDestinations call could not be fulfilled. When the call succeeds null is returned instead.

TransportMode

sealed class TransportMode

Defines different modes of transport for navigation, each with its own constraints and routing rules. These modes influence route calculation, taking into account road access, speed limits, and restrictions of the specified transport mode.