Class

INSetProfileInCarIntent

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

Declaration

class INSetProfileInCarIntent : INIntent

Overview

Automotive venders whose cars support the saving of seat and other environment settings can add support for this intent to an Intents extension that they ship with their automotive apps. When users want to restore settings from a profile, SiriKit creates an INSetProfileInCarIntent object and delivers it to the app’s Intents extension. You use the intent object to get the name or index of the profile whose settings you use to configure the vehicle.

You are responsible for determining which settings to save and restore with user profiles. You can restore seat-related settings, climate control settings, defroster settings, radio settings, other settings in your vehicle, or any combination of those settings. Siri handles only the name or index of the profile and does not ask you to provide a list of the settings that you restored. Users can restore settings regardless for whether the profile was originally created through Siri or through your vehicle’s built-in interface.

The object that handles this intent must adopt the INSetProfileInCarIntentHandling protocol. Use this intent object to resolve the profile information and to create an INSetProfileInCarIntentResponse object indicating the results of restoring the profile.

Additional Intent Attributes

Table 1 lists additional attributes of this intent object.

Table 1

Set profile in car intent attributes

Attribute

Description

Supported by

Siri Intents (in conjunction with CarPlay)

Always requires unlocked device

Yes

Example Phrases

Users can ask Siri to restore profile settings in a vehicle in a variety of ways. Table 2 provides a few sample phrases in different languages. You can use these phrases during testing to trigger your intents. This list isn’t exhaustive and Siri may recognize many other phrases.

Table 2

Siri phrases that trigger the restoration of vehicle settings from a profile

Locale

Example 1

Example 2

en

Activate profile 1

Restore profile 3

zh_CN

打开设置

重设设置

zh_HK

打開資料

恢復資料

zh_TW

打開一號設定檔

yue_CN

打开资料

恢复资料

ar

تفعيل الملف الشخصي

تمكين الملف الشخصي

da

Aktiver profil 1

Indlæs profil 2

de

Aktiviere Profil Urlaub

Profil Urlaub aktivieren

es

Activa el perfil 'día soleado'

Pon la configuración 'paseo familiar'

fi

Lataa asetukset nimellä 1

Lataa asetukset 3

fr

Active le profil 1

Charge le profil virée en voiture

he

it

Attiva profilo uno

Rimetti il profilo tre

ja

プロファイル1を使用する

プロファイル3をリストアする

ko

프로파일 1 켜줘

프로파일 3 작동 시켜

ms

Aktifkan profil 1

Buka profil 2

nb

Aktiver profil 1

Still inn profil 3

nl

Activeer profiel 1

Herstel profiel 3

pt

Ativar perfil 1

Restaurar perfil 3

ru

Активируй профиль 1

Загрузи профиль 1

sv

namnge profilen semester

spara profilen som helgresan

th

ใช้งานโปรไฟล์ 1

โหลดโปรไฟล์ 3

tr

Profil 1'i etkinleştir

Profil 1'i aktif hale getir

When managing CarPlay features, users do not need to include the name of the app in the phrases that they speak. Siri knows automatically when CarPlay is active and routes CarPlay-related intents to the app of the corresponding automotive vendor.

Topics

Initializing the Intent Object

init(profileNumber: Int?, profileName: String?, isDefaultProfile: Bool?, carName: INSpeakableString?)

Initializes the intent object with the specified profile name and index information.

Getting the Profile Information

var isDefaultProfile: Bool?

A Boolean value indicating whether to make the profile the default profile.

var profileName: String?

The name assigned to the profile.

var profileNumber: Int?

The profile index from which to restore the settings.

var profileLabel: String?

The name assigned to the profile.

Deprecated

Getting the Car Name

var carName: INSpeakableString?

The name of the car associated with the profile.

Relationships

Inherits From

Conforms To

See Also

Set Profile in Car

protocol INSetProfileInCarIntentHandling

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

class INSetProfileInCarIntentResponse

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