Class NavigationService`Abstract`

Navigation service class

Index

Constructors

Accessors

simulationMaxSpeedMultiplier simulationMinSpeedMultiplier

Methods

cancelNavigation getBetterRouteTimeDistanceToFork getNavigationInstruction getNavigationRoute isNavigationActive isSimulationActive isTripActive setNavigationRoadBlock skipNextIntermediateDestination startNavigation startSimulation

Constructors

constructor

new NavigationService(): NavigationService
Returns NavigationService

Accessors

`Static`simulationMaxSpeedMultiplier

get simulationMaxSpeedMultiplier(): number
Get the maximum simulation speed multiplier.

Returns number
The maximum simulation speed multiplier

Throws
An exception if it fails.
- Defined in core/navigationservice.ts:125

`Static`simulationMinSpeedMultiplier

get simulationMinSpeedMultiplier(): number
Get the minimum simulation speed multiplier.

Returns number
The minimum simulation speed multiplier

Throws
An exception if it fails.
- Defined in core/navigationservice.ts:138

Methods

`Static`cancelNavigation

cancelNavigation(taskHandler: TaskHandler): void
Cancel the active navigation. This method cancels the active navigation. If a route calculation is in progress then the provided callback will be triggered first with GemError.cancel.
Parameters
- taskHandler: TaskHandler
  Navigation listener used to identify the navigation session.
Returns void
Throws
An exception if it fails.
- Defined in core/navigationservice.ts:60

`Static`getBetterRouteTimeDistanceToFork

getBetterRouteTimeDistanceToFork(
taskHandler: { taskHandler?: TaskHandler },
): TimeDistance
Get better route time-distance until it forks the navigation route.
Parameters
- taskHandler: { taskHandler?: TaskHandler }
  Navigation listener used to identify the navigation session.
Returns TimeDistance
TimeDistance object containing the time in seconds and distance in meters to the next fork

Throws
An exception if it fails.
- Defined in core/navigationservice.ts:71

`Static`getNavigationInstruction

getNavigationInstruction(
taskHandler: { taskHandler?: TaskHandler },
): NavigationInstruction
Get the current navigation instruction.
Parameters
- taskHandler: { taskHandler?: TaskHandler }
  Navigation listener used to identify the navigation session.
Returns NavigationInstruction
NavigationInstruction object

Throws
An exception if it fails.
- Defined in core/navigationservice.ts:91

`Static`getNavigationRoute

getNavigationRoute(taskHandler?: { taskHandler?: TaskHandler }): Route
Get the current route used for navigation.
Parameters
- taskHandler: { taskHandler?: TaskHandler } = {}
  Navigation listener used to identify the navigation session.
Returns Route
Target route for the navigation session

Throws
An exception if it fails.
- Defined in core/navigationservice.ts:111

`Static`isNavigationActive

isNavigationActive(taskHandler?: { taskHandler?: TaskHandler }): boolean
Check if there is an active navigation in progress.
Parameters
- taskHandler: { taskHandler?: TaskHandler } = {}
  Navigation listener used to identify the navigation session.
Returns boolean
True if there is an active navigation in progress, false otherwise.

Throws
An exception if it fails.
- Defined in core/navigationservice.ts:152

`Static`isSimulationActive

isSimulationActive(taskHandler?: { taskHandler?: TaskHandler }): boolean
Check if there is an active simulation in progress.
Parameters
- taskHandler: { taskHandler?: TaskHandler } = {}
  Navigation listener used to identify the simulation instance.
Returns boolean
True if there is an active simulation in progress, false otherwise.

Throws
An exception if it fails.
- Defined in core/navigationservice.ts:167

`Static`isTripActive

isTripActive(taskHandler?: { taskHandler?: TaskHandler }): boolean
Check if there is an active trip (navigation or simulation) in progress.
Parameters
- taskHandler: { taskHandler?: TaskHandler } = {}
  Navigation listener used to identify the navigation session.
Returns boolean
True if there is an active trip in progress, false otherwise.

Throws
An exception if it fails.
- Defined in core/navigationservice.ts:182

`Static`setNavigationRoadBlock

setNavigationRoadBlock(
length: number,
options: { startDistance?: number; taskHandler?: TaskHandler },
): void
Cancel the active navigation. Set a roadblock on the current route having the length specified in meters starting from the current GPS position.
Parameters
- length: number
  The length specified in meters.
- options: { startDistance?: number; taskHandler?: TaskHandler }
  Object containing additional options
  - OptionalstartDistance?: number
    The distance from start where the roadblock begins, defaults to -1 meaning the current navigation position.
  - OptionaltaskHandler?: TaskHandler
    Navigation listener used to identify the navigation session.
