Share via


Intents Namespace

The Intents namespace supports Siri-related app extensions.

Classes

Name Description
INAccountTypeResolutionResult

INIntentResolutionResult for resolving parameters in account-related interactions.

INActivateCarSignalIntent

An INIntent for causing a car to make its presence known by flashing its lights or honking its horn.

INActivateCarSignalIntentHandling_Extensions

Extension methods to the IINActivateCarSignalIntentHandling interface to support all the methods from the INActivateCarSignalIntentHandling protocol.

INActivateCarSignalIntentResponse

INIntentResponse subclass that developers of IINActivateCarSignalIntentHandling interface implementations populate with their extension's results.

INAddMediaIntent
INAddMediaIntentHandling_Extensions

Extension methods to the IINAddMediaIntentHandling interface to support all the methods from the INAddMediaIntentHandling protocol.

INAddMediaIntentResponse
INAddMediaMediaDestinationResolutionResult
INAddMediaMediaItemResolutionResult
INAddTasksIntent

An INIntent indicating the user wishes to add a task to a list.

INAddTasksIntentHandling_Extensions

Extension methods to the IINAddTasksIntentHandling interface to support all the methods from the INAddTasksIntentHandling protocol.

INAddTasksIntentResponse

INIntentResponse subclass that developers of IINAddTasksIntentHandling interface implementations populate with their extension's results.

INAddTasksTargetTaskListResolutionResult
INAddTasksTemporalEventTriggerResolutionResult
INAirline
INAirport
INAirportGate
INAnswerCallIntent
INAnswerCallIntentHandling_Extensions

Extension methods to the IINAnswerCallIntentHandling interface to support all the methods from the INAnswerCallIntentHandling protocol.

INAnswerCallIntentResponse
INAppendToNoteIntent

An INIntent indicating the user wishes to append content to a note.

INAppendToNoteIntentHandling_Extensions

Extension methods to the IINAppendToNoteIntentHandling interface to support all the methods from the INAppendToNoteIntentHandling protocol.

INAppendToNoteIntentResponse

INIntentResponse subclass that developers of IINAppendToNoteIntentHandling interface implementations populate with their extension's results.

INBalanceAmount

A balance for an account.

INBalanceTypeResolutionResult

INIntentResolutionResult for resolving parameters in interactions related to account balances.

INBillDetails

Information relating to a bill.

INBillPayee

The entity to which a bill payment is made.

INBillPayeeResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving bill payments.

INBillTypeResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving bill payments.

INBoatReservation
INBoatTrip
INBookRestaurantReservationIntent

INIntentResolutionResult for resolving parameters in reservation-related interactions.

INBookRestaurantReservationIntentHandling_Extensions

Extension methods to the IINBookRestaurantReservationIntentHandling interface to support all the methods from the INBookRestaurantReservationIntentHandling protocol.

INBookRestaurantReservationIntentResponse

INIntentResponse subclass that developers of IINBookRestaurantReservationIntentHandling interface implementations populate with their extension's results.

INBooleanResolutionResult
INBusReservation
INBusTrip
INCallCapabilityResolutionResult
INCallDestinationTypeResolutionResult

INIntentResolutionResult for resolving parameters in interactions related to call destinations.

INCallGroup
INCallRecord

Information about a past call.

INCallRecordFilter
INCallRecordResolutionResult
INCallRecordTypeOptionsResolutionResult

INIntentResolutionResult for resolving parameters in call recording-related interactions.

INCallRecordTypeResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving call records.

INCancelRideIntent

An INIntent indicating the user wishes to cancel a ride.

INCancelRideIntentHandling_Extensions

Extension methods to the IINCancelRideIntentHandling interface to support all the methods from the INCancelRideIntentHandling protocol.

INCancelRideIntentResponse

INIntentResponse subclass that developers of IINCancelRideIntentHandling interface implementations populate with their extension's results.

INCancelWorkoutIntent

An INIntent indicating the user wishes to cancel the workout.

INCancelWorkoutIntentHandling_Extensions

Extension methods to the IINCancelWorkoutIntentHandling interface to support all the methods from the INCancelWorkoutIntentHandling protocol.

INCancelWorkoutIntentResponse

INIntentResponse subclass that developers of IINCancelWorkoutIntentHandling interface implementations populate with their extension's results.

INCar
INCarAirCirculationModeResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving air conditioning.

INCarAudioSourceResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving car audio systems.

INCarChargingConnectorTypeExtensions

Extension methods for the INCarChargingConnectorType enumeration.

INCarDefrosterResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving car defrosters and their settings.

INCarHeadUnit
INCarSeatResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving car seats and their settings.

INCarSignalOptionsResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving a car signaling its whereabouts.

INCreateNoteIntent

An INIntent indicating the user wishes to create a new note.

INCreateNoteIntentHandling_Extensions

Extension methods to the IINCreateNoteIntentHandling interface to support all the methods from the INCreateNoteIntentHandling protocol.

INCreateNoteIntentResponse

INIntentResponse subclass that developers of IINCreateNoteIntentHandling interface implementations populate with their extension's results.

INCreateTaskListIntent

An INIntent indicating the user wishes to create a new task list.

INCreateTaskListIntentHandling_Extensions

Extension methods to the IINCreateTaskListIntentHandling interface to support all the methods from the INCreateTaskListIntentHandling protocol.

INCreateTaskListIntentResponse

INIntentResponse subclass that developers of IINCreateTaskListIntentHandling interface implementations populate with their extension's results.

INCurrencyAmount

An amount of money.

INCurrencyAmountResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving payments.

INDailyRoutineRelevanceProvider
INDateComponentsRange
INDateComponentsRangeResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving a range of dates.

INDateComponentsResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving dates.

INDateRelevanceProvider
INDateSearchTypeResolutionResult
INDefaultCardTemplate
INDeleteTasksIntent
INDeleteTasksIntentHandling_Extensions

Extension methods to the IINDeleteTasksIntentHandling interface to support all the methods from the INDeleteTasksIntentHandling protocol.

INDeleteTasksIntentResponse
INDeleteTasksTaskListResolutionResult
INDeleteTasksTaskResolutionResult
INDoubleResolutionResult
INEditMessageIntent
INEditMessageIntentHandling_Extensions

Extension methods to the IINEditMessageIntentHandling interface to support all the methods from the INEditMessageIntentHandling protocol.

INEditMessageIntentResponse
INEndWorkoutIntent

An INIntent indicating the user wishes to finish the workout.

INEndWorkoutIntentHandling_Extensions

Extension methods to the IINEndWorkoutIntentHandling interface to support all the methods from the INEndWorkoutIntentHandling protocol.

INEndWorkoutIntentResponse

INIntentResponse subclass that developers of IINEndWorkoutIntentHandling interface implementations populate with their extension's results.

