Protocol

INSetProfileInCarIntentHandling

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

Declaration

protocol INSetProfileInCarIntentHandling

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

Resolving the Intent Parameters

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

Resolves the profile index from which to restore any settings.

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

Resolves the profile name from which to retrieve settings.

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

Resolves the car name.

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

Resolves whether the profile can become the default profile.

Deprecated

Confirming the Response

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

Confirms whether you can restore the settings from the designated profile.

Handling the Intent

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

Handles restoring settings from the designated profile.

Required.

Relationships

Inherits From

Inherited By

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