An object that represents a custom intent parameter.


class INObject : NSObject


Use INObject to create an instance of an intent parameter that you define as type Custom in your Intent Definition file.

Figure 1

Intent parameters soup and options defined as type Custom

Screenshot showing soup and options defined in the Intent Definition file from the Soup Chef sample code project.


Creating an Intent Parameter Object

init(identifier: String?, display: String)

Creates a custom parameter object with the specified identifier and display string.

init(identifier: String?, display: String, pronunciationHint: String?)

Creates a custom parameter object with the specified identifier, display string, and pronunciation hint.

Getting the Identifier

var identifier: String?

A string that identifies the custom parameter object within your app.

Getting the Display String

var displayString: String

A string that Siri displays that describes the parameter.

Getting the Pronunciation Hint

var pronunciationHint: String?

A pronunciation hint for the custom parameter in a “sounds like” format.

See Also


Donating Shortcuts

Tell Siri about shortcuts to actions that the user performed in your app.

Deleting Donated Shortcuts

Remove your donations from Siri.

Soup Chef: Accelerating App Interactions with Shortcuts

Make it easy for people to use Siri with your app by providing shortcuts to your app’s actions.

Shortcut Management

Enable users to add shortcuts to Siri, and have your app suggest shortcuts to users.

Relevant Shortcuts

Display shortcuts on the Siri watch face.

Media Intent Shortcuts

Provide a convenient way for users to listen to and watch media content from your app with shortcuts.

enum INShortcut

An action available in your app that the system may suggest to a user or a user may add to Siri.

class INInteraction

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