startSession

fun startSession(appContext: Context? = null, notificationContent: ForegroundNotificationContent? = null, route: Route, instructionsIconsStyles: InstructionsIconsStyles? = null, circuitOptions: CircuitOptions): Error?

Starts a navigation session with optional circuit options.

Return

An Error if the session could not be started, null otherwise.

Parameters

notificationContent

Content for the foreground service notification. If null, no foreground service will be started.

route

The Route to use for navigation. If null, starts a tracking session.

circuitOptions

The CircuitOptions for circuit navigation. If null, the navigation will be a classic navigation. Otherwise it will be a circuit navigation.