summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLCreateInteractionChoiceSet.h
blob: 80ae3e9a94a2223b9697159f3fd32cc01fde878f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
//  SDLCreateInteractionChoiceSet.h
//


#import "SDLRPCRequest.h"

@class SDLChoice;

/**
 * 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
 */
NS_ASSUME_NONNULL_BEGIN

@interface SDLCreateInteractionChoiceSet : SDLRPCRequest

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

/**
 * @abstract A unique ID that identifies the Choice Set
 *
 * Required, Integer, 0 - 2,000,000,000
 */
@property (strong, nonatomic) NSNumber<SDLInt> *interactionChoiceSetID;

/**
 * @abstract Array of choices, which the user can select by menu or voice recognition
 *
 * Required, SDLChoice, Array size 1 - 100
 */
@property (strong, nonatomic) NSArray<SDLChoice *> *choiceSet;

@end

NS_ASSUME_NONNULL_END