NavigationOptions

class NavigationOptions

This value will be used to offset the time at which the current location was calculated in such a way as to project the location forward along the current trajectory so as to appear more in sync with the users ground-truth location

Parameters

applicationContext

the Context of the Android Application

locationEngine

the mechanism responsible for providing location approximations to navigation

locationEngineRequest

specifies the rate to request locations from the location engine.

timeFormatType

defines time format for calculation remaining trip time

navigatorPredictionMillis

defines approximate navigator prediction in milliseconds

distanceFormatterOptions

DistanceFormatterOptions options to format distances showing in notification during navigation

routingTilesOptions

RoutingTilesOptions defines routing tiles endpoint and storage configuration.

isFromNavigationUi

Boolean true if is called from UI, otherwise false

isDebugLoggingEnabled

Boolean

deviceProfile

DeviceProfile defines how navigation data should be interpreted

eHorizonOptions

EHorizonOptions defines configuration for the Electronic Horizon

routeRefreshOptions

defines configuration for refreshing routes

routeAlternativesOptions

defines configuration for observing alternatives while navigating

incidentsOptions

defines configuration for live incidents

historyRecorderOptions

defines configuration for recording navigation events

eventsAppMetadata

EventsAppMetadata information (optional)

Types

Builder
Link copied to clipboard
class Builder(applicationContext: Context)
Build a new NavigationOptions

Functions

equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Regenerate whenever a change is made
hashCode
Link copied to clipboard
open override fun hashCode(): Int
Regenerate whenever a change is made
toBuilder
Link copied to clipboard
fun toBuilder(): NavigationOptions.Builder
Get a builder to customize a subset of current options.
toString
Link copied to clipboard
open override fun toString(): String
Returns a string representation of the object.

Properties

accessToken
Link copied to clipboard
val accessToken: String?
applicationContext
Link copied to clipboard
val applicationContext: Context
the Context of the Android Application
deviceProfile
Link copied to clipboard
val deviceProfile: DeviceProfile
DeviceProfile defines how navigation data should be interpreted
distanceFormatterOptions
Link copied to clipboard
val distanceFormatterOptions: DistanceFormatterOptions
DistanceFormatterOptions options to format distances showing in notification during navigation
eHorizonOptions
Link copied to clipboard
val eHorizonOptions: EHorizonOptions
EHorizonOptions defines configuration for the Electronic Horizon
eventsAppMetadata
Link copied to clipboard
val eventsAppMetadata: EventsAppMetadata?
EventsAppMetadata information (optional)
historyRecorderOptions
Link copied to clipboard
val historyRecorderOptions: HistoryRecorderOptions
defines configuration for recording navigation events
incidentsOptions
Link copied to clipboard
val incidentsOptions: IncidentsOptions
defines configuration for live incidents
isDebugLoggingEnabled
Link copied to clipboard
val isDebugLoggingEnabled: Boolean
Boolean
isFromNavigationUi
Link copied to clipboard
val isFromNavigationUi: Boolean
Boolean true if is called from UI, otherwise false
locationEngine
Link copied to clipboard
val locationEngine: LocationEngine
the mechanism responsible for providing location approximations to navigation
locationEngineRequest
Link copied to clipboard
val locationEngineRequest: LocationEngineRequest
specifies the rate to request locations from the location engine.
navigatorPredictionMillis
Link copied to clipboard
val navigatorPredictionMillis: Long
defines approximate navigator prediction in milliseconds
routeAlternativesOptions
Link copied to clipboard
val routeAlternativesOptions: RouteAlternativesOptions
defines configuration for observing alternatives while navigating
routeRefreshOptions
Link copied to clipboard
val routeRefreshOptions: RouteRefreshOptions
defines configuration for refreshing routes
routingTilesOptions
Link copied to clipboard
val routingTilesOptions: RoutingTilesOptions
RoutingTilesOptions defines routing tiles endpoint and storage configuration.
timeFormatType
Link copied to clipboard
val timeFormatType: Int
defines time format for calculation remaining trip time