Base/com.mapbox.navigation.base.options/NavigationOptions/Builder

Builder

class Builder(applicationContext: Context)
Content copied to clipboard

Build a new NavigationOptions

Constructors

Link copied to clipboard
fun Builder(applicationContext: Context)
Content copied to clipboard

Functions

Link copied to clipboard
fun accessToken(accessToken: String?): NavigationOptions.Builder
Content copied to clipboard

Defines Mapbox Access Token

Link copied to clipboard
fun build(): NavigationOptions
Content copied to clipboard

Build a new instance of NavigationOptions

Link copied to clipboard
fun copilotOptions(copilotOptions: CopilotOptions): NavigationOptions.Builder
Content copied to clipboard

Defines configuration for Copilot

Link copied to clipboard
fun deviceProfile(deviceProfile: DeviceProfile): NavigationOptions.Builder
Content copied to clipboard

Defines the type of device creating localization data

Link copied to clipboard
fun distanceFormatterOptions(distanceFormatterOptions: DistanceFormatterOptions): NavigationOptions.Builder
Content copied to clipboard

Defines format distances showing in notification during navigation

Link copied to clipboard
fun eHorizonOptions(eHorizonOptions: EHorizonOptions): NavigationOptions.Builder
Content copied to clipboard

Defines configuration for the Electronic Horizon

Link copied to clipboard
fun enableSensors(value: Boolean): NavigationOptions.Builder
Content copied to clipboard

Enables analyzing data from sensors for better location prediction in case of a weak GPS signal, for example in tunnel. Usage of sensors can increase battery consumption. Warning: don't enable sensors if you emulate location updates. The SDK ignores location updates which don't match data from sensors.

Link copied to clipboard
fun eventsAppMetadata(eventsAppMetadata: EventsAppMetadata?): NavigationOptions.Builder
Content copied to clipboard

Defines EventsAppMetadata information

Link copied to clipboard
fun historyRecorderOptions(historyRecorderOptions: HistoryRecorderOptions): NavigationOptions.Builder
Content copied to clipboard

Defines configuration history recording

Link copied to clipboard
fun incidentsOptions(incidentsOptions: IncidentsOptions): NavigationOptions.Builder
Content copied to clipboard

Defines configuration for live incidents

Link copied to clipboard
fun isDebugLoggingEnabled(flag: Boolean): NavigationOptions.Builder
Content copied to clipboard

Defines if debug logging is enabled

Link copied to clipboard
fun locationEngine(locationEngine: LocationEngine): NavigationOptions.Builder
Content copied to clipboard

Override the mechanism responsible for providing location approximations to navigation

Link copied to clipboard
fun locationEngineRequest(locationEngineRequest: LocationEngineRequest): NavigationOptions.Builder
Content copied to clipboard

Override the rate to request locations from the location engine.

Link copied to clipboard
fun navigatorPredictionMillis(predictionMillis: Long): NavigationOptions.Builder
Content copied to clipboard

Defines approximate navigator prediction in milliseconds

Link copied to clipboard
fun rerouteOptions(rerouteOptions: RerouteOptions): NavigationOptions.Builder
Content copied to clipboard

Defines configuration for reroute

Link copied to clipboard
fun routeAlternativesOptions(routeAlternativesOptions: RouteAlternativesOptions): NavigationOptions.Builder
Content copied to clipboard

Defines configuration for route refresh

Link copied to clipboard
fun routeRefreshOptions(routeRefreshOptions: RouteRefreshOptions): NavigationOptions.Builder
Content copied to clipboard

Defines configuration for route refresh

Link copied to clipboard
fun routingTilesOptions(routingTilesOptions: RoutingTilesOptions): NavigationOptions.Builder
Content copied to clipboard

Defines configuration for the default on-board router

Link copied to clipboard
fun timeFormatType(type: Int): NavigationOptions.Builder
Content copied to clipboard

Defines time format for calculation remaining trip time