INEnergyResolutionResult
INEnumResolutionResult
INExtension
INFile
INFileResolutionResult
INFlight
INFlightReservation
INFocusStatus
INFocusStatusCenter
INGetAvailableRestaurantReservationBookingDefaultsIntent

An INIntent indicating the user wishes to receive a list of available reservation times.

INGetAvailableRestaurantReservationBookingDefaultsIntentHandling_Extensions

Extension methods to the IINGetAvailableRestaurantReservationBookingDefaultsIntentHandling interface to support all the methods from the INGetAvailableRestaurantReservationBookingDefaultsIntentHandling protocol.

INGetAvailableRestaurantReservationBookingDefaultsIntentResponse

INIntentResponse subclass that developers of IINGetAvailableRestaurantReservationBookingDefaultsIntentHandling interface implementations populate with their extension's results.

INGetAvailableRestaurantReservationBookingsIntent

An intention to retrieve restaurant availability.

INGetAvailableRestaurantReservationBookingsIntentHandling_Extensions

Extension methods to the IINGetAvailableRestaurantReservationBookingsIntentHandling interface to support all the methods from the INGetAvailableRestaurantReservationBookingsIntentHandling protocol.

INGetAvailableRestaurantReservationBookingsIntentResponse

INIntentResponse subclass that developers of IINGetAvailableRestaurantReservationBookingsIntentHandling interface implementations populate with their extension's results.

INGetCarLockStatusIntent

An INIntent for retrieving information on a car’s locks.

INGetCarLockStatusIntentHandling_Extensions

Extension methods to the IINGetCarLockStatusIntentHandling interface to support all the methods from the INGetCarLockStatusIntentHandling protocol.

INGetCarLockStatusIntentResponse

INIntentResponse subclass that developers of IINGetCarLockStatusIntentHandling interface implementations populate with their extension's results.

INGetCarPowerLevelStatusIntent

An INIntent for retrieving the current power level of a car.

INGetCarPowerLevelStatusIntentHandling_Extensions

Extension methods to the IINGetCarPowerLevelStatusIntentHandling interface to support all the methods from the INGetCarPowerLevelStatusIntentHandling protocol.

INGetCarPowerLevelStatusIntentResponse

INIntentResponse subclass that developers of IINSendPaymentIntentHandling interface implementations populate with their extension's results.

INGetReservationDetailsIntent
INGetReservationDetailsIntentResponse
INGetRestaurantGuestIntent

An INIntent indicating the user wishes to retrieve information about a particular guest making a reservation.

INGetRestaurantGuestIntentHandling_Extensions

Extension methods to the IINGetRestaurantGuestIntentHandling interface to support all the methods from the INGetRestaurantGuestIntentHandling protocol.

INGetRestaurantGuestIntentResponse

INIntentResponse subclass that developers of IINGetRestaurantGuestIntentHandling interface implementations populate with their extension's results.

INGetRideStatusIntent

An INIntent indicating the user wishes to get information about the current ride.

INGetRideStatusIntentHandling_Extensions

Extension methods to the IINGetRideStatusIntentHandling interface to support all the methods from the INGetRideStatusIntentHandling protocol.

INGetRideStatusIntentResponse

INIntentResponse subclass that developers of IINGetRideStatusIntentHandling interface implementations populate with their extension's results.

INGetUserCurrentRestaurantReservationBookingsIntent

A request to retrieve the user's current restaurant reservations.

INGetUserCurrentRestaurantReservationBookingsIntentHandling_Extensions

Extension methods to the IINGetUserCurrentRestaurantReservationBookingsIntentHandling interface to support all the methods from the INGetUserCurrentRestaurantReservationBookingsIntentHandling protocol.

INGetUserCurrentRestaurantReservationBookingsIntentResponse

INIntentResponse subclass that developers of IINGetUserCurrentRestaurantReservationBookingsIntentHandling interface implementations populate with their extension's results.

INGetVisualCodeIntent

An INIntent indicating the user wishes to get a bar or QR code for payment or contact information.

INGetVisualCodeIntentHandling_Extensions

Extension methods to the IINGetVisualCodeIntentHandling interface to support all the methods from the INGetVisualCodeIntentHandling protocol.

INGetVisualCodeIntentResponse

INIntentResponse subclass that developers of IINGetVisualCodeIntentHandling interface implementations populate with their extension's results.

INHangUpCallIntent
INHangUpCallIntentHandling_Extensions

Extension methods to the IINHangUpCallIntentHandling interface to support all the methods from the INHangUpCallIntentHandling protocol.

INHangUpCallIntentResponse
INImage
INImageNoteContent

Represents an image within a note.

INIntegerResolutionResult
INIntent
INIntentDonationMetadata
INIntentErrorCodeExtensions

Extension methods for the INIntentErrorCode enumeration.

INIntentIdentifierExtensions

Extension methods for the INIntentIdentifier enumeration.

INIntentResolutionResult
INIntentResolutionResult<ObjectType>
INIntentResponse
INInteraction
INLengthResolutionResult
INListCarsIntent
INListCarsIntentHandling_Extensions

Extension methods to the IINListCarsIntentHandling interface to support all the methods from the INListCarsIntentHandling protocol.

INListCarsIntentResponse
INListRideOptionsIntent

An INIntent indicating the user wishes to receive a list of available ride options.

INListRideOptionsIntentHandling_Extensions

Extension methods to the IINListRideOptionsIntentHandling interface to support all the methods from the INListRideOptionsIntentHandling protocol.

INListRideOptionsIntentResponse

INIntentResponse subclass that developers of IINListRideOptionsIntentHandling interface implementations populate with their extension's results.

INLocationRelevanceProvider
INLocationSearchTypeResolutionResult

INIntentResolutionResult for resolving parameters in ___location search-related interactions.

INLodgingReservation
INMassResolutionResult
INMediaAffinityTypeResolutionResult
INMediaDestination
INMediaDestinationResolutionResult
INMediaItem
INMediaItemResolutionResult
INMediaSearch
INMediaUserContext
INMessage

Encapsulates Intents / SiriKit information regarding a messaging-service message.

INMessageAttributeOptionsResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving messages.

INMessageAttributeResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving messages.

INMessageLinkMetadata
INMessageReaction
INNote

Note content for a single note in an app.

INNotebookItemTypeResolutionResult

INIntentResolutionResult for resolving parameters in notebook item type-related interactions.

INNoteContent

Base class for note content.

INNoteContentResolutionResult

INIntentResolutionResult for resolving parameters in note content-related interactions.

INNoteContentTypeResolutionResult

INIntentResolutionResult for resolving parameters in note content type-related interactions.

INNoteResolutionResult

INIntentResolutionResult for resolving parameters in note-related interactions.

