Protocol

INSetProfileInCarIntentHandling

The handler interface for restoring vehicle environment settings from a user-specified profile.

Overview

Automotive venders can support the INSetProfileInCarIntentHandling protocol in an Intents extension that they ship with their automotive apps. Use the methods of this protocol to resolve, confirm, and handle requests to restore vehicle-related settings from the profile that the user designated. Your extension should be able to communicate with the vehicle and make the necessary changes.

Siri delivers an INSetProfileInCarIntent object to your handler when the user asks to restore the current settings from a profile. The provided intent object contains information for determining which profile to use.

Topics

Handling the Intent

func handle(intent: INSetProfileInCarIntent, completion: (INSetProfileInCarIntentResponse) -> Void)

Called when it is time for you to restore settings from the designated profile.

Required.

Confirming the Response

func confirm(intent: INSetProfileInCarIntent, completion: (INSetProfileInCarIntentResponse) -> Void)

Called when it is time for you to confirm whether you can restore the settings from the designated profile.

Resolving Details of the Intent

func resolveProfileNumber(for: INSetProfileInCarIntent, with: (INIntegerResolutionResult) -> Void)

Called when it is time for you to resolve the profile index from which to restore any settings.

func resolveProfileName(for: INSetProfileInCarIntent, with: (INStringResolutionResult) -> Void)

Called when it is time for you to resolve the profile name from which to retrieve settings.

func resolveDefaultProfile(forSetProfileInCar: INSetProfileInCarIntent, with: (INBooleanResolutionResult) -> Void)

Called when it is time for you to resolve whether the profile can become the default profile.

Deprecated

Instance Methods

func resolveCarName(for: INSetProfileInCarIntent, with: (INSpeakableStringResolutionResult) -> Void)Beta

Relationships

Inherits From

NSObjectProtocol

Inherited By

INCarPlayDomainHandling

See Also

Set Profile in Car

class INSetProfileInCarIntent

A request to change the user’s vehicle environment settings to the ones from the specified profile.

class INSetProfileInCarIntentResponse

Your app’s response to a set profile in car intent.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software