TomTom SDK for iOS (0.71.1)
TomTom SDK for iOS
NavigationEvent
NavigationEvent
public enum NavigationEventRepresents various events that can occur during navigation.
The NavigationEvent enum defines different types of events that can be published by the TomTomNavigation.eventPublisher.
These events cover a wide range of scenarios, such as :
- changes in navigation state,
- map matching,
- progress updates,
- route changes,
guidance updates, and more. Each case in the enum corresponds to a specific event type and includes relevant information about that event.
Important
This is a Public Preview API. It may be changed or removed at any time.
-
Represents the state of navigation.
Declaration
Swift
case navigationStateChangeEvent(NavigationStateChangeEvent) -
Represents the map matching.
Declaration
Swift
case mapMatchingEvent(MapMatchingEvent) -
Represents the progress update.
Declaration
Swift
case progressUpdateEvent(ProgressUpdateEvent) -
Represents the route tracking state update.
Declaration
Swift
case routeTrackingStateUpdateEvent(RouteTrackingStateUpdateEvent) -
Represents the route.
Declaration
Swift
case routeEvent(RouteEvent)Parameters
RouteEventThe event indicating the route.
-
Represents the route added.
Declaration
Swift
case routeAddEvent(RouteAddEvent)Parameters
RouteAddEventThe event indicating the route added.
-
Represents the route removed.
Declaration
Swift
case routeRemoveEvent(RouteRemoveEvent)Parameters
RouteRemoveEventThe event indicating the route removed.
-
Represents the active route updated.
Declaration
Swift
case routeUpdateEvent(RouteUpdateEvent)Parameters
RouteUpdateEventThe event indicating the route updated.
-
Represents the active route changed.
Declaration
Swift
case activeRouteChangeEvent(ActiveRouteChangeEvent)Parameters
ActiveRouteChangeEventThe event indicating the active route changed.
-
Represents the event of guidance update.
Declaration
Swift
case guidanceUpdateEvent(GuidanceUpdateEvent)Parameters
GuidanceUpdateEventDescribes a guidance event indicating the reason of the event.
-
Represents the event of lane guidance update.
Declaration
Swift
case laneGuidanceUpdateEvent(LaneGuidanceUpdateEvent)Parameters
LaneGuidanceUpdateEventDescribes a lane guidance event indicating the reason of the event.
-
Represents the location context.
Declaration
Swift
case locationContextEvent(LocationContextEvent)Parameters
LocationContextEventThe event indicating the location context.
-
Represents the horizon event.
Declaration
Swift
case horizonEvent(HorizonEvent)Parameters
HorizonEventThe event indicating the horizon.
-
Represents the arrival at a destination.
Declaration
Swift
case destinationArrivalEvent(DestinationArrivalEvent)Parameters
DestinationArrivalEventThe event indicating arrival at the destination.
-
A
NavigationEventrepresenting the arrival at a waypoint.Declaration
Swift
case waypointArrivalEvent(WaypointArrivalEvent)Parameters
WaypointArrivalEventThe event indicating the arrival at a waypoint.
-
Represents the language change.
Declaration
Swift
case languageChangeEvent(LanguageChangeEvent)Parameters
LanguageChangeEventThe event indicating the language change.
-
Represents the state of navigation.
See moreDeclaration
Swift
public enum NavigationStateChangeEvent -
Represents the map matching event.
See moreDeclaration
Swift
public enum MapMatchingEvent -
Represents the progress update event.
See moreDeclaration
Swift
public enum ProgressUpdateEvent -
Represents the route events.
Declaration
Swift
public enum RouteEvent -
Represents the route added event.
See moreDeclaration
Swift
public enum RouteAddEvent -
Represents the route removed event.
See moreDeclaration
Swift
public enum RouteRemoveEvent -
Represents the active route changed event.
See moreDeclaration
Swift
public enum ActiveRouteChangeEvent -
Represents the route update event.
See moreDeclaration
Swift
public enum RouteUpdateEvent -
Represents guidance update events.
The enumeration is a parameter of
See moreguidanceUpdateEvent(_:)which is called when guidance update occurs.Declaration
Swift
public enum GuidanceUpdateEvent -
Represents lane guidance update events.
The enumeration is a parameter of
See morelaneGuidanceUpdateEvent(_:)which is called when lane guidance update occurs.Declaration
Swift
public enum LaneGuidanceUpdateEvent -
Represents the location context event.
See moreDeclaration
Swift
public enum LocationContextEvent -
Represents the route tracking state update event.
See moreDeclaration
Swift
public enum RouteTrackingStateUpdateEvent -
Represents the horizon events.
See moreDeclaration
Swift
public enum HorizonEvent -
Represents the destination arrival event to notify when the destination has been reached.
See moreDeclaration
Swift
public enum DestinationArrivalEvent -
Represents waypoint arrival events to notify when a waypoint has been reached or departed from.
See moreDeclaration
Swift
public enum WaypointArrivalEvent -
Represents the language change event.
See moreDeclaration
Swift
public enum LanguageChangeEvent