Instance Property

userActivity

The user activity object to use when launching the app.

Declaration

@property(copy, readwrite, nonatomic) NSUserActivity *userActivity;

Discussion

When initializing a response object, you can provide a custom user activity object with details about your response. You might specify a custom object when you want to customize the activity type string, add details to the userInfo dictionary, or customize any other properties of the NSUserActivity object.

If SiriKit determines that it needs to launch your app, either to handle the intent or respond to errors, it launches your app and delivers your user activity object. (Prior to delivery, SiriKit fills the interaction property of the user activity object with the intent and your response.) In your app, use the information in the provided user activity object to take whatever actions are appropriate.

If the value of this property is nil, SiriKit creates a default user activity object and sets the activityType property to the name of the intent class that was handled. As with a custom user activity object, SiriKit fills the interaction property of the object with the intent and your response.