INObject
INObjectCollection<ObjectType>
INObjectResolutionResult
INObjectSection<ObjectType>
INOutgoingMessageTypeResolutionResult
INParameter

Represents a custom interface parameter for a developer-defined Siri interaction.

INPauseWorkoutIntent

An INIntent indicating the user wishes to pause the workout.

INPauseWorkoutIntentHandling_Extensions

Extension methods to the IINPauseWorkoutIntentHandling interface to support all the methods from the INPauseWorkoutIntentHandling protocol.

INPauseWorkoutIntentResponse

INIntentResponse subclass that developers of IINPauseWorkoutIntentHandling interface implementations populate with their extension's results.

INPayBillIntent

An INIntent for paying a bill.

INPayBillIntentHandling_Extensions

Extension methods to the IINPayBillIntentHandling interface to support all the methods from the INPayBillIntentHandling protocol.

INPayBillIntentResponse

INIntentResponse subclass that developers of IINPayBillIntentHandling interface implementations populate with their extension's results.

INPaymentAccount

Account details for a payment intent.

INPaymentAccountResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving payments.

INPaymentAmount

Details on the amount of a payment intention.

INPaymentAmountResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving payments.

INPaymentMethod

Encapsulates data about a form of payment.

INPaymentMethodResolutionResult
INPaymentRecord

Encapsulates details about a payment.

INPaymentStatusResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving payments.

INPerson

Encapsulates a person's data, for the purposes of Intents / SiriKit.

INPersonHandle

The user of the application.

INPersonHandleLabelExtensions

Extension methods for the INPersonHandleLabel enumeration.

INPersonRelationshipExtensions

Extension methods for the INPersonRelationship enumeration.

INPersonResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving known people (contacts).

INPlacemarkResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving named locations.

INPlaybackQueueLocationResolutionResult
INPlaybackRepeatModeResolutionResult
INPlayMediaIntent
INPlayMediaIntentHandling_Extensions

Extension methods to the IINPlayMediaIntentHandling interface to support all the methods from the INPlayMediaIntentHandling protocol.

INPlayMediaIntentResponse
INPlayMediaMediaItemResolutionResult
INPlayMediaPlaybackSpeedResolutionResult
INPreferences
INPriceRange

Holds information about a pair of prices.

INRadioTypeResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving radio formats.

INRecurrenceRule

A repetition rule for date ranges.

INRelativeReferenceResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving relative locations.

INRelativeSettingResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving values that have relative settings (higher / lower, more / less).

INRelevanceProvider
INRelevantShortcut
INRelevantShortcutStore
INRentalCar
INRentalCarReservation
INRequestPaymentCurrencyAmountResolutionResult

INIntentResolutionResult for resolving parameters in currency-related interactions.

INRequestPaymentIntent

An INIntent indicating the user wishes to request a payment.

INRequestPaymentIntentHandling_Extensions

Extension methods to the IINRequestPaymentIntentHandling interface to support all the methods from the INRequestPaymentIntentHandling protocol.

INRequestPaymentIntentResponse

INIntentResponse subclass that developers of IINRequestPaymentIntentHandling interface implementations populate with their extension's results.

INRequestPaymentPayerResolutionResult

INIntentResolutionResult for resolving parameters in payer-related interactions.

INRequestRideIntent

An INIntent indicating the user wishes to request a ride.

INRequestRideIntentHandling_Extensions

Extension methods to the IINRequestRideIntentHandling interface to support all the methods from the INRequestRideIntentHandling protocol.

INRequestRideIntentResponse

INIntentResponse subclass that developers of IINRequestRideIntentHandling interface implementations populate with their extension's results.

INReservation
INReservationAction
INRestaurant

Data about a specific restaurant ___location.

INRestaurantGuest

A INPerson expected at a restaurant reservation.

INRestaurantGuestDisplayPreferences

Encapsulates the preferred configuration for presenting guest information for Intents relating to restaurants.

INRestaurantGuestResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving restaurant reservations.

INRestaurantOffer

Encapsulates special offers and promotions.

INRestaurantReservation
INRestaurantReservationBooking

A potential restaurant reservation (see also INRestaurantReservationUserBooking).

INRestaurantReservationUserBooking

A restaurant reservation.

INRestaurantResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving restaurant names.

INResumeWorkoutIntent

An INIntent indicating the user wishes to resume a paused workout.

INResumeWorkoutIntentHandling_Extensions

Extension methods to the IINResumeWorkoutIntentHandling interface to support all the methods from the INResumeWorkoutIntentHandling protocol.

INResumeWorkoutIntentResponse

INIntentResponse subclass that developers of IINResumeWorkoutIntentHandling interface implementations populate with their extension's results.

INRideCompletionStatus

Holds data relating to finished rides, including the completion reason and payment information.

INRideDriver

Information of the driver of a requested ride.

INRideFareLineItem

A ride-related charge.

INRideOption

Holds options relating to a vehicle ride.

INRidePartySizeOption

Holds the data associated with the number of passengers in a ride.

INRideStatus

Encapsulates the state of a ride.

INRideVehicle

The vehicle used for a requested ride.

INSaveProfileInCarIntent

An INIntent indicating the user wishes to save a user profile.

INSaveProfileInCarIntentHandling_Extensions

Extension methods to the IINSaveProfileInCarIntentHandling interface to support all the methods from the INSaveProfileInCarIntentHandling protocol.

INSaveProfileInCarIntentResponse

INIntentResponse subclass that developers of IINSaveProfileInCarIntentHandling interface implementations populate with their extension's results.

INSearchCallHistoryIntent

An INIntent indicating the user wishes to search the call history.

INSearchCallHistoryIntentHandling_Extensions

Extension methods to the IINSearchCallHistoryIntentHandling interface to support all the methods from the INSearchCallHistoryIntentHandling protocol.

INSearchCallHistoryIntentResponse

INIntentResponse subclass that developers of IINSearchCallHistoryIntentHandling interface implementations populate with their extension's results.

INSearchForAccountsIntent

An INIntent indicating the user wishes to search for accounts information.

INSearchForAccountsIntentHandling_Extensions

Extension methods to the IINSearchForAccountsIntentHandling interface to support all the methods from the INSearchForAccountsIntentHandling protocol.

INSearchForAccountsIntentResponse

INIntentResponse subclass that developers of IINSearchForAccountsIntentHandling interface implementations populate with their extension's results.

INSearchForBillsIntent

An INIntent for locating bills.

INSearchForBillsIntentHandling_Extensions

Extension methods to the IINSearchForBillsIntentHandling interface to support all the methods from the INSearchForBillsIntentHandling protocol.

INSearchForBillsIntentResponse

INIntentResponse subclass that developers of IINSearchForBillsIntentHandling interface implementations populate with their extension's results.

INSearchForMediaIntent
INSearchForMediaIntentHandling_Extensions

