Intents Namespace

The Intents namespace supports Siri-related app extensions.

Classes

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

Optional methods of the IINActivateCarSignalIntentHandling interface.

INActivateCarSignalIntentResponse

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

INAddTasksIntent

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

INAddTasksIntentHandling_Extensions

Optional methods for the IINAddTasksIntentHandling interface.

INAddTasksIntentResponse

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

INAppendToNoteIntent

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

INAppendToNoteIntentHandling_Extensions

Optional methods for the IINAppendToNoteIntentHandling interface.

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.

INBookRestaurantReservationIntent

INIntentResolutionResult for resolving parameters in reservation-related interactions.

INBookRestaurantReservationIntentHandling_Extensions

Optional methods of the IINBookRestaurantReservationIntentHandling interface.

INBookRestaurantReservationIntentResponse

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

INBooleanResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving true or false arguments.

INCallDestinationTypeResolutionResult

INIntentResolutionResult for resolving parameters in interactions related to call destinations.

INCallRecord

Information about a past call.

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

Optional methods for the IINCancelRideIntentHandling interface.

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

Optional methods for the IINCancelWorkoutIntentHandling interface.

INCancelWorkoutIntentResponse

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

INCarAirCirculationModeResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving air conditioning.

INCarAudioSourceResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving car audio systems.

INCarDefrosterResolutionResult

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

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

Optional methods for the IINCreateNoteIntentHandling interface.

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

Optional methods for the IINCreateTaskListIntentHandling interface.

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

Encapsulates date components for a timespan.

INDateComponentsRangeResolutionResult

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

INDateComponentsResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving dates.

INDateRelevanceProvider
INDateSearchTypeResolutionResult
INDefaultCardTemplate
INDoubleResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving floating-point numbers.

INEndWorkoutIntent

An INIntent indicating the user wishes to finish the workout.

INEndWorkoutIntentHandling_Extensions

Optional methods for the IINEndWorkoutIntentHandling interface.

INEndWorkoutIntentResponse

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

INExtension

Base class for Intent extensions.

INGetAvailableRestaurantReservationBookingDefaultsIntent

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

INGetAvailableRestaurantReservationBookingDefaultsIntentHandling_Extensions

Optional methods of the IINGetAvailableRestaurantReservationBookingDefaultsIntentHandling interface.

INGetAvailableRestaurantReservationBookingDefaultsIntentResponse

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

INGetAvailableRestaurantReservationBookingsIntent

An intention to retrieve restaurant availability.

INGetAvailableRestaurantReservationBookingsIntentHandling_Extensions

Optional methods of the IINGetAvailableRestaurantReservationBookingsIntentHandling interface.

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

Optional methods of the IINGetCarLockStatusIntentHandling interface.

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

Optional methods of the IINGetCarPowerLevelStatusIntentHandling interface.

INGetCarPowerLevelStatusIntentResponse

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

INGetRestaurantGuestIntent

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

INGetRestaurantGuestIntentHandling_Extensions

Optional methods of the IINGetRestaurantGuestIntentHandling interface.

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

Optional methods for the IINGetRideStatusIntentHandling interface.

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

Optional methods for the IINGetUserCurrentRestaurantReservationBookingsIntentHandling interface.

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

Optional methods for the IINGetVisualCodeIntentHandling interface.

INGetVisualCodeIntentResponse

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

INImage

Encapsulates image data to be used in a intent response.

INImageNoteContent

Represents an image within a note.

INIntegerResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving whole numbers.

INIntent

A user-meaningful intention that is handled by the system's Intents system.

INIntentErrorCodeExtensions

Extension methods for the Intents.INIntentErrorCode enumeration.

INIntentIdentifierExtensions

Extensions methods for INIntentIdentifier.

INIntentResolutionResult

T:Intent.INIntent

INIntentResolutionResult<ObjectType>

INIntentResolutionResult parameterized to the expected subclass.

INIntentResponse

Abstract base class for the developer's response to a INIntent request.

INInteraction

Encapsulates the interaction between Intents / SiriKit and the developer's application.

INListRideOptionsIntent

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

INListRideOptionsIntentHandling_Extensions

Optional methods of the IINListRideOptionsIntentHandling interface.

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.

INMediaItem
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.

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
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

Optional methods of the IINPauseWorkoutIntentHandling interface.

INPauseWorkoutIntentResponse

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

INPayBillIntent

An INIntent for paying a bill.

INPayBillIntentHandling_Extensions

Optional methods of the IINPayBillIntentHandling interface.

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.

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 class.

INPersonResolutionResult

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

INPlacemarkResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving named locations.

INPlayMediaIntent
INPlayMediaIntentHandling_Extensions
INPlayMediaIntentResponse
INPreferences

