getNavigationInstruction static method

NavigationInstruction? getNavigationInstruction({
  1. TaskHandler? taskHandler,
})

Current navigation instruction.

Returns the most recent NavigationInstruction for the active navigation or simulation session, containing turn-by-turn guidance, remaining distance/time, speed limits, lane information, and signpost details. Returns null if no navigation session is active or no instruction is available yet.

Parameters

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

Returns

  • (NavigationInstruction?) Current navigation instruction, or null if unavailable.

See also:

Implementation

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

  if (result['result'] == -1) {
    return null;
  }

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