Extension methods to the IINSearchForMediaIntentHandling interface to support all the methods from the INSearchForMediaIntentHandling protocol.

INSearchForMediaIntentResponse
INSearchForMediaMediaItemResolutionResult
INSearchForMessagesIntent

An INIntent indicating the user wishes to search their message history.

INSearchForMessagesIntentHandling_Extensions

Extension methods to the IINSearchForMessagesIntentHandling interface to support all the methods from the INSearchForMessagesIntentHandling protocol.

INSearchForMessagesIntentResponse

INIntentResponse subclass that developers of IINSearchForMessagesIntentHandling interface implementations populate with their extension's results.

INSearchForNotebookItemsIntent

An INIntent indicating the user wishes to search for notes, tasks, or reminders.

INSearchForNotebookItemsIntentHandling_Extensions

Extension methods to the IINSearchForNotebookItemsIntentHandling interface to support all the methods from the INSearchForNotebookItemsIntentHandling protocol.

INSearchForNotebookItemsIntentResponse

INIntentResponse subclass that developers of IINSearchForNotebookItemsIntentHandling interface implementations populate with their extension's results.

INSearchForPhotosIntent

An INIntent indicating the user wishes to search for photos.

INSearchForPhotosIntentHandling_Extensions

Extension methods to the IINSearchForPhotosIntentHandling interface to support all the methods from the INSearchForPhotosIntentHandling protocol.

INSearchForPhotosIntentResponse

INIntentResponse subclass that developers of IINSearchForPhotosIntentHandling interface implementations populate with their extension's results.

INSeat
INSendMessageAttachment
INSendMessageIntent

An INIntent indicating the user wishes to send a message.

INSendMessageIntentDonationMetadata
INSendMessageIntentHandling_Extensions

Extension methods to the IINSendMessageIntentHandling interface to support all the methods from the INSendMessageIntentHandling protocol.

INSendMessageIntentResponse

INIntentResponse subclass that developers of IINSendMessageIntentHandling interface implementations populate with their extension's results.

INSendMessageRecipientResolutionResult

INIntentResolutionResult for resolving parameters in recipient-related message send interactions.

INSendPaymentCurrencyAmountResolutionResult

INIntentResolutionResult for resolving parameters in currency-related interactions for sending payments.

INSendPaymentIntent

An INIntent indicating the user wishes to make a payment.

INSendPaymentIntentHandling_Extensions

Extension methods to the IINSendPaymentIntentHandling interface to support all the methods from the INSendPaymentIntentHandling protocol.

INSendPaymentIntentResponse

INIntentResponse subclass that developers of IINSendPaymentIntentHandling interface implementations populate with their extension's results.

INSendPaymentPayeeResolutionResult

INIntentResolutionResult for resolving parameters in payee-related interactions for sending payments.

INSendRideFeedbackIntent

An INIntent indicating the user wishes to send feedback about a ride.

INSendRideFeedbackIntentHandling_Extensions

Extension methods to the IINSendRideFeedbackIntentHandling interface to support all the methods from the INSendRideFeedbackIntentHandling protocol.

INSendRideFeedbackIntentResponse

INIntentResponse subclass that developers of IINSendRideFeedbackIntentHandling interface implementations populate with their extension's results.

INSetAudioSourceInCarIntent

An INIntent indicating the user wishes to specify the source for audio playback.

INSetAudioSourceInCarIntentHandling_Extensions

Extension methods to the IINSetAudioSourceInCarIntentHandling interface to support all the methods from the INSetAudioSourceInCarIntentHandling protocol.

INSetAudioSourceInCarIntentResponse

INIntentResponse subclass that developers of IINSetAudioSourceInCarIntentHandling interface implementations populate with their extension's results.

INSetCarLockStatusIntent

The name and desired locked/unlocked state of a car.

INSetCarLockStatusIntentHandling_Extensions

Extension methods to the IINSetCarLockStatusIntentHandling interface to support all the methods from the INSetCarLockStatusIntentHandling protocol.

INSetCarLockStatusIntentResponse

INIntentResponse subclass that developers of IINSetCarLockStatusIntentHandling interface implementations populate with their extension's results.

INSetClimateSettingsInCarIntent

An INIntent indicating the user wishes to control the climate.

INSetClimateSettingsInCarIntentHandling_Extensions

Extension methods to the IINSetClimateSettingsInCarIntentHandling interface to support all the methods from the INSetClimateSettingsInCarIntentHandling protocol.

INSetClimateSettingsInCarIntentResponse

INIntentResponse subclass that developers of IINSetClimateSettingsInCarIntentHandling interface implementations populate with their extension's results.

INSetDefrosterSettingsInCarIntent

An INIntent indicating the user wishes to control the defroster.

INSetDefrosterSettingsInCarIntentHandling_Extensions

Extension methods to the IINSetDefrosterSettingsInCarIntentHandling interface to support all the methods from the INSetDefrosterSettingsInCarIntentHandling protocol.

INSetDefrosterSettingsInCarIntentResponse

INIntentResponse subclass that developers of IINSetDefrosterSettingsInCarIntentHandling interface implementations populate with their extension's results.

INSetMessageAttributeIntent

An INIntent indicating the user wishes to set a message characteristic.

INSetMessageAttributeIntentHandling_Extensions

Extension methods to the IINSetMessageAttributeIntentHandling interface to support all the methods from the INSetMessageAttributeIntentHandling protocol.

INSetMessageAttributeIntentResponse

INIntentResponse subclass that developers of IINSetMessageAttributeIntentHandling interface implementations populate with their extension's results.

INSetProfileInCarIntent

An INIntent indicating the user wishes to choose a particular user profile.

INSetProfileInCarIntentHandling_Extensions

Extension methods to the IINSetProfileInCarIntentHandling interface to support all the methods from the INSetProfileInCarIntentHandling protocol.

INSetProfileInCarIntentResponse

INIntentResponse subclass that developers of IINSetProfileInCarIntentHandling interface implementations populate with their extension's results.

INSetRadioStationIntent

An INIntent indicating the user wishes to choose a station.

INSetRadioStationIntentHandling_Extensions

Extension methods to the IINSetRadioStationIntentHandling interface to support all the methods from the INSetRadioStationIntentHandling protocol.

INSetRadioStationIntentResponse

INIntentResponse subclass that developers of IINSetRadioStationIntentHandling interface implementations populate with their extension's results.

INSetSeatSettingsInCarIntent

An INIntent indicating the user wishes to modify the seat settings.

INSetSeatSettingsInCarIntentHandling_Extensions

Extension methods to the IINSetSeatSettingsInCarIntentHandling interface to support all the methods from the INSetSeatSettingsInCarIntentHandling protocol.

INSetSeatSettingsInCarIntentResponse