Returns void
Throws
An exception if it fails.
- Defined in core/navigationservice.ts:200

`Static`skipNextIntermediateDestination

skipNextIntermediateDestination(
taskHandler?: { taskHandler?: TaskHandler },
): GemError
Skip next intermediate destination on the navigation route. The route will be recalculated and an onRouteUpdated notification will be emitted
Parameters
- taskHandler: { taskHandler?: TaskHandler } = {}
  Navigation listener used to identify the navigation session.
Returns GemError
GemError.success on success, GemError.notFound if there are no more intermediate waypoints on the route

Throws
An exception if it fails.
- Defined in core/navigationservice.ts:470

`Static`startNavigation

startNavigation(
    route: Route,
    onNavigationInstructionUpdate?: (
        eventType: NavigationEventType,
        instruction?: NavigationInstruction,
    ) => void,
    options?: {
        onBetterRouteDetected?: (
            route: Route,
            travelTime: number,
            delay: number,
            timeGain: number,
        ) => void;
        onBetterRouteInvalidated?: () => void;
        onBetterRouteRejected?: (reason: GemError) => void;
        onDestinationReached?: (landmark: Landmark) => void;
        onError?: (error: GemError) => void;
        onNavigationInstruction?: (
            instruction: NavigationInstruction,
            events: Set<NavigationInstructionUpdateEvents>,
        ) => void;
        onNavigationStarted?: () => void;
        onNotifyStatusChange?: (status: NavigationStatus) => void;
        onRouteUpdated?: (route: Route) => void;
        onSkipNextIntermediateDestinationDetected?: () => void;
        onTextToSpeechInstruction?: (textInstruction: string) => void;
        onWaypointReached?: (landmark: Landmark) => void;
    },
): TaskHandler
| null
Start a new navigation
Parameters
- route: Route
  Route to use for the navigation.
- OptionalonNavigationInstructionUpdate: (eventType: NavigationEventType, instruction?: NavigationInstruction) => void
  Callback for navigation-specific events.
- options: {
      onBetterRouteDetected?: (
          route: Route,
          travelTime: number,
          delay: number,
          timeGain: number,
      ) => void;
      onBetterRouteInvalidated?: () => void;
      onBetterRouteRejected?: (reason: GemError) => void;
      onDestinationReached?: (landmark: Landmark) => void;
      onError?: (error: GemError) => void;
      onNavigationInstruction?: (
          instruction: NavigationInstruction,
          events: Set<NavigationInstructionUpdateEvents>,
      ) => void;
      onNavigationStarted?: () => void;
      onNotifyStatusChange?: (status: NavigationStatus) => void;
      onRouteUpdated?: (route: Route) => void;
      onSkipNextIntermediateDestinationDetected?: () => void;
      onTextToSpeechInstruction?: (textInstruction: string) => void;
      onWaypointReached?: (landmark: Landmark) => void;
  } = {}
  Object containing navigation callbacks
  - OptionalonBetterRouteDetected?: (route: Route, travelTime: number, delay: number, timeGain: number) => void
    Callback called when a better route is detected.
  - OptionalonBetterRouteInvalidated?: () => void
    Callback called when a better route becomes invalid.
  - OptionalonBetterRouteRejected?: (reason: GemError) => void
    Callback called when a better route is rejected.
  - OptionalonDestinationReached?: (landmark: Landmark) => void
    Callback called when the destination has been reached.
  - OptionalonError?: (error: GemError) => void
    Callback called when an error occurs.
  - OptionalonNavigationInstruction?: (
    instruction: NavigationInstruction,
    events: Set<NavigationInstructionUpdateEvents>,
    ) => void
    Callback called when the navigation instruction is updated.
  - OptionalonNavigationStarted?: () => void
    Callback called when navigation starts.
  - OptionalonNotifyStatusChange?: (status: NavigationStatus) => void
    Callback to notify UI if the navigation status has changed.
  - OptionalonRouteUpdated?: (route: Route) => void
    Callback called when route was updated.
  - OptionalonSkipNextIntermediateDestinationDetected?: () => void
    Callback called when skip intention is detected.
  - OptionalonTextToSpeechInstruction?: (textInstruction: string) => void
    Callback called when a sound needs to be played.
  - OptionalonWaypointReached?: (landmark: Landmark) => void
    Callback called when a waypoint on the route has been reached.
Returns TaskHandler | null
TaskHandler for the navigation session or null if failed

