Class

INParameter

A parameter of an interaction object.

Declaration

@interface INParameter : NSObject

Overview

Use a parameter object to identify a property of an INInteraction object. To fetch the value of the property, use the parameterValueForParameter: method of the INInteraction object.

You use parameters when configuring a custom user interface for your Siri or Maps interactions. SiriKit passes parameter objects to you during the configuration of your interface. When configuring your interface, you can also create parameter objects to represent properties that you display in addition to the ones that SiriKit provides.

Topics

Creating a Parameter Object

+ parameterForClass:keyPath:

Creates a new parameter object using the specified key path and class information.

Getting the Parameter Details

parameterKeyPath

The key path to a property of an interaction object.

parameterClass

The type of object represented by this parameter.

Managing Indexed Values

- indexForSubKeyPath:

The index into the array at the specified portion of the key path.

- setIndex:forSubKeyPath:

Specifies which item of an array or ordered set to use for the parameter.

Comparing Parameters

- isEqualToParameter:

Returns a Boolean value indicating whether the specified parameter object represents the same property as the current parameter object.

Relationships

Inherits From

See Also

Custom UI

INUIHostedViewControlling

Methods for presenting custom content in the Siri and Maps interfaces.

INUIHostedViewSiriProviding

Methods for hiding portions of the default interfaces that Siri provides.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software