Preferences and authorization for Intents / SiriKit.

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
INRequestPaymentCurrencyAmountResolutionResult

INIntentResolutionResult for resolving parameters in currency-related interactions.

INRequestPaymentIntent

An INIntent indicating the user wishes to request a payment.

INRequestPaymentIntentHandling_Extensions

Optional methods of the IINRequestPaymentIntentHandling interface.

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

Optional methods for the IINRequestRideIntentHandling interface.

INRequestRideIntentResponse

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

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.

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

Optional methods of the IINResumeWorkoutIntentHandling interface.

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

Optional methods of the IINSaveProfileInCarIntentHandling interface.

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

Optional methods of the IINSearchCallHistoryIntentHandling interface.

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

Optional methods for the IINSearchForAccountsIntentHandling interface.

INSearchForAccountsIntentResponse

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

INSearchForBillsIntent

An INIntent for locating bills.

INSearchForBillsIntentHandling_Extensions

Optional methods of the IINSearchForBillsIntentHandling interface.

INSearchForBillsIntentResponse

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

INSearchForMessagesIntent

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

INSearchForMessagesIntentHandling_Extensions

Optional methods of the IINSearchForMessagesIntentHandling interface.

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

Optional methods for the IINSearchForNotebookItemsIntentHandling interface.

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

Optional methods of the IINSearchForPhotosIntentHandling interface.

INSearchForPhotosIntentResponse

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

INSendMessageIntent

An INIntent indicating the user wishes to send a message.

INSendMessageIntentHandling_Extensions

Optional methods of the IINSendMessageIntentHandling interface.

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

Optional methods for the IINSendPaymentIntentHandling interface.

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

Optional methods for the IINSendRideFeedbackIntentHandling interface.

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

Optional methods of the IINSetAudioSourceInCarIntentHandling interface.

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

Optional methods of the IINSetCarLockStatusIntentHandling interface.

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

Optional methods for the IINSetClimateSettingsInCarIntentHandling interface.

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

Optional methods of the IINSetDefrosterSettingsInCarIntentHandling interface.

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

Optional methods of the IINSetMessageAttributeIntentHandling interface.

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

Optional methods for the IINSetProfileInCarIntentHandling interface.

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

Optional methods of the IINSetRadioStationIntentHandling 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

Optional methods of the IINSetSeatSettingsInCarIntentHandling 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

Optional methods for the IINSetTaskAttributeIntentHandling interface.

INSetTaskAttributeIntentResponse

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

INShortcut
INSpatialEventTrigger
INSpatialEventTriggerResolutionResult

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

INSpeakable_Extensions

Extension methods that provide default implementations for the required methods of the IINSpeakable protocol.

INSpeakableString

An utterance available in a custom vocabulary.

INSpeakableStringResolutionResult

INIntentResolutionResult for resolving parameters in interactions involving arbitrary strings.

INStartAudioCallIntent

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

INStartAudioCallIntentHandling_Extensions

Optional methods for the IINStartAudioCallIntentHandling interface.

INStartAudioCallIntentResponse

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

INStartPhotoPlaybackIntent

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

INStartPhotoPlaybackIntentHandling_Extensions

Default implementation of optional methods of the IINStartPhotoPlaybackIntentHandling 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

Default implementation of optional methods of the IINStartVideoCallIntentHandling 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

Default implementation of optional methods of the IINStartWorkoutIntentHandling protocol.

INStartWorkoutIntentResponse

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

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.

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.

INTermsAndConditions

Holds terms and conditions relevant to restaurant reservations.

INTextNoteContent

The text of a note.

INTransferMoneyIntent

An INIntent indicating the user wishes to transfer funds.

INTransferMoneyIntentHandling_Extensions

Optional methods for the IINTransferMoneyIntentHandling interface.

INTransferMoneyIntentResponse

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

INUpcomingMediaManager
INVisualCodeTypeResolutionResult

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

INVocabulary

A customized vocabulary for interacting with Siri. Supports both application and user-specific vocabularies.

INVoiceShortcut
INVoiceShortcutCenter
INWorkoutGoalUnitTypeResolutionResult

INIntentResolutionResult for resolving parameters in workout-related interactions.

INWorkoutLocationTypeResolutionResult

INIntentResolutionResult for resolving parameters in workout-related interactions.

INWorkoutNameIdentifierExtensions

Extension methods for the INWorkoutNameIdentifier class.

NSUserActivity_IntentsAdditions

Optional methods for the NSUserActivity interface.

Interfaces

IINActivateCarSignalIntentHandling

Interface defining handler method that, when implemented, must call completion with an INActivateCarSignalIntentResponse appropriate to the intent.

IINAddTasksIntentHandling

