RouteProgress

public class RouteProgress
extension RouteProgress: Equatable

  • The entire route the user is currently travelling along

    Declaration

    Swift

    public let route: Route

  • Progress along the leg of the route that the user is currently on. May be null in cases where we do not yet have a confident prediction of the user’s current location

    Declaration

    Swift

    public let legProgress: LegProgress?

  • If true, the route has been completed by the user. The SDK will provide no further guidance events.

    Declaration

    Swift

    public let isArrived: Bool

  • Declaration

    Swift

    public let isNavigating: Bool

  • The path geometry of the route broken down in to segments of the same travel mode and progress type (past or future) for easier rendering.

    Declaration

    Swift

    public let pathGeometrySegments: PathGeometrySegments

  • Declaration

    Swift

    public init(route: Route,
            legProgress: LegProgress?,
            isArrived: Bool,
            isNavigating: Bool,
            pathGeometrySegments: PathGeometrySegments)

  • Declaration

    Swift

    public var durationRemaining: Duration? { get }

  • Declaration

    Swift

    public static func == (lhs: RouteProgress, rhs: RouteProgress) -> Bool