getWaypoints method

List<Landmark> getWaypoints({ GetWaypointsOptions options = GetWaypointsOptions.remainingInitial, })

Retrieve the route's waypoints.

Waypoints are returned in order: departure, intermediate waypoints, destination. When a route is being navigated the returned waypoints may be the remaining ones to visit.

Parameters

• options: Controls which waypoint set to return — see GetWaypointsOptions. Defaults to GetWaypointsOptions.remainingInitial.

Returns

• A List<Landmark> containing the route waypoints.

Implementation

List<Landmark> getWaypoints({
  final GetWaypointsOptions options = GetWaypointsOptions.remainingInitial,
}) {
  final OperationResult resultString = objectMethod(
    pointerId,
    'RouteBase',
    'getWaypoints',
    args: options.id,
  );

  return LandmarkList.init(resultString['result']).toList();
}