OnboardReachableRangeService

public class OnboardReachableRangeService : ReachableRangeRoutingService

extension OnboardReachableRangeService: OnStoreAccessChangedObserver

This onboard service calculates the area that can be reached from the origin point.

Important

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

Public

RangeError
Defines the error cases that can occur while calculating range.

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

public enum RangeError : Error


                    
                    
                    calculateRange(options:completion:)

Calculates the area that can be reached from the origin point.

Declaration

Swift

public func calculateRange(
    options: TomTomSDKRoutePlanner.RangeCalculationOptions,
    completion: @escaping (RangeCalculationOptions, Result<TomTomSDKRoutePlanner.ReachableRange, Error>) -> ()
)

Parameters

`options`	The `RangeCalculationOptions` object.
`completion`	The completion closure is called after the response to the request has been processed. If no errors have occurred, `ReachableRangeResponse` contains the range polygons and the precise polygon center (the result of map-matching the origin point).

cancelPendingRequests()
Cancels all current requests.
Declaration
Swift

public func cancelPendingRequests()

OnStoreAccessChangedObserver


                    
                    
                    onStoreAccessChangedObserverId

Declaration

Swift

public var onStoreAccessChangedObserverId: String { get }


                    
                    
                    onReadOnlyAccessGranted(mapChanged:)

Declaration

Swift

public func onReadOnlyAccessGranted(mapChanged: Bool)


                    
                    
                    onReadOnlyAccessReleaseRequested(accessReleased:)

Declaration

Swift

public func onReadOnlyAccessReleaseRequested(accessReleased: @escaping () -> ())