Interface: InternalCarPlay

Hierarchy

• NativeModule

  ↳ InternalCarPlay

Table of contents

Properties

• addListener
• removeListeners

Methods

• activateVoiceControlState
• alert
• cancelNavigationSession
• checkForConnection
• createTemplate
• createTrip
• dismissNavigationAlert
• dismissPanningInterface
• dismissTemplate
• enableNowPlaying
• finishNavigationSession
• getMaximumListImageRowItemImageSize
• getMaximumListItemCount
• getMaximumListItemImageSize
• getMaximumListSectionCount
• getMaximumNumberOfGridImages
• hideTripPreviews
• invalidate
• pauseNavigationSession
• popTemplate
• popToRootTemplate
• popToTemplate
• presentNavigationAlert
• presentTemplate
• pushTemplate
• reactToSelectedResult
• reactToUpdatedSearchText
• reload
• setRootTemplate
• showPanningInterface
• showRouteChoicesPreviewForTrip
• showTripPreviews
• startNavigationSession
• toast
• updateInformationTemplateActions
• updateInformationTemplateItems
• updateListTemplateItem
• updateListTemplateSections
• updateManeuversNavigationSession
• updateMapTemplateConfig
• updateMapTemplateMapButtons
• updateTabBarTemplates
• updateTemplate
• updateTravelEstimatesForTrip
• updateTravelEstimatesNavigationSession

Properties

addListener

• addListener: (eventType: string) => void

Type declaration

▸ (eventType): void

Add the provided eventType as an active listener

Parameters

Returns

void

Inherited from

NativeModule.addListener

Defined in

node_modules/react-native/Libraries/EventEmitter/NativeEventEmitter.d.ts:24

removeListeners

• removeListeners: (count: number) => void

Type declaration

▸ (count): void

Remove a specified number of events. There are no eventTypes in this case, as the native side doesn't remove the name, but only manages a counter of total listeners

Parameters

Returns

void

Inherited from

NativeModule.removeListeners

Defined in

node_modules/react-native/Libraries/EventEmitter/NativeEventEmitter.d.ts:32

Methods

activateVoiceControlState

▸ activateVoiceControlState(id, identifier): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:91 (opens in a new tab)

alert

▸ alert(config): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:95 (opens in a new tab)

cancelNavigationSession

▸ cancelNavigationSession(id): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:50 (opens in a new tab)

checkForConnection

▸ checkForConnection(): void

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:35 (opens in a new tab)

createTemplate

▸ createTemplate(id, config, callback?): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:56 (opens in a new tab)

createTrip

▸ createTrip(id, config): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:53 (opens in a new tab)

dismissNavigationAlert

▸ dismissNavigationAlert(id, animated): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:78 (opens in a new tab)

dismissPanningInterface

▸ dismissPanningInterface(id, animated): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:80 (opens in a new tab)

dismissTemplate

▸ dismissTemplate(animated): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:42 (opens in a new tab)

enableNowPlaying

▸ enableNowPlaying(enabled): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:43 (opens in a new tab)

finishNavigationSession

▸ finishNavigationSession(id): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:51 (opens in a new tab)

getMaximumListImageRowItemImageSize

▸ getMaximumListImageRowItemImageSize(id): Promise<ImageSize>

Parameters

Returns

Promise<ImageSize>

Defined in

packages/react-native-carplay/src/CarPlay.ts:85 (opens in a new tab)

getMaximumListItemCount

▸ getMaximumListItemCount(id): Promise<number>

Parameters

Returns

Promise<number>

Defined in

packages/react-native-carplay/src/CarPlay.ts:82 (opens in a new tab)

getMaximumListItemImageSize

▸ getMaximumListItemImageSize(id): Promise<ImageSize>

Parameters

Returns

Promise<ImageSize>

Defined in

packages/react-native-carplay/src/CarPlay.ts:83 (opens in a new tab)

getMaximumListSectionCount

▸ getMaximumListSectionCount(id): Promise<number>

Parameters

Returns

Promise<number>

Defined in

packages/react-native-carplay/src/CarPlay.ts:81 (opens in a new tab)

getMaximumNumberOfGridImages

▸ getMaximumNumberOfGridImages(id): Promise<number>

Parameters

Returns

Promise<number>

Defined in

packages/react-native-carplay/src/CarPlay.ts:84 (opens in a new tab)

hideTripPreviews

▸ hideTripPreviews(id): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:74 (opens in a new tab)

invalidate

▸ invalidate(id): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:58 (opens in a new tab)

pauseNavigationSession

▸ pauseNavigationSession(id, reason, description?): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:52 (opens in a new tab)

popTemplate

▸ popTemplate(animated): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:40 (opens in a new tab)

popToRootTemplate

▸ popToRootTemplate(animated): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:39 (opens in a new tab)

popToTemplate

▸ popToTemplate(templateId, animated): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:38 (opens in a new tab)

presentNavigationAlert

▸ presentNavigationAlert(id, config, animated): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:77 (opens in a new tab)

presentTemplate

▸ presentTemplate(templateId, animated): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:41 (opens in a new tab)

pushTemplate

▸ pushTemplate(templateId, animated): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:37 (opens in a new tab)

reactToSelectedResult

▸ reactToSelectedResult(status): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:86 (opens in a new tab)

reactToUpdatedSearchText

▸ reactToUpdatedSearchText(id, items): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:89 (opens in a new tab)

reload

▸ reload(): void

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:93 (opens in a new tab)

setRootTemplate

▸ setRootTemplate(templateId, animated): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:36 (opens in a new tab)

showPanningInterface

▸ showPanningInterface(id, animated): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:79 (opens in a new tab)

showRouteChoicesPreviewForTrip

▸ showRouteChoicesPreviewForTrip(id, tripId, config): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:76 (opens in a new tab)

showTripPreviews

▸ showTripPreviews(id, previews, config): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:75 (opens in a new tab)

startNavigationSession

▸ startNavigationSession(id, tripId): Promise<{ navigationSessionId: string ; tripId: string }>

Parameters

Returns

Promise<{ navigationSessionId: string ; tripId: string }>

Defined in

packages/react-native-carplay/src/CarPlay.ts:59 (opens in a new tab)

toast

▸ toast(message, duration): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:94 (opens in a new tab)

updateInformationTemplateActions

▸ updateInformationTemplateActions(id, config): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:55 (opens in a new tab)

updateInformationTemplateItems

▸ updateInformationTemplateItems(id, config): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:54 (opens in a new tab)

updateListTemplateItem

▸ updateListTemplateItem(id, config): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:88 (opens in a new tab)

updateListTemplateSections

▸ updateListTemplateSections(id, config): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:87 (opens in a new tab)

updateManeuversNavigationSession

▸ updateManeuversNavigationSession(id, x): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:44 (opens in a new tab)

updateMapTemplateConfig

▸ updateMapTemplateConfig(id, config): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:72 (opens in a new tab)

updateMapTemplateMapButtons

▸ updateMapTemplateMapButtons(id, config): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:73 (opens in a new tab)

updateTabBarTemplates

▸ updateTabBarTemplates(id, config): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:90 (opens in a new tab)

updateTemplate

▸ updateTemplate(id, config): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:57 (opens in a new tab)

updateTravelEstimatesForTrip

▸ updateTravelEstimatesForTrip(id, tripId, travelEstimates, timeRemainingColor): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:66 (opens in a new tab)

updateTravelEstimatesNavigationSession

▸ updateTravelEstimatesNavigationSession(id, index, estimates): void

Parameters

Returns

void

Defined in

packages/react-native-carplay/src/CarPlay.ts:45 (opens in a new tab)