CarPlayNavigationViewControllerDelegate Protocol Reference


                    
                    
                    carPlayNavigationViewControllerWillDismiss(_:byCanceling:)

Default implementation

Called when the CarPlay navigation view controller is about to be dismissed, such as when the user ends a trip.

Default Implementation

UnimplementedLogging prints a warning to standard output the first time this method is called.

Declaration

Swift

func carPlayNavigationViewControllerWillDismiss(_ carPlayNavigationViewController: CarPlayNavigationViewController,
                                                byCanceling canceled: Bool)

Parameters

`carPlayNavigationViewController`	The CarPlay navigation view controller that was dismissed.
`canceled`	True if the user dismissed the CarPlay navigation view controller by tapping the Cancel button; false if the navigation view controller dismissed by some other means.

View Source on GitHub


                    
                    
                    carPlayNavigationViewControllerDidDismiss(_:byCanceling:)

Default implementation

Called when the CarPlay navigation view controller is dismissed, such as when the user ends a trip.

Default Implementation

UnimplementedLogging prints a warning to standard output the first time this method is called.

Declaration

Swift

func carPlayNavigationViewControllerDidDismiss(_ carPlayNavigationViewController: CarPlayNavigationViewController,
                                               byCanceling canceled: Bool)

Parameters

`carPlayNavigationViewController`	The CarPlay navigation view controller that was dismissed.
`canceled`	True if the user dismissed the CarPlay navigation view controller by tapping the Cancel button; false if the navigation view controller dismissed by some other means.

View Source on GitHub


                    
                    
                    carPlayNavigationViewController(_:shouldPresentArrivalUIFor:)

Default implementation

Called when the CarPlay navigation view controller detects an arrival.

Default Implementation

UnimplementedLogging prints a warning to standard output the first time this method is called.

Declaration

Swift

func carPlayNavigationViewController(_ carPlayNavigationViewController: CarPlayNavigationViewController,
                                     shouldPresentArrivalUIFor waypoint: Waypoint) -> Bool

Parameters

`carPlayNavigationViewController`	The CarPlay navigation view controller that has arrived at a waypoint.
`waypoint`	The waypoint that the user has arrived at.

Return Value

A boolean value indicating whether to show an arrival UI.

View Source on GitHub


                    
                    
                    carPlayNavigationViewController(_:didAdd:pointAnnotationManager:)

Default implementation

Tells the receiver that the final destination PointAnnotation was added to the CarPlayNavigationViewController.

Default Implementation

UnimplementedLogging prints a warning to standard output the first time this method is called.

Declaration

Swift

func carPlayNavigationViewController(_ carPlayNavigationViewController: CarPlayNavigationViewController,
                                     didAdd finalDestinationAnnotation: PointAnnotation,
                                     pointAnnotationManager: PointAnnotationManager)

Parameters

`carPlayNavigationViewController`	The `CarPlayNavigationViewController` object.
`finalDestinationAnnotation`	The point annotation that was added to the map view.
`pointAnnotationManager`	The object that manages the point annotation in the map view.

View Source on GitHub


                    
                    
                    carPlayNavigationViewController(_:routeLineLayerWithIdentifier:sourceIdentifier:)

Default implementation

Asks the receiver to return a LineLayer for the route line, given a layer identifier and a source identifier. This method is invoked when the map view loads and any time routes are added.

Default Implementation

UnimplementedLogging prints a warning to standard output the first time this method is called.

Declaration

Swift

func carPlayNavigationViewController(_ carPlayNavigationViewController: CarPlayNavigationViewController,
                                     routeLineLayerWithIdentifier identifier: String,
                                     sourceIdentifier: String) -> LineLayer?

Parameters

`carPlayNavigationViewController`	The `CarPlayNavigationViewController` object.
`identifier`	The `LineLayer` identifier.
`sourceIdentifier`	Identifier of the source, which contains the route data that this method would style.

Return Value

A LineLayer that is applied to the route line.

View Source on GitHub


                    
                    
                    carPlayNavigationViewController(_:waypointSymbolLayerWithIdentifier:sourceIdentifier:)

Default implementation

Asks the receiver to return a SymbolLayer for waypoint symbols, given an identifier and source. This method is invoked any time waypoints are added or shown.

Default Implementation

UnimplementedLogging prints a warning to standard output the first time this method is called.

Declaration

Swift

func carPlayNavigationViewController(_ carPlayNavigationViewController: CarPlayNavigationViewController,
                                     waypointSymbolLayerWithIdentifier identifier: String,
                                     sourceIdentifier: String) -> SymbolLayer?

Parameters

`carPlayNavigationViewController`	The `CarPlayNavigationViewController` object.
`identifier`	The `SymbolLayer` identifier.
`sourceIdentifier`	Identifier of the source, which contains the waypoint data that this method would style.

