SDLCreateInteractionChoiceSet Class Reference

Section Contents

Overview

Creates a Choice Set which can be used in subsequent SDLPerformInteraction Operations.

HMILevel needs to be FULL, LIMITED or BACKGROUND

Before a perform interaction is sent you MUST wait for the success from the CreateInteractionChoiceSet RPC.

If you do not wait the system may not recognize the first utterance from the user.

@since SDL 1.0

See

SDLDeleteInteractionChoiceSet SDLPerformInteraction

-initWithId:choiceSet:

Convenience init for creating a choice set RPC

Objective-C

- (nonnull instancetype)initWithId:(UInt32)choiceId
                         choiceSet:(nonnull NSArray<SDLChoice *> *)choiceSet;

Swift

init(id choiceId: UInt32, choiceSet: [SDLChoice])

Parameters

choiceId

A unique ID that identifies the Choice Set

choiceSet

Array of choices, which the user can select by menu or voice recognition

Return Value

An SDLCreateInteractionChoiceSet object

interactionChoiceSetID

A unique ID that identifies the Choice Set

Required, Integer, 0 - 2,000,000,000

Objective-C

@property (nonatomic, strong) NSNumber<SDLInt> *_Nonnull interactionChoiceSetID;

Swift

var interactionChoiceSetID: NSNumber & SDLInt { get set }

choiceSet

Array of choices, which the user can select by menu or voice recognition

Required, SDLChoice, Array size 1 - 100

Objective-C

@property (nonatomic, strong) NSArray<SDLChoice *> *_Nonnull choiceSet;

Swift

var choiceSet: [SDLChoice] { get set }