An interaction between the user and your app involving an intent object.
SDKs
- iOS 10.0+
- Mac Catalyst 13.0+
- watchOS 3.2+
Framework
- Intents
Declaration
class INInteraction : NSObject
Overview
An INInteraction
object encapsulates information about a SiriKit request and your app’s response. SiriKit creates interaction objects automatically when it needs to launch your app to facilitate the handling of, or respond to errors involving, a specific intent. The interaction object is placed in the NSUser
object that the system passes to your app at launch time. You can also create instances of this class in your app and donate relevant interactions to the system.
Donating interactions is a way to provide contextual information that might be helpful to other apps. Some system apps use donated interactions to improve search results or to anticipate user actions. For example, a ride-booking app could donate an interaction containing the user’s planned ride information. If the user subsequently uses the Maps app to search for restaurants, Maps can show relevant results near the user’s destination.
You choose which of your app’s interactions you want to donate to the system. To donate an interaction, create an instance of this class, filling it with your intent object and response, and call the donate(completion:)
method. You can also use the methods of this class to delete interactions when they are no longer relevant.
Note
Donate interactions only from your app. Do not donate them from your intents app extension. SiriKit already knows about interactions handled by your extension.