CarPlay · IOS API REFERENCE

CPListTemplate

class · iOS 12.0+ · SDK 27.1

@MainActor class CPListTemplate

Members (28)

get · iOS 26.0+

maximumGridButtonImageSize

TypeScript

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

Swift declaration

class var maximumGridButtonImageSize: CGSize { get }

get · iOS 26.0+

maximumHeaderGridButtonCount

TypeScript

static get maximumHeaderGridButtonCount(): Promise<number>

Swift declaration

class var maximumHeaderGridButtonCount: Int { get }

get · iOS 14.0+

maximumItemCount

TypeScript

static get maximumItemCount(): Promise<number>

Swift declaration

class var maximumItemCount: Int { get }

get · iOS 14.0+

maximumSectionCount

TypeScript

static get maximumSectionCount(): Promise<number>

Swift declaration

class var maximumSectionCount: Int { get }

method · iOS 14.0+

indexPath

TypeScript

indexPath(item: SDKHandle): Promise<(_Foundation_IndexPath) | null>

Swift declaration

func indexPath(for item: any CPListTemplateItem) -> IndexPath?

init · iOS 26.4+

init

TypeScript

static initTitleListHeaderSectionsAssistantCellConfiguration(title: (string) | null, listHeader: (CPListTemplateDetailsHeader) | null, sections: Array<CPListSection>, assistantCellConfiguration?: (CPAssistantCellConfiguration) | null): Promise<CPListTemplate>

Swift declaration

init(title: String?, listHeader: CPListTemplateDetailsHeader?, sections: [CPListSection], assistantCellConfiguration: CPAssistantCellConfiguration?)

init · iOS 12.0+

init

TypeScript

static initTitleSections(title: (string) | null, sections: Array<CPListSection>): Promise<CPListTemplate>

Swift declaration

init(title: String?, sections: [CPListSection])

init · iOS 15.0+

init

TypeScript

static initTitleSectionsAssistantCellConfiguration(title: (string) | null, sections: Array<CPListSection>, assistantCellConfiguration?: (CPAssistantCellConfiguration) | null): Promise<CPListTemplate>

Swift declaration

init(title: String?, sections: [CPListSection], assistantCellConfiguration: CPAssistantCellConfiguration?)

init · iOS 26.0+

init

TypeScript

static initTitleSectionsAssistantCellConfigurationHeaderGridButtons(title: (string) | null, sections: Array<CPListSection>, assistantCellConfiguration?: (CPAssistantCellConfiguration) | null, headerGridButtons?: (Array<CPGridButton>) | null): Promise<CPListTemplate>

Swift declaration

init(title: String?, sections: [CPListSection], assistantCellConfiguration: CPAssistantCellConfiguration?, headerGridButtons: [CPGridButton]?)

method · iOS 12.0+

updateSections

TypeScript

updateSections(sections: Array<CPListSection>): Promise<void>

Swift declaration

func updateSections(_ sections: [CPListSection])

get · iOS 15.0+

assistantCellConfiguration

TypeScript

get assistantCellConfiguration(): Promise<(CPAssistantCellConfiguration) | null>

Swift declaration

var assistantCellConfiguration: CPAssistantCellConfiguration? { get set }

set · iOS 15.0+

assistantCellConfiguration

TypeScript

setAssistantCellConfiguration(value?: (CPAssistantCellConfiguration) | null): Promise<void>

Swift declaration

var assistantCellConfiguration: CPAssistantCellConfiguration? { get set }

get · iOS 12.0+ · Deprecated in iOS 14.0

delegate

TypeScript

get delegate(): Promise<(SDKHandle) | null>

Swift declaration

weak var delegate: (any CPListTemplateDelegate)? { get set }

set · iOS 12.0+ · Deprecated in iOS 14.0

delegate

TypeScript

setDelegate(value?: (SDKHandle) | null): Promise<void>

Swift declaration

weak var delegate: (any CPListTemplateDelegate)? { get set }

get · iOS 14.0+

emptyViewSubtitleVariants

TypeScript

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

Swift declaration

var emptyViewSubtitleVariants: [String] { get set }

set · iOS 14.0+

emptyViewSubtitleVariants

TypeScript

setEmptyViewSubtitleVariants(value: Array<string>): Promise<void>

Swift declaration

var emptyViewSubtitleVariants: [String] { get set }

get · iOS 14.0+

emptyViewTitleVariants

TypeScript

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

Swift declaration

var emptyViewTitleVariants: [String] { get set }

set · iOS 14.0+

emptyViewTitleVariants

TypeScript

setEmptyViewTitleVariants(value: Array<string>): Promise<void>

Swift declaration

var emptyViewTitleVariants: [String] { get set }

get · iOS 26.0+

headerGridButtons

TypeScript

get headerGridButtons(): Promise<(Array<CPGridButton>) | null>

Swift declaration

var headerGridButtons: [CPGridButton]? { get set }

set · iOS 26.0+

headerGridButtons

TypeScript

setHeaderGridButtons(value?: (Array<CPGridButton>) | null): Promise<void>

Swift declaration

var headerGridButtons: [CPGridButton]? { get set }

get · iOS 14.0+

itemCount

TypeScript

get itemCount(): Promise<number>

Swift declaration

var itemCount: Int { get }

get · iOS 26.4+

listHeader

TypeScript

get listHeader(): Promise<(CPListTemplateDetailsHeader) | null>

Swift declaration

var listHeader: CPListTemplateDetailsHeader? { get set }

set · iOS 26.4+

listHeader

TypeScript

setListHeader(value?: (CPListTemplateDetailsHeader) | null): Promise<void>

Swift declaration

var listHeader: CPListTemplateDetailsHeader? { get set }

get · iOS 14.0+

sectionCount

TypeScript

get sectionCount(): Promise<number>

Swift declaration

var sectionCount: Int { get }

get · iOS 12.0+

sections

TypeScript

get sections(): Promise<Array<CPListSection>>

Swift declaration

var sections: [CPListSection] { get }

get · iOS 18.4+

showsSpinnerWhileEmpty

TypeScript

get showsSpinnerWhileEmpty(): Promise<boolean>

Swift declaration

var showsSpinnerWhileEmpty: Bool { get set }

set · iOS 18.4+

showsSpinnerWhileEmpty

TypeScript

setShowsSpinnerWhileEmpty(value: boolean): Promise<void>

Swift declaration

var showsSpinnerWhileEmpty: Bool { get set }

get · iOS 12.0+

title

TypeScript

get title(): Promise<(string) | null>

Swift declaration

var title: String? { get }

Skipped declarations

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

CPListTemplate.init()

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

All CarPlay types →