Throws
An exception if it fails.
- Defined in core/navigationservice.ts:235

`Static`startSimulation

startSimulation(
    route: Route,
    onNavigationInstructionUpdate?: (
        eventType: NavigationEventType,
        instruction?: NavigationInstruction,
    ) => void,
    options?: {
        onBetterRouteDetected?: (
            route: Route,
            travelTime: number,
            delay: number,
            timeGain: number,
        ) => void;
        onBetterRouteInvalidated?: () => void;
        onBetterRouteRejected?: (reason: GemError) => void;
        onDestinationReached?: (landmark: Landmark) => void;
        onError?: (error: GemError) => void;
        onNavigationInstruction?: (
            instruction: NavigationInstruction,
            events: Set<NavigationInstructionUpdateEvents>,
        ) => void;
        onNavigationStarted?: () => void;
        onNotifyStatusChange?: (status: NavigationStatus) => void;
        onRouteUpdated?: (route: Route) => void;
        onSkipNextIntermediateDestinationDetected?: () => void;
        onTextToSpeechInstruction?: (textInstruction: string) => void;
        onWaypointReached?: (landmark: Landmark) => void;
        speedMultiplier?: number;
    },
): TaskHandler
| null
Start a new simulation
Parameters
- route: Route
  Route to use for the simulation.
- OptionalonNavigationInstructionUpdate: (eventType: NavigationEventType, instruction?: NavigationInstruction) => void
  Callback for navigation-specific events.
- options: {
      onBetterRouteDetected?: (
          route: Route,
          travelTime: number,
          delay: number,
          timeGain: number,
      ) => void;
      onBetterRouteInvalidated?: () => void;
      onBetterRouteRejected?: (reason: GemError) => void;
      onDestinationReached?: (landmark: Landmark) => void;
      onError?: (error: GemError) => void;
      onNavigationInstruction?: (
          instruction: NavigationInstruction,
          events: Set<NavigationInstructionUpdateEvents>,
      ) => void;
      onNavigationStarted?: () => void;
      onNotifyStatusChange?: (status: NavigationStatus) => void;
      onRouteUpdated?: (route: Route) => void;
      onSkipNextIntermediateDestinationDetected?: () => void;
      onTextToSpeechInstruction?: (textInstruction: string) => void;
      onWaypointReached?: (landmark: Landmark) => void;
      speedMultiplier?: number;
  } = {}
  Object containing simulation callbacks and options
  - OptionalonBetterRouteDetected?: (route: Route, travelTime: number, delay: number, timeGain: number) => void
    Callback called when a better route is detected.
  - OptionalonBetterRouteInvalidated?: () => void
    Callback called when a better route becomes invalid.
  - OptionalonBetterRouteRejected?: (reason: GemError) => void
    Callback called when a better route is rejected.
  - OptionalonDestinationReached?: (landmark: Landmark) => void
    Callback called when the destination has been reached.
  - OptionalonError?: (error: GemError) => void
    Callback called when an error occurs.
  - OptionalonNavigationInstruction?: (
    instruction: NavigationInstruction,
    events: Set<NavigationInstructionUpdateEvents>,
    ) => void
    Callback called when the navigation instruction is updated.
  - OptionalonNavigationStarted?: () => void
    Callback called when simulation starts.
  - OptionalonNotifyStatusChange?: (status: NavigationStatus) => void
    Callback to notify UI if the navigation status has changed.
  - OptionalonRouteUpdated?: (route: Route) => void
    Callback called when route was updated.
  - OptionalonSkipNextIntermediateDestinationDetected?: () => void
    Callback called when skip intention is detected.
  - OptionalonTextToSpeechInstruction?: (textInstruction: string) => void
    Callback called when a sound needs to be played.
  - OptionalonWaypointReached?: (landmark: Landmark) => void
    Callback called when a waypoint on the route has been reached.
  - OptionalspeedMultiplier?: number
    Speed multiplier for the simulation.
Returns TaskHandler | null
TaskHandler for the simulation session or null if failed

Throws
An exception if it fails.
- Defined in core/navigationservice.ts:351

Class NavigationServiceAbstract

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns NavigationService

Accessors

StaticsimulationMaxSpeedMultiplier

Returns number

Throws

StaticsimulationMinSpeedMultiplier

Returns number

Throws

Methods

StaticcancelNavigation

Parameters

Returns void

Throws

StaticgetBetterRouteTimeDistanceToFork

Parameters

Returns TimeDistance

Throws

StaticgetNavigationInstruction

Parameters

Returns NavigationInstruction

Throws

