CarPlay · IOS API REFERENCE

CPListItem

class · iOS 12.0+ · SDK 27.1

@MainActor class CPListItem

Members (31)

get · iOS 14.0+

maximumImageSize

TypeScript

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

Swift declaration

class var maximumImageSize: CGSize { get }

init · iOS 12.0+

init

TypeScript

static initTextDetailText(text?: (string) | null, detailText?: (string) | null): Promise<CPListItem>

Swift declaration

init(text: String?, detailText: String?)

init · iOS 12.0+

init

TypeScript

static initTextDetailTextImage(text?: (string) | null, detailText?: (string) | null, image?: (_UIKit_UIImage) | null): Promise<CPListItem>

Swift declaration

init(text: String?, detailText: String?, image: UIImage?)

init · iOS 14.0+

init

TypeScript

static initTextDetailTextImageAccessoryImageAccessoryType(text: (string) | null, detailText: (string) | null, image: (_UIKit_UIImage) | null, accessoryImage: (_UIKit_UIImage) | null, accessoryType: CPListItemAccessoryType): Promise<CPListItem>

Swift declaration

init(text: String?, detailText: String?, image: UIImage?, accessoryImage: UIImage?, accessoryType: CPListItemAccessoryType)

init · iOS 12.0+ · Deprecated in iOS 14.0

init

TypeScript

static initTextDetailTextImageShowsDisclosureIndicator(text: (string) | null, detailText: (string) | null, image: (_UIKit_UIImage) | null, showsDisclosureIndicator: boolean): Promise<CPListItem>

Swift declaration

init(text: String?, detailText: String?, image: UIImage?, showsDisclosureIndicator: Bool)

method · iOS 14.0+

setAccessoryImage

TypeScript

setAccessoryImage(accessoryImage?: (_UIKit_UIImage) | null): Promise<void>

Swift declaration

func setAccessoryImage(_ accessoryImage: UIImage?)

method · iOS 14.0+

setDetailText

TypeScript

setDetailText(detailText?: (string) | null): Promise<void>

Swift declaration

func setDetailText(_ detailText: String?)

method · iOS 14.0+

setImage

TypeScript

setImage(image?: (_UIKit_UIImage) | null): Promise<void>

Swift declaration

func setImage(_ image: UIImage?)

method · iOS 14.0+

setText

TypeScript

setText(text: string): Promise<void>

Swift declaration

func setText(_ text: String)

get · iOS 12.0+

accessoryImage

TypeScript

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

Swift declaration

var accessoryImage: UIImage? { get }

get · iOS 14.0+

accessoryType

TypeScript

get accessoryType(): Promise<CPListItemAccessoryType>

Swift declaration

var accessoryType: CPListItemAccessoryType { get set }

set · iOS 14.0+

accessoryType

TypeScript

setAccessoryType(value: CPListItemAccessoryType): Promise<void>

Swift declaration

var accessoryType: CPListItemAccessoryType { get set }

get · iOS 12.0+

detailText

TypeScript

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

Swift declaration

var detailText: String? { get }

get · iOS 15.0+

isEnabled

TypeScript

get isEnabled(): Promise<boolean>

Swift declaration

var isEnabled: Bool { get set }

set · iOS 15.0+

isEnabled

TypeScript

setIsEnabled(value: boolean): Promise<void>

Swift declaration

var isEnabled: Bool { get set }

get · iOS 14.0+

isExplicitContent

TypeScript

get isExplicitContent(): Promise<boolean>

Swift declaration

var isExplicitContent: Bool { get set }

set · iOS 14.0+

isExplicitContent

TypeScript

setIsExplicitContent(value: boolean): Promise<void>

Swift declaration

var isExplicitContent: Bool { get set }

get · iOS 14.0+

handler

TypeScript

get handler(): Promise<(((arg0: SDKHandle, arg1: (() => void)) => Promise<void>)) | null>

Swift declaration

var handler: ((any CPSelectableListItem, @escaping () -> Void) -> Void)? { get set }

get · iOS 12.0+

image

TypeScript

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

Swift declaration

var image: UIImage? { get }

get · iOS 14.0+

playbackProgress

TypeScript

get playbackProgress(): Promise<number>

Swift declaration

var playbackProgress: CGFloat { get set }

set · iOS 14.0+

playbackProgress

TypeScript

setPlaybackProgress(value: number): Promise<void>

Swift declaration

var playbackProgress: CGFloat { get set }

get · iOS 14.0+

isPlaying

TypeScript

get isPlaying(): Promise<boolean>

Swift declaration

var isPlaying: Bool { get set }

set · iOS 14.0+

isPlaying

TypeScript

setIsPlaying(value: boolean): Promise<void>

Swift declaration

var isPlaying: Bool { get set }

get · iOS 14.0+

playingIndicatorLocation

TypeScript

get playingIndicatorLocation(): Promise<CPListItemPlayingIndicatorLocation>

Swift declaration

var playingIndicatorLocation: CPListItemPlayingIndicatorLocation { get set }

set · iOS 14.0+

playingIndicatorLocation

TypeScript

setPlayingIndicatorLocation(value: CPListItemPlayingIndicatorLocation): Promise<void>

Swift declaration

var playingIndicatorLocation: CPListItemPlayingIndicatorLocation { get set }

get · iOS 12.0+ · Deprecated in iOS 14.0

showsDisclosureIndicator

TypeScript

get showsDisclosureIndicator(): Promise<boolean>

Swift declaration

var showsDisclosureIndicator: Bool { get }

get · iOS 14.0+ · Deprecated in iOS 14.0

showsExplicitLabel

TypeScript

get showsExplicitLabel(): Promise<boolean>

Swift declaration

var showsExplicitLabel: Bool { get set }

set · iOS 14.0+ · Deprecated in iOS 14.0

showsExplicitLabel

TypeScript

setShowsExplicitLabel(value: boolean): Promise<void>

Swift declaration

var showsExplicitLabel: Bool { get set }

get · iOS 12.0+

text

TypeScript

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

Swift declaration

var text: String? { get }

get · iOS 12.0+

userInfo

TypeScript

get userInfo(): Promise<(unknown) | null>

Swift declaration

var userInfo: Any? { get set }

set · iOS 12.0+

userInfo

TypeScript

setUserInfo(value?: (unknown) | null): Promise<void>

Swift declaration

var userInfo: Any? { get set }

Skipped declarations

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

CPListItem.handler

The iOS SDK compiler rejected this binding: converting non-escaping value to 'T' may allow it to escape

CPListItem.init()

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

All CarPlay types →