getNavigationRoute static method

Route? getNavigationRoute({ TaskHandler? taskHandler, })

Current navigation route.

Returns the Route object currently being used for active navigation or simulation. This is the route passed to startNavigation or startSimulation, or an updated route if recalculation has occurred (delivered via onRouteUpdated callback).

Parameters

• taskHandler: Optional handler for the navigation session. If omitted, the active session is used.

Returns

• (Route) Current navigation route if there is an active navigation session, null otherwise.

See also:

• startNavigation - Start navigation with a route.
• Route - Route data structure.
• RoutingService - Route calculation.

Implementation

static Route? getNavigationRoute({final TaskHandler? taskHandler}) {
  final OperationResult result = staticMethod(
    'NavigationService',
    'getNavigationRoute',
    args: taskHandler ?? <dynamic, dynamic>{},
  );

  final GemError err = ApiErrorService.apiError;
  if (err != GemError.success) {
    return null;
  }

  return Route.init(result['result']);
}