INIntentResponse subclass that developers of IINSetSeatSettingsInCarIntentHandling interface implementations populate with their extension's results.

INSetTaskAttributeIntent

An INIntent indicating the user wishes to modify a task attribute, for example, by marking a task complete.

INSetTaskAttributeIntentHandling_Extensions

Extension methods to the IINSetTaskAttributeIntentHandling interface to support all the methods from the INSetTaskAttributeIntentHandling protocol.

INSetTaskAttributeIntentResponse

INIntentResponse subclass that developers of IINSetTaskAttributeIntentHandling interface implementations populate with their extension's results.

INSetTaskAttributeTemporalEventTriggerResolutionResult
INShareFocusStatusIntent
INShareFocusStatusIntentHandling_Extensions

Extension methods to the IINShareFocusStatusIntentHandling interface to support all the methods from the INShareFocusStatusIntentHandling protocol.

INShareFocusStatusIntentResponse
INShortcut
INSnoozeTasksIntent
INSnoozeTasksIntentHandling_Extensions

Extension methods to the IINSnoozeTasksIntentHandling interface to support all the methods from the INSnoozeTasksIntentHandling protocol.

INSnoozeTasksIntentResponse
INSnoozeTasksTaskResolutionResult
INSpatialEventTrigger
INSpatialEventTriggerResolutionResult

INIntentResolutionResult for resolving parameters in spatial event trigger-related interactions.

INSpeakable_Extensions

Extension methods to the IINSpeakable interface to support all the methods from the INSpeakable protocol.

INSpeakableString
INSpeakableStringResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving arbitrary strings.

INSpeedResolutionResult
INStartAudioCallIntent

An INIntent indicating the user wishes to start an audio call.

INStartAudioCallIntentHandling_Extensions

Extension methods to the IINStartAudioCallIntentHandling interface to support all the methods from the INStartAudioCallIntentHandling protocol.

INStartAudioCallIntentResponse

INIntentResponse subclass that developers of IINStartAudioCallIntentHandling interface implementations populate with their extension's results.

INStartCallCallCapabilityResolutionResult
INStartCallCallRecordToCallBackResolutionResult
INStartCallContactResolutionResult
INStartCallIntent
INStartCallIntentHandling_Extensions

Extension methods to the IINStartCallIntentHandling interface to support all the methods from the INStartCallIntentHandling protocol.

INStartCallIntentResponse
INStartPhotoPlaybackIntent

An INIntent indicating the user wishes to begin a slide show.

INStartPhotoPlaybackIntentHandling_Extensions

Extension methods to the IINStartPhotoPlaybackIntentHandling interface to support all the methods from the INStartPhotoPlaybackIntentHandling protocol.

INStartPhotoPlaybackIntentResponse

INIntentResponse subclass that developers of IINStartPhotoPlaybackIntentHandling interface implementations populate with their extension's results.

INStartVideoCallIntent

An INIntent indicating the user wishes to start a video call.

INStartVideoCallIntentHandling_Extensions

Extension methods to the IINStartVideoCallIntentHandling interface to support all the methods from the INStartVideoCallIntentHandling protocol.

INStartVideoCallIntentResponse

INIntentResponse subclass that developers of IINStartVideoCallIntentHandling interface implementations populate with their extension's results.

INStartWorkoutIntent

An INIntent indicating the user wishes to begin a workout.

INStartWorkoutIntentHandling_Extensions

Extension methods to the IINStartWorkoutIntentHandling interface to support all the methods from the INStartWorkoutIntentHandling protocol.

INStartWorkoutIntentResponse

INIntentResponse subclass that developers of IINStartWorkoutIntentHandling interface implementations populate with their extension's results.

INSticker
INStringResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving arbitrary strings.

INTask

A task for the user.

INTaskList

A list of tasks for the user.

INTaskListResolutionResult

INIntentResolutionResult for resolving parameters in task list-related interactions.

INTaskPriorityResolutionResult
INTaskResolutionResult

INIntentResolutionResult for resolving parameters in task-related interactions.

INTaskStatusResolutionResult

INIntentResolutionResult for resolving parameters in task status-related interactions.

INTemperatureResolutionResult

INIntentResolutionResult for resolving parameters in temperature-related interactions.

INTemporalEventTrigger

A time-based reminder trigger for a user task.

INTemporalEventTriggerResolutionResult

INIntentResolutionResult for resolving parameters in temporal event trigger-related interactions.

INTemporalEventTriggerTypeOptionsResolutionResult
INTermsAndConditions

Holds terms and conditions relevant to restaurant reservations.

INTextNoteContent

The text of a note.

INTicketedEvent
INTicketedEventReservation
INTimeIntervalResolutionResult
INTrainReservation
INTrainTrip
INTransferMoneyIntent

An INIntent indicating the user wishes to transfer funds.

INTransferMoneyIntentHandling_Extensions

Extension methods to the IINTransferMoneyIntentHandling interface to support all the methods from the INTransferMoneyIntentHandling protocol.

INTransferMoneyIntentResponse

INIntentResponse subclass that developers of IINTransferMoneyIntentHandling interface implementations populate with their extension's results.

INUnsendMessagesIntent
INUnsendMessagesIntentHandling_Extensions

Extension methods to the IINUnsendMessagesIntentHandling interface to support all the methods from the INUnsendMessagesIntentHandling protocol.

INUnsendMessagesIntentResponse
INUpcomingMediaManager
INUpdateMediaAffinityIntent
INUpdateMediaAffinityIntentHandling_Extensions

Extension methods to the IINUpdateMediaAffinityIntentHandling interface to support all the methods from the INUpdateMediaAffinityIntentHandling protocol.

INUpdateMediaAffinityIntentResponse
INUpdateMediaAffinityMediaItemResolutionResult
INUrlResolutionResult
INUserContext
INVisualCodeTypeResolutionResult

INIntentResolutionResult for resolving parameters in visual code type-related interactions.

INVocabulary
INVoiceShortcut
INVoiceShortcutCenter
INVolumeResolutionResult
INWorkoutGoalUnitTypeResolutionResult

INIntentResolutionResult for resolving parameters in workout-related interactions.

INWorkoutLocationTypeResolutionResult

INIntentResolutionResult for resolving parameters in workout-related interactions.

INWorkoutNameIdentifierExtensions

Extension methods for the INWorkoutNameIdentifier enumeration.

NSExtensionContext_ShareExtension
NSUserActivity_IntentsAdditions

Optional methods for the NSUserActivity interface.

Interfaces

Name Description
IINActivateCarSignalIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINAddMediaIntentHandling

This interface represents the Objective-C protocol INAddMediaIntentHandling.

IINAddTasksIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINAnswerCallIntentHandling

This interface represents the Objective-C protocol INAnswerCallIntentHandling.

IINAppendToNoteIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINBookRestaurantReservationIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINCallsDomainHandling

Interface combining several interfaces related to various phone-call intents.

IINCancelRideIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINCancelWorkoutIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINCarCommandsDomainHandling

Interface combining several interfaces related to various car-related intents.

IINCarPlayDomainHandling

Interface combining several interfaces related to various CarPlay intents.

IINCreateNoteIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINCreateTaskListIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINDeleteTasksIntentHandling

This interface represents the Objective-C protocol INDeleteTasksIntentHandling.

IINEditMessageIntentHandling

This interface represents the Objective-C protocol INEditMessageIntentHandling.

IINEndWorkoutIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINGetAvailableRestaurantReservationBookingDefaultsIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINGetAvailableRestaurantReservationBookingsIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINGetCarLockStatusIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINGetCarPowerLevelStatusIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINGetCarPowerLevelStatusIntentResponseObserver

This interface represents the Objective-C protocol INGetCarPowerLevelStatusIntentResponseObserver.

IINGetRestaurantGuestIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINGetRideStatusIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINGetRideStatusIntentResponseObserver

Receives periodic updates on ride status.

IINGetUserCurrentRestaurantReservationBookingsIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINGetVisualCodeIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINHangUpCallIntentHandling

This interface represents the Objective-C protocol INHangUpCallIntentHandling.

IINIntentHandlerProviding

This interface represents the Objective-C protocol INIntentHandlerProviding.

IINListCarsIntentHandling

This interface represents the Objective-C protocol INListCarsIntentHandling.

IINListRideOptionsIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINMessagesDomainHandling

Interface combining several interfaces related to various Message-related intents.

IINNotebookDomainHandling

Composite interface for adopting all of lists and notes protocols.

IINPauseWorkoutIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINPayBillIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINPaymentsDomainHandling

Interface combining several interfaces related to various payment-related intents.

IINPhotosDomainHandling

Interface combining several interfaces related to various photo-related intents.

IINPlayMediaIntentHandling

This interface represents the Objective-C protocol INPlayMediaIntentHandling.

IINRadioDomainHandling

Interface combining several interfaces related to various radio-related intents.

IINRequestPaymentIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINRequestRideIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINResumeWorkoutIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINRidesharingDomainHandling

Interface combining several interfaces related to various ridesharing intents.

IINSaveProfileInCarIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINSearchCallHistoryIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINSearchForAccountsIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINSearchForBillsIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINSearchForMediaIntentHandling

This interface represents the Objective-C protocol INSearchForMediaIntentHandling.

IINSearchForMessagesIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINSearchForNotebookItemsIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINSearchForPhotosIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINSendMessageIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINSendPaymentIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINSendRideFeedbackIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINSetAudioSourceInCarIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINSetCarLockStatusIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINSetClimateSettingsInCarIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINSetDefrosterSettingsInCarIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINSetMessageAttributeIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINSetProfileInCarIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINSetRadioStationIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINSetSeatSettingsInCarIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINSetTaskAttributeIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINShareFocusStatusIntentHandling

This interface represents the Objective-C protocol INShareFocusStatusIntentHandling.

IINSnoozeTasksIntentHandling

This interface represents the Objective-C protocol INSnoozeTasksIntentHandling.

IINSpeakable

Interface defining attributes of utterances made or heard by Siri.

IINStartAudioCallIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINStartCallIntentHandling

This interface represents the Objective-C protocol INStartCallIntentHandling.

IINStartPhotoPlaybackIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINStartVideoCallIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINStartWorkoutIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINTransferMoneyIntentHandling

Interface to resolve, confirm and handle Siri requests for the corresponding action.

IINUnsendMessagesIntentHandling

This interface represents the Objective-C protocol INUnsendMessagesIntentHandling.

IINUpdateMediaAffinityIntentHandling

This interface represents the Objective-C protocol INUpdateMediaAffinityIntentHandling.

IINVisualCodeDomainHandling

Composite interface for adopting all of the visual codes protocols.

IINWorkoutsDomainHandling

Interface combining several interfaces related to various workout-related intents.

Enums

Name Description
INAccountType

Enumerates types of payment accounts.

INActivateCarSignalIntentResponseCode

Enumerates the results of an INActivateCarSignalIntent.

INAddMediaIntentResponseCode
INAddMediaMediaDestinationUnsupportedReason
INAddMediaMediaItemUnsupportedReason
INAddTasksIntentResponseCode

Enumerates results codes for the INAddTasksIntent.

INAddTasksTargetTaskListConfirmationReason
INAddTasksTemporalEventTriggerUnsupportedReason
INAmountType

Enumerates bill-amount types.

INAnswerCallIntentResponseCode
INAppendToNoteIntentResponseCode

Enumerates results codes for the INAppendToNoteIntent.

INBalanceType

Enumerates balance units.

INBillType

Enumerates common bills.

INBookRestaurantReservationIntentCode

Enumerates the results of an INBookRestaurantReservationIntent.

INCallAudioRoute
INCallCapability

Enumerates call capabilities.

INCallCapabilityOptions

Flagging enumeration of the types of calls supported by the device.

INCallDestinationType

Enumerates call destination types.

INCallRecordType

Enumerates the record types for audio or video calls.

INCallRecordTypeOptions

Flags that enumerate call types to search for.

INCancelRideIntentResponseCode

Enumerates results codes for the INCancelRideIntent.

INCancelWorkoutIntentResponseCode

Enumerates results codes for the INCancelWorkoutIntent.

INCarAirCirculationMode

Enumerates how air is circulated through the car.

INCarAudioSource

Enumerates inputs to the car sound system.

INCarChargingConnectorType
INCarDefroster

Enumerates defroster locations.

INCarSeat

Enumerates car seat positions.

INCarSignalOptions

Enumerates the manners in which a car can make itself known.

INConditionalOperator

Enumerates operators to be used with search predicates.

INCreateNoteIntentResponseCode

Enumerates results codes for the INCreateNoteIntent.

INCreateTaskListIntentResponseCode

Enumerates results codes for the INCreateTaskListIntent.

INDailyRoutineSituation
INDateSearchType

Enumerates date types for a search.

INDayOfWeekOptions
INDeleteTasksIntentResponseCode
INDeleteTasksTaskListUnsupportedReason
INDeleteTasksTaskUnsupportedReason
INEditMessageIntentResponseCode
INEndWorkoutIntentResponseCode

Enumerates results codes for the INEndWorkoutIntent.

INFocusStatusAuthorizationStatus
INGetAvailableRestaurantReservationBookingDefaultsIntentResponseCode

Enumerates results codes for the INGetAvailableRestaurantReservationBookingDefaultsIntent.

INGetAvailableRestaurantReservationBookingsIntentCode

Enumerates results codes for the INGetAvailableRestaurantReservationBookingsIntent.

INGetCarLockStatusIntentResponseCode

