addRoute method

Future<Route> addRoute(
  1. String routeName,
  2. List<Waypoint> waypoints, {
  3. Map<String, dynamic>? extra,
})

Create a named Route from an ordered list of waypoints. Every referenced location must already exist.

// Example:
final route = await myNavigationService.addRoute('patrol', [Waypoint(location: 'kitchen'), Waypoint(location: 'den')]);

For more information, see the navigation service docs.

Implementation

Future<Route> addRoute(String routeName, List<Waypoint> waypoints, {Map<String, dynamic>? extra}) async {
  final request = AddRouteRequest(name: name, routeName: routeName, waypoints: waypoints, extra: extra?.toStruct());
  final response = await client.addRoute(request, options: callOptions);
  return response.route;
}