CarPlayManagerDelegate Protocol Reference


                    
                    
                    carPlayManager(_:leadingNavigationBarButtonsCompatibleWith:in:for:)

Default implementation

Offers the delegate an opportunity to provide a customized list of leading bar buttons at the root of the template stack for the given activity.

These buttons’ tap handlers encapsulate the action to be taken, so it is up to the developer to ensure the hierarchy of templates is adequately navigable.

Default Implementation

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

Declaration

Swift

func carPlayManager(_ carPlayManager: CarPlayManager, leadingNavigationBarButtonsCompatibleWith traitCollection: UITraitCollection, in carPlayTemplate: CPTemplate, for activity: CarPlayActivity) -> [CPBarButton]?

Parameters

`carPlayManager`	The CarPlay manager instance.
`traitCollection`	The trait collection of the view controller being shown in the CarPlay window.
`carPlayTemplate`	The template into which the returned bar buttons will be inserted.
`activity`	What the user is currently doing on the CarPlay screen. Use this parameter to distinguish between multiple templates of the same kind, such as multiple `CPMapTemplate`s.

Return Value

An array of bar buttons to display on the leading side of the navigation bar while template is visible.

View Source on GitHub


                    
                    
                    carPlayManager(_:trailingNavigationBarButtonsCompatibleWith:in:for:)

Default implementation

Offers the delegate an opportunity to provide a customized list of trailing bar buttons at the root of the template stack for the given activity.

These buttons’ tap handlers encapsulate the action to be taken, so it is up to the developer to ensure the hierarchy of templates is adequately navigable.

Default Implementation

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

Declaration

Swift

func carPlayManager(_ carPlayManager: CarPlayManager, trailingNavigationBarButtonsCompatibleWith traitCollection: UITraitCollection, in carPlayTemplate: CPTemplate, for activity: CarPlayActivity) -> [CPBarButton]?

Parameters

`carPlayManager`	The CarPlay manager instance.
`traitCollection`	The trait collection of the view controller being shown in the CarPlay window.
`carPlayTemplate`	The template into which the returned bar buttons will be inserted.
`activity`	What the user is currently doing on the CarPlay screen. Use this parameter to distinguish between multiple templates of the same kind, such as multiple `CPMapTemplate`s.

Return Value

An array of bar buttons to display on the trailing side of the navigation bar while template is visible.

View Source on GitHub


                    
                    
                    carPlayManager(_:mapButtonsCompatibleWith:in:for:)

Default implementation

Offers the delegate an opportunity to provide a customized list of buttons displayed on the map.

These buttons handle the gestures on the map view, so it is up to the developer to ensure the map template is interactive. If this method is not implemented, or if nil is returned, a default set of zoom and pan buttons declared in the CarPlayMapViewController will be provided.

Default Implementation

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

Declaration

Swift

func carPlayManager(_ carPlayManager: CarPlayManager, mapButtonsCompatibleWith traitCollection: UITraitCollection, in carPlayTemplate: CPTemplate, for activity: CarPlayActivity) -> [CPMapButton]?

Parameters

`carPlayManager`	The CarPlay manager instance.
`traitCollection`	The trait collection of the view controller being shown in the CarPlay window.
`carPlayTemplate`	The template into which the returned map buttons will be inserted.
`activity`	What the user is currently doing on the CarPlay screen. Use this parameter to distinguish between multiple templates of the same kind, such as multiple `CPMapTemplate`s.

Return Value

An array of map buttons to display on the map while template is visible.

View Source on GitHub


                    
                    
                    carPlayManager(_:navigationServiceAlong:routeIndex:routeOptions:desiredSimulationMode:)

Asks the delegate to provide a navigation service. In multi-screen applications this should be the same instance used to guide the user along the route on the phone.

Declaration

Swift

func carPlayManager(_ carPlayManager: CarPlayManager, navigationServiceAlong route: Route, routeIndex: Int, routeOptions: RouteOptions, desiredSimulationMode: SimulationMode) -> NavigationService

Parameters

`carPlayManager`	The CarPlay manager instance.
`route`	The route for which the returned route controller will manage location updates.
`routeIndex`	The index of the route within the original `RouteResponse` object.
`routeOptions`	the options that were specified for the route request.
`desiredSimulationMode`	The desired simulation mode to use.

Return Value

A navigation service that manages location updates along route.

View Source on GitHub


                    
                    
                    carPlayManager(_:searchTemplate:updatedSearchText:completionHandler:)

Default implementation

Offers the delegate an opportunity to react to updates in the search text.

Postcondition

You must call completionHandler within this method.

Default Implementation

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

Declaration

Swift

func carPlayManager(_ carPlayManager: CarPlayManager, searchTemplate: CPSearchTemplate, updatedSearchText searchText: String, completionHandler: @escaping ([CPListItem]) -> Void)

Parameters

`carPlayManager`	The CarPlay manager instance.
`searchTemplate`	The search template currently accepting user input.
`searchText`	The updated search text in `searchTemplate`.
`completionHandler`	Called when the search is complete. Accepts a list of search results.

View Source on GitHub


                    
                    
                    carPlayManager(_:searchTemplate:selectedResult:completionHandler:)

Default implementation

Offers the delegate an opportunity to react to selection of a search result.

Postcondition

You must call completionHandler within this method.

Default Implementation

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

Declaration

Swift