Enumerates the results of an INGetCarLockStatusIntent.

INGetCarPowerLevelStatusIntentResponseCode

Enumerates the results of an INGetCarPowerLevelStatusIntent.

INGetReservationDetailsIntentResponseCode
INGetRestaurantGuestIntentResponseCode

Enumerates results codes for the INGetRestaurantGuestIntent.

INGetRideStatusIntentResponseCode

Enumerates results codes for the INGetRideStatusIntent.

INGetUserCurrentRestaurantReservationBookingsIntentResponseCode

Enumerates results codes for the INGetUserCurrentRestaurantReservationBookingsIntent.

INGetVisualCodeIntentResponseCode

Enumerates results codes for the INGetVisualCodeIntent.

INHangUpCallIntentResponseCode
INIntentErrorCode

Enumerates errors associated with Intents / SiriKit.

INIntentHandlingStatus

Enumerates the state of an intent handling response.

INIntentIdentifier

Enumerates Intents / SiriKit intent types.

INInteractionDirection

Enumerates the direction of information flow relative to the device.

INListCarsIntentResponseCode
INListRideOptionsIntentResponseCode

Enumerates results codes for the INListRideOptionsIntent.

INLocationSearchType

Enumerates ___location-based search types.

INMediaAffinityType
INMediaDestinationType
INMediaItemType
INMediaReference
INMediaSortOrder
INMediaUserContextSubscriptionStatus
INMessageAttribute

Enumerates the attributes of a message.

INMessageAttributeOptions

Enumerates the statuses of a message.

INMessageReactionType
INMessageType

Enumerates message content types.

INNotebookItemType

Enumerates notebook item types to include in search results.

INNoteContentType

Enumerates note content types.

INOutgoingMessageType
INPauseWorkoutIntentResponseCode

Enumerates results codes for the INPauseWorkoutIntent.

INPayBillIntentResponseCode

Enumerates the results of an INPayBillIntent.

INPaymentMethodType

Enumeates payment categories.

INPaymentStatus

Enumerates the states of a payment.

INPerson.INPersonType

This enum is used to select how to initialize a new instance of an INPerson.

INPersonHandleLabel

Enumerates the types of information associated with a particular value of a INPersonHandleType.

INPersonHandleType

Enumerates the types of values that are associated with a INPersonHandle.

INPersonRelationship

Enumerates known interpersonal relationships.

INPersonSuggestionType

Enumerates the source of the data for a INPerson (see SuggestionType).

INPhotoAttributeOptions

Enumerates various photo options.

INPlaybackQueueLocation
INPlaybackRepeatMode
INPlayMediaIntentResponseCode
INPlayMediaMediaItemUnsupportedReason
INPlayMediaPlaybackSpeedUnsupportedReason
INPriceRangeOption

Enumerates the minimum and maximum values of a price range.

INRadioType

Enumerates the types of radio supported by Intents.

INRecurrenceFrequency

Enumerates repetition frequencies.

INRelativeReference

Enumerates a qualitative sequential movement.

INRelativeSetting

Enumerates qualitative increases or decreased quantities.

INRelevantShortcutRole
INRequestPaymentCurrencyAmountUnsupportedReason

Enumerates reasons that a currency transfer amount is not supported.

INRequestPaymentIntentResponseCode

Enumerates results codes for the INRequestPaymentIntent.

INRequestPaymentPayerUnsupportedReason

Enumerates reasons that a payer could not be resolved.

INRequestRideIntentResponseCode

Enumerates results codes for the INRequestRideIntent.

INReservationActionType
INReservationStatus
INRestaurantReservationUserBookingStatus

Enumerates the status of a restaurant reservation.

INResumeWorkoutIntentResponseCode

Enumerates results codes for the INResumeWorkoutIntent.

INRideFeedbackTypeOptions

Enumerates feedback requirements for a ride.

INRidePhase

Enumerates the state of a ride in a vehicle.

INSaveProfileInCarIntentResponseCode

Enumerates results codes for the INSaveProfileInCarIntent.

INSearchCallHistoryIntentResponseCode

Enumerates results codes for the INSearchCallHistoryIntent.

INSearchForAccountsIntentResponseCode

Enumerates results codes for the INSearchForAccountsIntent.

INSearchForBillsIntentResponseCode

Enumerates the results of an INSearchForBillsIntent.

INSearchForMediaIntentResponseCode
INSearchForMediaMediaItemUnsupportedReason
INSearchForMessagesIntentResponseCode

Enumerates results codes for the INSearchForMessagesIntent.

INSearchForNotebookItemsIntentResponseCode

Enumerates results codes for the INSearchForNotebookItemsIntent.

INSearchForPhotosIntentResponseCode

Enumerates results codes for the INSearchForPhotosIntent.

INSendMessageIntentResponseCode

Enumerates results codes for the INSendMessageIntentResponse.

INSendMessageRecipientUnsupportedReason

Enumerates reasons that a recipient was not supported.

INSendPaymentCurrencyAmountUnsupportedReason

Enumerates reasons that a transaction amount was not supported.

INSendPaymentIntentResponseCode

Enumerates results codes for the INSendPaymentIntent.

INSendPaymentPayeeUnsupportedReason

Enumerates reason that a payee was not supported for a payment.

INSendRideFeedbackIntentResponseCode

Enumerates results codes for the INSendRideFeedbackIntent.

INSetAudioSourceInCarIntentResponseCode

Enumerates results codes for the INSetAudioSourceInCarIntent.

INSetCarLockStatusIntentResponseCode

Enumerates the results of an INSetCarLockStatusIntent.

INSetClimateSettingsInCarIntentResponseCode

Enumerates results codes for the INSetClimateSettingsInCarIntent.

INSetDefrosterSettingsInCarIntentResponseCode

Enumerates results codes for the INSetDefrosterSettingsInCarIntentResponseCode.

INSetMessageAttributeIntentResponseCode

Enumerates results codes for the INSetMessageAttributeIntent.

INSetProfileInCarIntentResponseCode

Enumerates results codes for the INSetProfileInCarIntent.

INSetRadioStationIntentResponseCode

Enumerates results codes for the INSetRadioStationIntent.

INSetSeatSettingsInCarIntentResponseCode

Enumerates results codes for the INSetSeatSettingsInCarIntent.

INSetTaskAttributeIntentResponseCode

Enumerates results codes for the INSetTaskAttributeIntent.

INSetTaskAttributeTemporalEventTriggerUnsupportedReason
INShareFocusStatusIntentResponseCode
INShortcutAvailabilityOptions
INSiriAuthorizationStatus

Enumerates the authorization of the developer's Intent.

INSnoozeTasksIntentResponseCode
INSnoozeTasksTaskUnsupportedReason
INSortType

Enumerates search result sort orders.

INSpatialEvent