Interface defining handler method that, when implemented, must call completion with an INAddTasksIntentResponse appropriate to arg.

IINAppendToNoteIntentHandling

Interface defining handler method that, when implemented, must call completion with an INAppendToNoteIntentResponse appropriate to arg.

IINBookRestaurantReservationIntentHandling

Interface defining handler method that, when implemented, must call completion with an INBookRestaurantReservationIntentResponse appropriate to arg.

IINCallsDomainHandling

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

IINCancelRideIntentHandling

Interface defining handler method that, when implemented, must call completion with an INCancelRideIntentResponse appropriate to arg.

IINCancelWorkoutIntentHandling

Interface defining handler method that, when implemented, must call completion with an INCancelWorkoutIntentResponse appropriate to arg.

IINCarCommandsDomainHandling

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

IINCarPlayDomainHandling

Interface combining several interfaces related to various CarPlay intents.

IINCreateNoteIntentHandling

Interface defining handler method that, when implemented, must call completion with an INCreateNoteIntentResponse appropriate to arg.

IINCreateTaskListIntentHandling

Interface defining handler method that, when implemented, must call completion with an INAddTasksIntentResponse appropriate to arg.

IINEndWorkoutIntentHandling

Interface defining handler method that, when implemented, must call completion with an INEndWorkoutIntentResponse appropriate to arg.

IINGetAvailableRestaurantReservationBookingDefaultsIntentHandling

Interface defining handler method that, when implemented, must call completion with an INGetAvailableRestaurantReservationBookingDefaultsIntentResponse appropriate to the intent.

IINGetAvailableRestaurantReservationBookingsIntentHandling

Interface defining handler method that, when implemented, must call completion with an INGetAvailableRestaurantReservationBookingsIntentResponse appropriate to arg.

IINGetCarLockStatusIntentHandling

Interface defining handler method that, when implemented, must call completion with an INGetCarLockStatusIntentResponse appropriate to the intent.

IINGetCarPowerLevelStatusIntentHandling

Interface defining handler method that, when implemented, must call completion with an INGetCarPowerLevelStatusIntentResponse appropriate to the intent.

IINGetRestaurantGuestIntentHandling

Interface defining handler method that, when implemented, must call completion with an INGetRestaurantGuestIntentResponse appropriate to arg.

IINGetRideStatusIntentHandling

Interface defining handler method that, when implemented, must call completion with an INGetRideStatusIntentResponse appropriate to arg.

IINGetRideStatusIntentResponseObserver

Receives periodic updates on ride status.

IINGetUserCurrentRestaurantReservationBookingsIntentHandling

Interface defining handler method that, when implemented, must call completion with an INGetUserCurrentRestaurantReservationBookingsIntentResponse appropriate to arg.

IINGetVisualCodeIntentHandling

Interface defining handler method that, when implemented, must call completion with an INGetVisualCodeIntentResponse appropriate to arg.

IINIntentHandlerProviding

Defines the M:Intents.IINIntentHandlerProvider* interface implemented by INExtension.

IINListRideOptionsIntentHandling

Interface defining handler method that, when implemented, must call completion with an INListRideOptionsIntentResponse appropriate to arg.

IINMessagesDomainHandling

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

IINNotebookDomainHandling

Composite interface for adopting all of lists and notes protocols.

IINPauseWorkoutIntentHandling

Interface defining handler method that, when implemented, must call completion with an INPauseWorkoutIntentResponse appropriate to arg.

IINPayBillIntentHandling

Interface defining handler method that, when implemented, must call completion with an INPayBillIntentResponse appropriate to the intent.

IINPaymentsDomainHandling

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

IINPhotosDomainHandling

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

IINPlayMediaIntentHandling
IINRadioDomainHandling

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

IINRequestPaymentIntentHandling

Interface defining handler method that, when implemented, must call completion with an INRequestPaymentIntentResponse appropriate to arg.

IINRequestRideIntentHandling

Interface defining handler method that, when implemented, must call completion with an INRequestRideIntentResponse appropriate to arg.

IINResumeWorkoutIntentHandling

Interface defining handler method that, when implemented, must call completion with an INResumeWorkoutIntentResponse appropriate to arg.

IINRidesharingDomainHandling

Interface combining several interfaces related to various ridesharing intents.

IINSaveProfileInCarIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSaveProfileInCarIntentResponse appropriate to arg.

IINSearchCallHistoryIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSearchCallHistoryIntentResponse appropriate to arg.

IINSearchForAccountsIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSearchForAccountsIntentResponse appropriate to arg.

IINSearchForBillsIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSearchForBillsIntentResponse appropriate to the intent.

IINSearchForMessagesIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSearchForMessagesIntentResponse appropriate to arg.

IINSearchForNotebookItemsIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSearchForNotebookItemsIntentResponse appropriate to arg.

IINSearchForPhotosIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSearchForPhotosIntentResponse appropriate to arg.

IINSendMessageIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSendMessageIntentResponse appropriate to arg.

IINSendPaymentIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSendPaymentIntentResponse appropriate to arg.

IINSendRideFeedbackIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSendRideFeedbackIntentResponse appropriate to arg.

IINSetAudioSourceInCarIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSetAudioSourceInCarIntentResponse appropriate to arg.

IINSetCarLockStatusIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSetCarLockStatusIntentResponseCode appropriate to the intent.

IINSetClimateSettingsInCarIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSetClimateSettingsInCarIntentResponse appropriate to arg.

IINSetDefrosterSettingsInCarIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSetDefrosterSettingsInCarIntentResponse appropriate to arg.

IINSetMessageAttributeIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSetMessageAttributeIntentResponse appropriate to arg.

IINSetProfileInCarIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSetProfileInCarIntentResponse appropriate to arg.

IINSetRadioStationIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSetRadioStationIntentResponse appropriate to arg.

IINSetSeatSettingsInCarIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSetSeatSettingsInCarIntentResponse appropriate to arg.

IINSetTaskAttributeIntentHandling

Interface defining handler method that, when implemented, must call completion with an INSetTaskAttributeIntentResponse appropriate to arg.

IINSpeakable

Interface defining attributes of utterances made or heard by Siri.

IINStartAudioCallIntentHandling

Interface defining handler method that, when implemented, must call completion with an INStartAudioCallIntentResponse appropriate to arg.

IINStartPhotoPlaybackIntentHandling

Interface defining handler method that, when implemented, must call completion with an INStartPhotoPlaybackIntentResponse appropriate to arg.

IINStartVideoCallIntentHandling

Interface defining handler method that, when implemented, must call completion with an INStartVideoCallIntentResponse appropriate to arg.

IINStartWorkoutIntentHandling

Interface defining handler method that, when implemented, must call completion with an INStartWorkoutIntentResponse appropriate to arg.

IINTransferMoneyIntentHandling

Interface defining handler method that, when implemented, must call completion with an INTransferMoneyIntentResponse appropriate to arg.

IINVisualCodeDomainHandling

Composite interface for adopting all of the visual codes protocols.

IINWorkoutsDomainHandling

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

Enums

INAccountType

Enumerates types of payment accounts.

INActivateCarSignalIntentResponseCode

Enumerates the results of an INActivateCarSignalIntent.

INAddTasksIntentResponseCode

Enumerates results codes for the INAddTasksIntent.

INAmountType

Enumerates bill-amount types.

INAppendToNoteIntentResponseCode

Enumerates results codes for the INAppendToNoteIntent.

INBalanceType

Enumerates balance units.

INBillType

Enumerates common bills.

INBookRestaurantReservationIntentCode

Enumerates the results of an INBookRestaurantReservationIntent.

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.

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.

INEndWorkoutIntentResponseCode

Enumerates results codes for the INEndWorkoutIntent.

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.

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.

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.

INListRideOptionsIntentResponseCode

Enumerates results codes for the INListRideOptionsIntent.

INLocationSearchType

Enumerates location-based search types.

INMediaItemType
INMessageAttribute

Enumerates the attributes of a message.

INMessageAttributeOptions

Enumerates the statuses of a message.

INMessageType

Enumerates message content types.

INNotebookItemType

Enumerates notebook item types to include in search results.

INNoteContentType

Enumerates note content types.

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.

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.

INPlaybackRepeatMode
INPlayMediaIntentResponseCode
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.

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.

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.

INSiriAuthorizationStatus

Enumerates the authorization of the developer's Intent.

INSortType

Enumerates search result sort orders.

INSpatialEvent

Enumerates conditions for spatial event triggers.

INStartAudioCallIntentResponseCode

Enumerates results codes for the INStartAudioCallIntent.

INStartPhotoPlaybackIntentResponseCode

Enumerates results codes for the INStartPhotoPlaybackIntent.

INStartVideoCallIntentResponseCode

Enumerates results codes for the INStartVideoCallIntent.

INStartWorkoutIntentResponseCode

Enumerates results codes for the INStartWorkoutIntent.

INTaskStatus

Enumerates task completion statuses.

INTaskType
INTransferMoneyIntentResponseCode

Enumerates results codes for the INTransferMoneyIntent.

INUpcomingMediaPredictionMode
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

INVoiceShortcutCenterGetVoiceShortcutsHandler

Remarks

Introduced in iOS 10, 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 T:Intents.MessagesDomainHandling , IINSearchForMessagesIntentHandling, IINSendMessageIntentHandling, , T:Intents.SetMessageAttributeIntentHandling
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.)