CarPlay

CarPlayManager is the main object responsible for orchestrating interactions with a Mapbox map on CarPlay.

Messages declared in the CPApplicationDelegate protocol should be sent to this object in the containing application’s application delegate. Implement CarPlayManagerDelegate in the containing application and assign an instance to the delegate property of your CarPlayManager instance.

CarPlayManagerDelegate is the main integration point for Mapbox CarPlay support.

Implement this protocol and assign an instance to the delegate property of the shared instance of CarPlayManager.

If no delegate is set, a default built-in MapboxNavigationService will be created and used when a trip begins.

CarPlayNavigationViewController is a fully-featured turn-by-turn navigation UI for CarPlay.

The CarPlayNavigationViewControllerDelegate protocol provides methods for reacting to significant events during turn-by-turn navigation with CarPlayNavigationViewController.

The activity during which a CPTemplate is displayed. This enumeration is used to distinguish between different templates during different phases of user interaction.

A control indicating the direction that the vehicle is traveling towards.

CarPlayMapViewController is responsible for administering the Mapbox map, the interface styles and the map template buttons to display on CarPlay.

The CarPlayMapViewControllerDelegate protocol provides methods for reacting to events during free-drive navigation or route previewing in CarPlayMapViewController.

CarPlaySearchController is the main object responsible for managing the search feature on CarPlay.

Messages declared in the CPApplicationDelegate protocol should be sent to this object in the containing application’s application delegate. Implement CarPlaySearchControllerDelegate in the containing application and assign an instance to the delegate property of your CarPlaySearchController instance.

Delegate, which is used to control behavior based on certain actions from the user when performing search on CarPlay.

The CarPlayConnectionObserver protocol provides notification of a carplay unit connecting two the NavigationViewController.

Struct, which represents recently found search item on CarPlay. When storing recent items in an array use dedicated methods for addition: [RecentItem].add(_:), and removal: [RecentItem].remove(_:).

A struct that represents the result of a geocoding request, containing information for display to the user and locations for navigation.

Dictionary, which contains any custom user info related data on CarPlay (for example it’s used by CPTrip, while filling it with CPRouteChoice objects or for storing user information in CPListItem).

In case if CPRouteChoice, CPListItem or other CarPlayUserInfo dependant object uses different type in userInfo it may lead to undefined behavior.