summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h
blob: 8c03f2ecac18cc592b9760b6d8f0d060491198ce (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
//  SDLDeleteInteractionChoiceSet.h
//


#import "SDLRPCRequest.h"

/**
 * Deletes an existing Choice Set identified by the parameter
 * interactionChoiceSetID. If the specified interactionChoiceSetID is currently
 * in use by an active <i> SDLPerformInteraction</i> this call to
 * delete the Choice Set will fail returning an IN_USE resultCode
 * <p>
 * Function Group: Base
 * <p>
 * <b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b><br/>
 * </p>
 *
 * Since <b>SmartDeviceLink 1.0</b><br>
 * see SDLCreateInteractionChoiceSet SDLPerformInteraction
 */

NS_ASSUME_NONNULL_BEGIN

@interface SDLDeleteInteractionChoiceSet : SDLRPCRequest

- (instancetype)initWithId:(UInt32)choiceId;

/**
 * @abstract a unique ID that identifies the Choice Set
 * @discussion a unique ID that identifies the Choice Set
 * <p>
 * <b>Notes: </b>Min Value: 0; Max Value: 2000000000
 */
@property (strong, nonatomic) NSNumber<SDLInt> *interactionChoiceSetID;

@end

NS_ASSUME_NONNULL_END