func carPlayManager(_ carPlayManager: CarPlayManager, searchTemplate: CPSearchTemplate, selectedResult item: CPListItem, completionHandler: @escaping () -> Void)

Parameters

`carPlayManager`	The CarPlay manager instance.
`searchTemplate`	The search template currently accepting user input.
`item`	The search result the user has selected.
`completionHandler`	Called when the delegate is done responding to the selection.

View Source on GitHub


                    
                    
                    carPlayManager(_:didFailToFetchRouteBetween:options:error:)

Default implementation

Called when the CarPlay manager fails to fetch a route.

Default Implementation

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

Declaration

Swift

func carPlayManager(_ carPlayManager: CarPlayManager, didFailToFetchRouteBetween waypoints: [Waypoint]?, options: RouteOptions, error: DirectionsError) -> CPNavigationAlert?

Parameters

`carPlayManager`	The CarPlay manager instance.
`waypoints`	the waypoints for which a route could not be retrieved.
`options`	The route options that were attached to the route request.
`error`	The error returned from the directions API.

Return Value

Optionally, a CPNavigationAlert to present to the user. If this method returns an alert, the CarPlay manager will transition back to the map template and display the alert. If it returns nil, the CarPlay manager will do nothing.

View Source on GitHub


                    
                    
                    carPlayManager(_:willPreview:)

Default implementation

Offers the delegate the opportunity to customize a trip before it is presented to the user to preview.

To customize the destination’s title, which is displayed when a route is selected, set the MKMapItem.name property of the CPTrip.destination property. To add a subtitle, create a new MKMapItem whose MKPlacemark has the Street key in its address dictionary.

Default Implementation

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

Declaration

Swift

func carPlayManager(_ carPlayManager: CarPlayManager, willPreview trip: CPTrip) -> (CPTrip)

Parameters

`carPlayManager`	The CarPlay manager instance.
`trip`	The trip that will be previewed.

Return Value

The actual trip to be previewed. This can be the same trip or a new/alternate trip if desired.

View Source on GitHub


                    
                    
                    carPlayManager(_:willPreview:with:)

Default implementation

Offers the delegate the opportunity to customize a trip preview text configuration for a given trip.

Default Implementation

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

Declaration

Swift

func carPlayManager(_ carPlayManager: CarPlayManager, willPreview trip: CPTrip, with previewTextConfiguration: CPTripPreviewTextConfiguration) -> (CPTripPreviewTextConfiguration)

Parameters

`carPlayManager`	The CarPlay manager instance.
`trip`	The trip that will be previewed.
`previewTextConfiguration`	The trip preview text configuration that will be presented alongside the trip.

Return Value

The actual preview text configuration to be presented alongside the trip.

View Source on GitHub


                    
                    
                    carPlayManager(_:selectedPreviewFor:using:)

Default implementation

Offers the delegate the opportunity to react to selection of a trip. Certain trips may have alternate route(s).

Default Implementation

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

Declaration

Swift

func carPlayManager(_ carPlayManager: CarPlayManager, selectedPreviewFor trip: CPTrip, using routeChoice: CPRouteChoice)

Parameters

`carPlayManager`	The CarPlay manager instance.
`trip`	The trip to begin navigating along.
`routeChoice`	The possible route for the chosen trip.

View Source on GitHub


                    
                    
                    carPlayManager(_:didBeginNavigationWith:)

Default implementation

Called when navigation begins so that the containing app can update accordingly.

Default Implementation

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

Declaration

Swift

func carPlayManager(_ carPlayManager: CarPlayManager, didBeginNavigationWith service: NavigationService)

Parameters

`carPlayManager`	The CarPlay manager instance.
`service`	The navigation service that has begun managing location updates for a navigation session.

View Source on GitHub


                    
                    
                    carPlayManagerDidEndNavigation(_:)

Default implementation

Called when navigation ends so that the containing app can update accordingly.

Default Implementation

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

Declaration

Swift

func carPlayManagerDidEndNavigation(_ carPlayManager: CarPlayManager)

Parameters


                                  carPlayManager

The CarPlay manager instance.

View Source on GitHub


                    
                    
                    carplayManagerShouldDisableIdleTimer(_:)

Default implementation

Called when the carplay manager will disable the idle timer.

Implementing this method will allow developers to change whether idle timer is disabled when carplay is connected and the vice-versa when disconnected.

Default Implementation

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

Declaration

Swift

func carplayManagerShouldDisableIdleTimer(_ carPlayManager: CarPlayManager) -> Bool

Parameters


                                  carPlayManager

The CarPlay manager instance.

Return Value

A Boolean value indicating whether to disable idle timer when carplay is connected and enable when disconnected.

View Source on GitHub


                    
                    
                    carPlayManager(_:didPresent:)

Default implementation

Called when the CarPlayManager presents a new CarPlayNavigationViewController upon start of a navigation session.

Implementing this method will allow developers to query or customize properties of the presented CarPlayNavigationViewController. For example, a developer may wish to perform custom map styling on the presented NavigationMapView.

Default Implementation

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

Declaration

Swift

func carPlayManager(_ carPlayManager: CarPlayManager, didPresent navigationViewController: CarPlayNavigationViewController)

Parameters

`carPlayManager`	The CarPlay manager instance.
`navigationViewController`	The CarPlayNavigationViewController that was presented on the CarPlay display.

View Source on GitHub