Enumerates conditions for spatial event triggers.

INStartAudioCallIntentResponseCode

Enumerates results codes for the INStartAudioCallIntent.

INStartCallCallCapabilityUnsupportedReason
INStartCallCallRecordToCallBackUnsupportedReason
INStartCallContactUnsupportedReason
INStartCallIntentResponseCode
INStartPhotoPlaybackIntentResponseCode

Enumerates results codes for the INStartPhotoPlaybackIntent.

INStartVideoCallIntentResponseCode

Enumerates results codes for the INStartVideoCallIntent.

INStartWorkoutIntentResponseCode

Enumerates results codes for the INStartWorkoutIntent.

INStickerType
INTaskPriority
INTaskStatus

Enumerates task completion statuses.

INTaskType
INTemporalEventTriggerTypeOptions
INTicketedEventCategory
INTransferMoneyIntentResponseCode

Enumerates results codes for the INTransferMoneyIntent.

INUnsendMessagesIntentResponseCode
INUpcomingMediaPredictionMode
INUpdateMediaAffinityIntentResponseCode
INUpdateMediaAffinityMediaItemUnsupportedReason
INVisualCodeType

Enumerates visual code semantics.

INVocabularyStringType

Enumerates the kind of thing a INVocabulary string represents.

INWorkoutGoalUnitType

Enumerates the kind of goal the workout is striving for.

INWorkoutLocationType

Enumerates where the workout is occurring.

INWorkoutNameIdentifier

Enumerates known training types.

Delegates

Name Description
INVoiceShortcutCenterGetVoiceShortcutsHandler

Remarks

The Intents namespace (also referred to as Siri Kit) allows application developers to extend their applications to respond to Siri or Maps initiated user requests within predefined domains.

Intents app extensions are extension projects that extend INExtension and implement one or more other ___domain-specific interfaces (e.g., a message-handling extension might implement IINSendMessageIntentHandling, IINSearchForMessagesIntentHandling, and IINSetMessageAttributeIntentHandling). If the extension requires a custom interface, the developer should use the classes in IntentsUI to create a user-experience presented by Siri or the Maps subsystem.

"Intents" are user requests recognized by Siri or Maps that may be handled by custom extensions. Only certain problem domains are supported:

DomainInterfaces
Voice over IP calls IINCallsDomainHandling, IINSearchCallHistoryIntentHandling, IINStartAudioCallIntentHandling, IINStartVideoCallIntentHandling
Messaging IINMessagesDomainHandling, IINSearchForMessagesIntentHandling, IINSendMessageIntentHandling, IINSetMessageAttributeIntentHandling
Payments IINPaymentsDomainHandling, IINRequestPaymentIntentHandling, IINSendPaymentIntentHandling
Photos IINPhotosDomainHandling, IINSearchForPhotosIntentHandling, IINStartPhotoPlaybackIntentHandling
Workouts IINCancelWorkoutIntentHandling, IINEndWorkoutIntentHandling, IINPauseWorkoutIntentHandling, IINResumeWorkoutIntentHandling, IINStartWorkoutIntentHandling, IINWorkoutsDomainHandling
Booking a ride IINGetRideStatusIntentHandling, IINGetRideStatusIntentResponseObserver, IINListRideOptionsIntentHandling, IINRequestRideIntentHandling, IINRidesharingDomainHandling
CarPlay (restricted to automotive vendors) IINCarPlayDomainHandling, IINRadioDomainHandling, IINSaveProfileInCarIntentHandling, IINSetAudioSourceInCarIntentHandling, IINSetClimateSettingsInCarIntentHandling, IINSetDefrosterSettingsInCarIntentHandling, IINSetProfileInCarIntentHandling, IINSetRadioStationIntentHandling, IINSetSeatSettingsInCarIntentHandling
Restaurant reservations (restricted to Apple partners) IINBookRestaurantReservationIntentHandling, IINGetAvailableRestaurantReservationBookingDefaultsIntentHandling, IINGetAvailableRestaurantReservationBookingsIntentHandling, IINGetRestaurantGuestIntentHandling, IINGetUserCurrentRestaurantReservationBookingsIntentHandling

Interfaces named IIN{IntentName}IntentHandling define methods typically named Handle{IntentName} that receive a subclass of INIntent and a completion handler that the developer should call before exiting the function:

// Handle the "send message" intent
public void HandleSendMessage (INSendMessageIntent intent, Action<INSendMessageIntentResponse> completion)
{
    // Implement your application logic to send a message here.

    var userActivity = new NSUserActivity (nameof (INSendMessageIntent));
    var response = new INSendMessageIntentResponse (INSendMessageIntentResponseCode.Success, userActivity);
    completion (response);
}    

Any application that interacts with Siri must fulfill certain privacy requirements:

  • A provisioning profile configured for Siri Kit (requires explicit bundle identifier):
  • A bundle identifier that matches the provisioning profile:
  • A boolean entry in Entitlements.plist with key com.apple.developer.siri (XML: <key>com.apple.developer.siri</key> <true/>):
  • A string entry in Info.plist for "Privacy - Siri Usage Description" (XML: <key>NSSiriUsageDescription</key> <string>Justification for Siri</string>):

Additionally, within the extension project's info.plist, the developer must add a dict called NSExtension that contains:

KeyValue
NSExtensionPointIdentifier com.apple.intents-service
NSExtensionPrincipalClassThe value of the RegisterAttribute of the extension's INExtension.
NSExtensionAttributesA dict that contains the key IntentsSupported that contains an array of strings whose values contain the names of the Intents it may handle.

For instance, an extension that works with messages, whose main class is defined as:

[Register ("MyIntentHandler")]
public class MyIntentHandler : INExtension, IINSendMessageIntentHandling, IINSearchForMessagesIntentHandling, IINSetMessageAttributeIntentHandling
{
//...etc...
}

Might have the following in its Info.plist

<key>NSExtension</key>
<dict>
<key>NSExtensionAttributes</key>
<dict>
<key>IntentsRestrictedWhileLocked</key>
<array/>
<key>IntentsSupported</key>
<array>
<string>INSendMessageIntent</string>
<string>INSearchForMessagesIntent</string>
<string>INSetMessageAttributeIntent</string>
</array>
</dict>
<key>NSExtensionPointIdentifier</key>
<string>com.apple.intents-service</string>
<key>NSExtensionPrincipalClass</key>
<string>MyIntentHandler</string>
</dict>

If the Extension project requires more than the standard entitlements and thereby require an explicit App ID, the extension project must have its own provisioning profile with the needed entitlements. For instance, an extension in the Workout ___domain will probably require a HealthKit entitlement, which would require separate provisioning profiles for the phone app and for the extension. (If the workout solution also involves a WatchOS extension that tracks the workout, the Watch extension and Watch app also need their own separate provisioning profiles with their explicit app ids.)