Class

INInteraction

An interaction between the user and your app involving an intent object.

Declaration

@interface 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 NSUserActivity 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 donateInteractionWithCompletion: method. You can also use the methods of this class to delete interactions when they are no longer relevant.

Topics

Creating an Interaction Object

- initWithIntent:response:

Initializes and returns an interaction object with an intent object and your app’s response.

Getting the Intent and Response

intent

The intent object that describes the user’s request.

intentResponse

The response object that your app created in response to the request.

Donating Interactions to the System

- donateInteractionWithCompletion:

Donates this interaction object to the system.

Deleting Interactions from the System

+ deleteAllInteractionsWithCompletion:

Deletes all interactions that you donated previously.

+ deleteInteractionsWithIdentifiers:completion:

Deletes the specified interactions that were donated by the calling app.

+ deleteInteractionsWithGroupIdentifier:completion:

Deletes the interactions with the specified group identifier.

Accessing Interaction Attributes

intentHandlingStatus

The current state of the interaction.

direction

The direction in which information flowed to or from the device.

dateInterval

The time at which the interaction started and its duration.

identifier

The unique identifier of the interaction.

groupIdentifier

The unique identifier of the interaction’s group.

Getting the Value of a Parameter

- parameterValueForParameter:

Returns the value of the specified parameter of this interaction object.

Constants

INIntentHandlingStatus

Constants indicating the current state of the interaction.

INInteractionDirection

Constants indicating whether the app is providing or receiving information.

Relationships

Inherits From

See Also

Common Objects

Common Data Types

Manage common data types such as strings, dates, currencies, images, and contacts.

Common Resolution Results

Resolve common types of data like strings and dates into specific values that your app recognizes.

Intent Class Identifiers

Identify intents specified by user notifications.