Return Value

A SymbolLayer that the map applies to all waypoint symbols.

View Source on GitHub


                    
                    
                    carPlayNavigationViewController(_:waypointCircleLayerWithIdentifier:sourceIdentifier:)

Default implementation

Asks the receiver to return a CircleLayer for waypoints, given an identifier and source. This method is invoked any time waypoints are added or shown.

Default Implementation

UnimplementedLogging prints a warning to standard output the first time this method is called.

Declaration

Swift

func carPlayNavigationViewController(_ carPlayNavigationViewController: CarPlayNavigationViewController,
                                     waypointCircleLayerWithIdentifier identifier: String,
                                     sourceIdentifier: String) -> CircleLayer?

Parameters

`carPlayNavigationViewController`	The `CarPlayNavigationViewController` object.
`identifier`	The `CircleLayer` identifier.
`sourceIdentifier`	Identifier of the source, which contains the waypoint data that this method would style.

Return Value

A CircleLayer that the map applies to all waypoints.

View Source on GitHub


                    
                    
                    carPlayNavigationViewController(_:routeCasingLineLayerWithIdentifier:sourceIdentifier:)

Default implementation

Asks the receiver to return a LineLayer for the casing layer that surrounds route line, given a layer identifier and a source identifier. This method is invoked when the map view loads and any time routes are added.

Default Implementation

UnimplementedLogging prints a warning to standard output the first time this method is called.

Declaration

Swift

func carPlayNavigationViewController(_ carPlayNavigationViewController: CarPlayNavigationViewController,
                                     routeCasingLineLayerWithIdentifier identifier: String,
                                     sourceIdentifier: String) -> LineLayer?

Parameters

`carPlayNavigationViewController`	The `CarPlayNavigationViewController` object.
`identifier`	The `LineLayer` identifier.
`sourceIdentifier`	Identifier of the source, which contains the route data that this method would style.

Return Value

A LineLayer that is applied as a casing around the route line.

View Source on GitHub


                    
                    
                    carPlayNavigationViewController(_:routeRestrictedAreasLineLayerWithIdentifier:sourceIdentifier:)

Default implementation

Asks the receiver to return a LineLayer for highlighting restricted areas portions of the route, given a layer identifier and a source identifier. This method is invoked when the map view loads and any time routes are added.

Default Implementation

UnimplementedLogging prints a warning to standard output the first time this method is called.

Declaration

Swift

func carPlayNavigationViewController(_ carPlayNavigationViewController: CarPlayNavigationViewController,
                                     routeRestrictedAreasLineLayerWithIdentifier identifier: String,
                                     sourceIdentifier: String) -> LineLayer?

Parameters

`carPlayNavigationViewController`	The `CarPlayNavigationViewController` object.
`identifier`	The `LineLayer` identifier.
`sourceIdentifier`	Identifier of the source, which contains the route data that this method would style.

Return Value

A LineLayer that is applied as restricted areas on the route line.

View Source on GitHub


                    
                    
                    carPlayNavigationViewController(_:willAdd:)

Default implementation

Asks the receiver to adjust the default layer which will be added to the map view and return a Layer. This method is invoked when the map view loads and any time a layer will be added.

Default Implementation

UnimplementedLogging prints a warning to standard output the first time this method is called.

Declaration

Swift

func carPlayNavigationViewController(_ carPlayNavigationViewController: CarPlayNavigationViewController,
                                     willAdd layer: Layer) -> Layer?

Parameters

`carPlayNavigationViewController`	The `CarPlayNavigationViewController` object.
`layer`	A default `Layer` generated by the carPlayNavigationViewController.

Return Value

A Layer after adjusted and will be added to the map view by MapboxNavigation.

View Source on GitHub


                    
                    
                    carPlayNavigationViewController(_:guidanceBackgroundColorFor:)

Default implementation

Asks the receiver to adjust the default color of the main instruction background color for a specific user interface style. According to CPMapTemplate.guidanceBackgroundColor Navigation SDK can’t guarantee that a custom color returned in this function will be actually applied, it’s up to CarPlay.

Default Implementation

UnimplementedLogging prints a warning to standard output the first time this method is called.

Declaration

Swift

func carPlayNavigationViewController(_ carPlayNavigationViewController: CarPlayNavigationViewController,
                                     guidanceBackgroundColorFor style: UIUserInterfaceStyle) -> UIColor?

Parameters

`carPlayNavigationViewController`	The `CarPlayNavigationViewController` object.
`style`	A default `UIUserInterfaceStyle` generated by the system.

Return Value

A UIColor which will be used to update CPMapTemplate.guidanceBackgroundColor

View Source on GitHub