StaticgetNavigationRoute

Parameters

Returns Route

Throws

StaticisNavigationActive

Parameters

Returns boolean

Throws

StaticisSimulationActive

Parameters

Returns boolean

Throws

StaticisTripActive

Parameters

Returns boolean

Throws

StaticsetNavigationRoadBlock

Parameters

OptionalstartDistance?: number

OptionaltaskHandler?: TaskHandler

Returns void

Throws

StaticskipNextIntermediateDestination

Parameters

Returns GemError

Throws

StaticstartNavigation

Parameters

OptionalonBetterRouteDetected?: (route: Route, travelTime: number, delay: number, timeGain: number) => void

OptionalonBetterRouteInvalidated?: () => void

OptionalonBetterRouteRejected?: (reason: GemError) => void

OptionalonDestinationReached?: (landmark: Landmark) => void

OptionalonError?: (error: GemError) => void

OptionalonNavigationInstruction?: ( instruction: NavigationInstruction, events: Set<NavigationInstructionUpdateEvents>,) => void

OptionalonNavigationStarted?: () => void

OptionalonNotifyStatusChange?: (status: NavigationStatus) => void

OptionalonRouteUpdated?: (route: Route) => void

OptionalonSkipNextIntermediateDestinationDetected?: () => void

OptionalonTextToSpeechInstruction?: (textInstruction: string) => void

OptionalonWaypointReached?: (landmark: Landmark) => void

Returns TaskHandler | null

Throws

StaticstartSimulation

Parameters

OptionalonBetterRouteDetected?: (route: Route, travelTime: number, delay: number, timeGain: number) => void

OptionalonBetterRouteInvalidated?: () => void

OptionalonBetterRouteRejected?: (reason: GemError) => void

OptionalonDestinationReached?: (landmark: Landmark) => void

OptionalonError?: (error: GemError) => void

OptionalonNavigationInstruction?: ( instruction: NavigationInstruction, events: Set<NavigationInstructionUpdateEvents>,) => void

OptionalonNavigationStarted?: () => void

OptionalonNotifyStatusChange?: (status: NavigationStatus) => void

Class NavigationService`Abstract`

`Static`simulationMaxSpeedMultiplier

`Static`simulationMinSpeedMultiplier

`Static`cancelNavigation

`Static`getBetterRouteTimeDistanceToFork

`Static`getNavigationInstruction

`Static`getNavigationRoute

`Static`isNavigationActive

`Static`isSimulationActive

`Static`isTripActive

`Static`setNavigationRoadBlock

`Optional`startDistance?: number

`Optional`taskHandler?: TaskHandler

`Static`skipNextIntermediateDestination

`Static`startNavigation

`Optional`onBetterRouteDetected?: (route: Route, travelTime: number, delay: number, timeGain: number) => void

`Optional`onBetterRouteInvalidated?: () => void

`Optional`onBetterRouteRejected?: (reason: GemError) => void

`Optional`onDestinationReached?: (landmark: Landmark) => void

`Optional`onError?: (error: GemError) => void

`Optional`onNavigationInstruction?: (
instruction: NavigationInstruction,
events: Set<NavigationInstructionUpdateEvents>,
) => void

`Optional`onNavigationStarted?: () => void

`Optional`onNotifyStatusChange?: (status: NavigationStatus) => void

`Optional`onRouteUpdated?: (route: Route) => void

`Optional`onSkipNextIntermediateDestinationDetected?: () => void

`Optional`onTextToSpeechInstruction?: (textInstruction: string) => void

`Optional`onWaypointReached?: (landmark: Landmark) => void

`Static`startSimulation

`Optional`onBetterRouteDetected?: (route: Route, travelTime: number, delay: number, timeGain: number) => void

`Optional`onBetterRouteInvalidated?: () => void

`Optional`onBetterRouteRejected?: (reason: GemError) => void

`Optional`onDestinationReached?: (landmark: Landmark) => void

`Optional`onError?: (error: GemError) => void

`Optional`onNavigationInstruction?: (
instruction: NavigationInstruction,
events: Set<NavigationInstructionUpdateEvents>,
) => void

`Optional`onNavigationStarted?: () => void

`Optional`onNotifyStatusChange?: (status: NavigationStatus) => void

`Optional`onRouteUpdated?: (route: Route) => void

`Optional`onSkipNextIntermediateDestinationDetected?: () => void

`Optional`onTextToSpeechInstruction?: (textInstruction: string) => void

`Optional`onWaypointReached?: (landmark: Landmark) => void

`Optional`speedMultiplier?: number