Structures

The following structures are available globally.

  • Arival check status class.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct DestinationArrivalStatus
  • Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct WaypointArrivalStatus

RouteNavigationSnapshot

  • Read-only snapshot of the current route navigation session.

    Important

    This is a Public Preview API. It may be changed or removed at any time.

    Declaration

    Swift

    public struct RouteNavigationSnapshot

    Parameters

    currentRoutePlan

    current route plan object

    currentRouteProgress

    current route progress on route.

  • Keeps state of currently followed route’s waypoints, provide methods to change this state.

    Important

    This is a Public Preview API. It may be changed or removed at any time.

    Declaration

    Swift

    public struct RouteWaypointsState
  • RoutePlan specifies all required parameters for a single route navigation session.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct RoutePlan

Guidance

  • The Guidance class describes the properties of navigation guidance.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct Guidance
  • The Announcement class contains information about what the GuidanceEngine should announce during route navigation.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct GuidanceAnnouncement : Equatable
  • The GuidanceInstruction class contains information that can be used to guide the driver during navigation.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct GuidanceInstruction
  • Class enclosing parameters passed to the GuidanceEngineInstance

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct GuidanceParams

AnnouncementGenerationParams

  • Class enclosing parameters passed to the AnnouncementGenerator

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct AnnouncementGenerationParams
  • Represents guidance through all the lanes and separators on the road.

    Important

    This is a Public Preview API. It may be changed or removed at any time.

    Declaration

    Swift

    public struct LaneGuidance

LaneGuidanceInfo

  • Class enclosing the lane guidance event type and the current LaneGuidance instance.

    Important

    This is a Public Preview API. It may be changed or removed at any time.

    Declaration

    Swift

    public struct LaneGuidanceInfo

LocationContext

  • LocationContext provides information about the driver’s location, which has been matched against the road network.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct LocationContext : Equatable

SpeedLimit

  • Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct SpeedLimit : Equatable
  • Important

    This is a Public Preview API. It may be changed or removed at any time.

    Declaration

    Swift

    public struct RoutePointProgress
  • The RouteProgress class provides information about the driver’s progress along the route.

    See more

    Declaration

    Swift

    public struct RouteProgress
  • Important

    This is a Public Preview API. It may be changed or removed at any time.

    Declaration

    Swift

    public struct RouteReplanParameters

RouteReplanningEngineOptions

  • The options used for TomTomRouteReplanningEngine configuration

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public struct RouteReplanningEngineOptions

Trip

  • Trip specifies all required parameters for a trip navigation session.

    Important

    This is a Public Preview API. It may be changed or removed at any time.

    Declaration

    Swift

    public struct Trip

SimpleEngineCalcResult

  • Important

    This is a Public Preview API. It may be changed or removed at any time.

    Declaration

    Swift

    public struct SimpleEngineCalcResult