startNavigation

@RequiresPermission(allOf = ["android.permission.ACCESS_FINE_LOCATION", "android.permission.ACCESS_COARSE_LOCATION", "android.permission.POST_NOTIFICATIONS"])
fun startNavigation(context: Context, latitude: Double, longitude: Double)

Start a basic navigation without any additional meta data.

Parameters

context

A context used for resource resolving and localization.

latitude

The latitude the routing ends at.

longitude

The longitude the routing ends at.


@RequiresPermission(allOf = ["android.permission.ACCESS_FINE_LOCATION", "android.permission.ACCESS_COARSE_LOCATION", "android.permission.POST_NOTIFICATIONS"])
fun startNavigation(context: Context, destinationConfiguration: DestinationConfiguration, routingConfiguration: RoutingConfiguration = RoutingConfiguration())

Start a navigation with additional metadata.

Parameters

context

A context used for resource resolving and localization.

destinationConfiguration

A DestinationConfiguration with detailed information about the place the navigation should end at.

routingConfiguration

A RoutingConfiguration with detailed information about routing configurations.


@RequiresPermission(allOf = ["android.permission.ACCESS_FINE_LOCATION", "android.permission.ACCESS_COARSE_LOCATION", "android.permission.POST_NOTIFICATIONS"])
fun startNavigation(context: Context, destinations: List<DestinationConfiguration>, routingConfiguration: RoutingConfiguration = RoutingConfiguration()): SetDestinationsError?

Start a multi-stop navigation. The navigation visits the destinations in the given order, routing to one stop at a time. The routingConfiguration applies to the whole trip; per-stop routing options can be set on each DestinationConfiguration.

Return

null on success, or a SetDestinationsError describing why the navigation could not be started.

Parameters

context

A context used for resource resolving and localization.

destinations

The ordered list of stops to navigate to. Must not be empty.

routingConfiguration

A RoutingConfiguration with trip-wide routing configuration.