CarPlay · IOS API REFERENCE

CPNavigationAlert

class · iOS 12.0+ · SDK 27.1

@MainActor class CPNavigationAlert

Members (20)

get · iOS 27.0+

maximumActionsCount

TypeScript

static get maximumActionsCount(): Promise<number>

Swift declaration

class var maximumActionsCount: Int { get }

get · iOS 27.0+

maximumAlertImageSize

TypeScript

static get maximumAlertImageSize(): Promise<{ width: number; height: number }>

Swift declaration

class var maximumAlertImageSize: CGSize { get }

get · iOS 27.0+

maximumAvatarImageSize

TypeScript

static get maximumAvatarImageSize(): Promise<{ width: number; height: number }>

Swift declaration

class var maximumAvatarImageSize: CGSize { get }

init · iOS 27.0+

init

TypeScript

static initTitleVariantsSubtitleVariantsAvatarImageAlertActionsDuration(titleVariants: Array<string>, subtitleVariants: Array<string>, avatarImage: (_UIKit_UIImage) | null, alertImage: (_UIKit_UIImage) | null, actions: Array<CPAlertAction>, duration: number): Promise<CPNavigationAlert>

Swift declaration

init(titleVariants: [String], subtitleVariants: [String], avatarImage: UIImage?, alert alertImage: UIImage?, actions: [CPAlertAction], duration: TimeInterval)

init · iOS 12.0+

init

TypeScript

static initTitleVariantsSubtitleVariantsImagePrimaryActionSecondaryActionDuration(titleVariants: Array<string>, subtitleVariants: (Array<string>) | null, image: (_UIKit_UIImage) | null, primaryAction: CPAlertAction, secondaryAction: (CPAlertAction) | null, duration: number): Promise<CPNavigationAlert>

Swift declaration

init(titleVariants: [String], subtitleVariants: [String]?, image: UIImage?, primaryAction: CPAlertAction, secondaryAction: CPAlertAction?, duration: TimeInterval)

init · iOS 12.0+ · Deprecated in iOS 13.0

init

TypeScript

static initTitleVariantsSubtitleVariantsImageSetPrimaryActionSecondaryActionDuration(titleVariants: Array<string>, subtitleVariants: (Array<string>) | null, imageSet: (CPImageSet) | null, primaryAction: CPAlertAction, secondaryAction: (CPAlertAction) | null, duration: number): Promise<CPNavigationAlert>

Swift declaration

init(titleVariants: [String], subtitleVariants: [String]?, imageSet: CPImageSet?, primaryAction: CPAlertAction, secondaryAction: CPAlertAction?, duration: TimeInterval)

method · iOS 12.0+

updateTitleVariants

TypeScript

updateTitleVariantsSubtitleVariants(newTitleVariants: Array<string>, newSubtitleVariants: Array<string>): Promise<void>

Swift declaration

func updateTitleVariants(_ newTitleVariants: [String], subtitleVariants newSubtitleVariants: [String])

method · iOS 27.0+

updateTitleVariants

TypeScript

updateTitleVariantsSubtitleVariantsAvatarImageAlertActionsDuration(newTitleVariants: Array<string>, newSubtitleVariants: Array<string>, avatarImage: (_UIKit_UIImage) | null, alertImage: (_UIKit_UIImage) | null, actions: Array<CPAlertAction>, duration: number): Promise<void>

Swift declaration

func updateTitleVariants(_ newTitleVariants: [String], subtitleVariants newSubtitleVariants: [String], avatarImage: UIImage?, alert alertImage: UIImage?, actions: [CPAlertAction], duration: TimeInterval)

get · iOS 27.0+

actions

TypeScript

get actions(): Promise<Array<CPAlertAction>>

Swift declaration

var actions: [CPAlertAction] { get }

get · iOS 27.0+

alertImage

TypeScript

get alertImage(): Promise<(_UIKit_UIImage) | null>

Swift declaration

@NSCopying var alertImage: UIImage? { get }

get · iOS 27.0+

avatarImage

TypeScript

get avatarImage(): Promise<(_UIKit_UIImage) | null>

Swift declaration

@NSCopying var avatarImage: UIImage? { get }

get · iOS 12.0+

duration

TypeScript

get duration(): Promise<number>

Swift declaration

var duration: TimeInterval { get }

get · iOS 12.0+

image

TypeScript

get image(): Promise<(_UIKit_UIImage) | null>

Swift declaration

@NSCopying var image: UIImage? { get }

get · iOS 12.0+

imageSet

TypeScript

get imageSet(): Promise<(CPImageSet) | null>

Swift declaration

@NSCopying var imageSet: CPImageSet? { get }

get · iOS 12.0+

primaryAction

TypeScript

get primaryAction(): Promise<CPAlertAction>

Swift declaration

var primaryAction: CPAlertAction { get }

get · iOS 12.0+

secondaryAction

TypeScript

get secondaryAction(): Promise<(CPAlertAction) | null>

Swift declaration

var secondaryAction: CPAlertAction? { get }

get · iOS 27.0+

showsCloseButton

TypeScript

get showsCloseButton(): Promise<boolean>

Swift declaration

var showsCloseButton: Bool { get set }

set · iOS 27.0+

showsCloseButton

TypeScript

setShowsCloseButton(value: boolean): Promise<void>

Swift declaration

var showsCloseButton: Bool { get set }

get · iOS 12.0+

subtitleVariants

TypeScript

get subtitleVariants(): Promise<Array<string>>

Swift declaration

var subtitleVariants: [String] { get }

get · iOS 12.0+

titleVariants

TypeScript

get titleVariants(): Promise<Array<string>>

Swift declaration

var titleVariants: [String] { get }

Skipped declarations

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

CPNavigationAlert.init()

inherited init: cannot prove legal (class declares 4 custom initializers)

All CarPlay types →