One Logo Pool Ball
X
Github
Discord

System

CarPlay · IOS API REFERENCE

CPNavigationSession

class · iOS 12.0+ · SDK 27.1

@MainActor class CPNavigationSession

Members (27)

method · iOS 17.4+

add

TypeScript
add(laneGuidances: Array<CPLaneGuidance>): Promise<void>
Swift declaration
func add(_ laneGuidances: [CPLaneGuidance])
method · iOS 17.4+

add

TypeScript
add56920(maneuvers: Array<CPManeuver>): Promise<void>
Swift declaration
func add(_ maneuvers: [CPManeuver])
method · iOS 26.4+

addRouteSegments

TypeScript
addRouteSegments(routeSegments: Array<CPRouteSegment>): Promise<void>
Swift declaration
func addRouteSegments(_ routeSegments: [CPRouteSegment])
method · iOS 12.0+

cancelTrip

TypeScript
cancelTrip(): Promise<void>
Swift declaration
func cancelTrip()
method · iOS 12.0+

finishTrip

TypeScript
finishTrip(): Promise<void>
Swift declaration
func finishTrip()
method · iOS 12.0+

pauseTrip

TypeScript
pauseTripForDescription(reason: CPNavigationSession_PauseReason, description?: (string) | null): Promise<void>
Swift declaration
func pauseTrip(for reason: CPNavigationSession.PauseReason, description: String?)
method · iOS 15.4+

pauseTrip

TypeScript
pauseTripForDescriptionTurnCardColor(reason: CPNavigationSession_PauseReason, description?: (string) | null, turnCardColor?: (_UIKit_UIColor) | null): Promise<void>
Swift declaration
func pauseTrip(for reason: CPNavigationSession.PauseReason, description: String?, turnCardColor: UIColor?)
method · iOS 27.0+

resumeNavigation

TypeScript
resumeNavigation(trip: CPTrip, routeSegments: Array<CPRouteSegment>, currentSegment: CPRouteSegment, rerouteReason: CPRerouteReason): Promise<void>
Swift declaration
func resumeNavigation(updatedTrip trip: CPTrip, routeSegments: [CPRouteSegment], currentSegment: CPRouteSegment, rerouteReason: CPRerouteReason)
method · iOS 17.4+

resumeTrip

TypeScript
resumeTripUpdatedRouteInformation(routeInformation: CPRouteInformation): Promise<void>
Swift declaration
func resumeTrip(updatedRouteInformation routeInformation: CPRouteInformation)
method · iOS 26.4+

resumeTrip

TypeScript
resumeTripUpdatedRouteSegmentsCurrentSegmentRerouteReason(routeSegments: Array<CPRouteSegment>, currentSegment: CPRouteSegment, rerouteReason: CPRerouteReason): Promise<void>
Swift declaration
func resumeTrip(updatedRouteSegments routeSegments: [CPRouteSegment], currentSegment: CPRouteSegment, rerouteReason: CPRerouteReason)
method · iOS 12.0+

updateEstimates

TypeScript
updateEstimates(estimates: CPTravelEstimates, maneuver: CPManeuver): Promise<void>
Swift declaration
func updateEstimates(_ estimates: CPTravelEstimates, for maneuver: CPManeuver)
get · iOS 17.4+

currentLaneGuidance

TypeScript
get currentLaneGuidance(): Promise<(CPLaneGuidance) | null>
Swift declaration
@NSCopying var currentLaneGuidance: CPLaneGuidance? { get set }
set · iOS 17.4+

currentLaneGuidance

TypeScript
setCurrentLaneGuidance(value?: (CPLaneGuidance) | null): Promise<void>
Swift declaration
@NSCopying var currentLaneGuidance: CPLaneGuidance? { get set }
get · iOS 17.4+

currentRoadNameVariants

TypeScript
get currentRoadNameVariants(): Promise<Array<string>>
Swift declaration
var currentRoadNameVariants: [String] { get set }
set · iOS 17.4+

currentRoadNameVariants

TypeScript
setCurrentRoadNameVariants(value: Array<string>): Promise<void>
Swift declaration
var currentRoadNameVariants: [String] { get set }
get · iOS 26.4+

currentSegment

TypeScript
get currentSegment(): Promise<CPRouteSegment>
Swift declaration
var currentSegment: CPRouteSegment { get set }
set · iOS 26.4+

currentSegment

TypeScript
setCurrentSegment(value: CPRouteSegment): Promise<void>
Swift declaration
var currentSegment: CPRouteSegment { get set }
get · iOS 17.4+

maneuverState

TypeScript
get maneuverState(): Promise<CPManeuverState>
Swift declaration
var maneuverState: CPManeuverState { get set }
set · iOS 17.4+

maneuverState

TypeScript
setManeuverState(value: CPManeuverState): Promise<void>
Swift declaration
var maneuverState: CPManeuverState { get set }
get · iOS 27.0+

optionsPanel

TypeScript
get optionsPanel(): Promise<(CPMapPanel) | null>
Swift declaration
var optionsPanel: CPMapPanel? { get set }
set · iOS 27.0+

optionsPanel

TypeScript
setOptionsPanel(value?: (CPMapPanel) | null): Promise<void>
Swift declaration
var optionsPanel: CPMapPanel? { get set }
get · iOS 26.4+

routeSegments

TypeScript
get routeSegments(): Promise<Array<CPRouteSegment>>
Swift declaration
var routeSegments: [CPRouteSegment] { get }
get · iOS 27.0+

isRouteSharingEnabled

TypeScript
get isRouteSharingEnabled(): Promise<boolean>
Swift declaration
var isRouteSharingEnabled: Bool { get }
get · iOS 27.0+

isRouteSharingSupported

TypeScript
get isRouteSharingSupported(): Promise<boolean>
Swift declaration
var isRouteSharingSupported: Bool { get }
get · iOS 12.0+

trip

TypeScript
get trip(): Promise<CPTrip>
Swift declaration
var trip: CPTrip { get }
get · iOS 12.0+

upcomingManeuvers

TypeScript
get upcomingManeuvers(): Promise<Array<CPManeuver>>
Swift declaration
var upcomingManeuvers: [CPManeuver] { get set }
set · iOS 12.0+

upcomingManeuvers

TypeScript
setUpcomingManeuvers(value: Array<CPManeuver>): Promise<void>
Swift declaration
var upcomingManeuvers: [CPManeuver] { get set }

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

CPNavigationSession.init()

inherited init: clang: 'init' is unavailable

All CarPlay types →