startNavigation

abstract fun startNavigation(route: Route, routePathType: RoutePathType, options: RoutingOptions, constraints: RoutingConstraints, @Nullable callback: NavigationCallback)

Starts the navigation process using the specified route and configuration.

This method initializes the navigation engine with a specific RoutePathType from the given Route, using the provided RoutingOptions and RoutingConstraints. If the SDK is in the process of being destroyed, navigation will not be started and the callback will be notified of the failure.

If routing permissions are not enabled via SdkPermissionsWrapper, navigation will not proceed.

Parameters

route

The Route to navigate along.

routePathType

The specific type of route path (e.g., shortest, accessible) to use from the route.

options

Configuration for route behavior, such as accessibility and optimization.

constraints

Routing constraints that may include area or path restrictions.

callback

Optional NavigationCallback to receive success or failure notifications during navigation initialization.

See also