NavigationConfigurationBuilder
public class NavigationConfigurationBuilder
NavigationConfigurationBuilder builds the NavigationConfiguration object
Important
This is a Public Preview API. It may be changed or removed at any time.-
Initializer
Declaration
Swift
public init( navigationKey: String, locationEngine: LocationEngine, routingService: RoutingService, configurationParameters: URLComponents? = nil )
Parameters
navigationKey
API key used to access the navigation services.
locationEngine
LocationEngine
that will be used by navigationroutingService
Routing service to be used when replanning.
configurationParameters
Configuration parameters for the navigation service
-
Specifies a custom
MapMatchingEngine
that will be used by navigationDeclaration
Swift
public func with(mapMatchingEngine: MapMatchingEngine) -> NavigationConfigurationBuilder
Parameters
mapMatchingEngine
Custom
MapMatchingEngine
that will be used by navigation -
Specifies a custom
RouteProgressDetectionEngine
that will be used by navigationDeclaration
Swift
public func with(routeProgressEngine: RouteProgressDetectionEngine) -> NavigationConfigurationBuilder
Parameters
routeProgressEngine
Custom
RouteProgressDetectionEngine
that will be used by navigation -
Specifies a custom
GuidanceEngine
that will be used by navigationDeclaration
Swift
public func with(guidanceEngine: GuidanceEngine) -> NavigationConfigurationBuilder
Parameters
guidanceEngine
Custom
GuidanceEngine
that will be used by navigation -
Specifies a custom
RouteDeviationEngine
that will be used by navigationDeclaration
Swift
public func with(deviationEngine: RouteDeviationEngine) -> NavigationConfigurationBuilder
Parameters
deviationEngine
Custom
RouteDeviationEngine
that will be used by navigation -
Specifies a custom
ArrivalDetectionEngine
that will be used by navigationDeclaration
Swift
public func with(arrivalDetectionEngine: ArrivalDetectionEngine) -> NavigationConfigurationBuilder
Parameters
arrivalDetectionEngine
Custom
ArrivalDetectionEngine
that will be used by navigation -
Specifies a custom
LocationContextDetectionEngine
that will be used by navigationDeclaration
Swift
public func with(locationContextDetectionEngine: LocationContextDetectionEngine) -> NavigationConfigurationBuilder
Parameters
locationContextDetectionEngine
Custom
LocationContextDetectionEngine
that will be used by navigation -
Specifies a custom
RouteReplanningEngine
that will be used by navigationDeclaration
Swift
public func with(routeReplanningEngine: RouteReplanningEngine) -> NavigationConfigurationBuilder
Parameters
routeReplanningEngine
Custom
RouteReplanningEngine
that will be used by navigation -
Specifies a custom
ReplanningRetryPolicy
to be used by navigation to decide if a failed replan should be retried.Declaration
Swift
public func with(routeReplanningRetryPolicy: ReplanningRetryPolicy) -> NavigationConfigurationBuilder
Parameters
routeReplanningRetryPolicy
Custom
ReplanningRetryPolicy
that will be used by navigation -
Specifies a custom
ReplanningRetryPolicy
to be used by navigation to decide if a failed deviation replan should be retried.Declaration
Swift
public func with(routeDeviationReplanningRetryPolicy: ReplanningRetryPolicy) -> NavigationConfigurationBuilder
Parameters
routeReplanningRetryPolicy
Custom
ReplanningRetryPolicy
that will be used by navigation -
Specifies a custom
ContinuousReplanningMode
that will be used by navigationDeclaration
Swift
public func with(routeReplanningMode: ContinuousReplanningMode) -> NavigationConfigurationBuilder
-
Specifies if
RouteReplanningEngine
should try to replan aRoutePlan
after deviation.Declaration
Swift
public func with(deviationReplanningMode: DeviationReplanningMode) -> NavigationConfigurationBuilder
Parameters
isReplanningOnDeviationEnabled
Flag specifying if automatic route replanning after deviation should be enabled.
-
Builds the configuration based on the parameters passed to the builder.
Declaration
Swift
public func build() -> NavigationConfiguration
Return Value
built
NavigationConfiguration
object