summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLPerformInteractionResponse.h
blob: 6f9b40459428f4321b502a77f2489b1f67fba5e5 (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
//  SDLPerformInteractionResponse.h
//


#import "SDLRPCResponse.h"

#import "SDLTriggerSource.h"

/**
 * PerformInteraction Response is sent, when SDLPerformInteraction has been called
 *
 * @since SDL 1.0
 */
@interface SDLPerformInteractionResponse : SDLRPCResponse

/**
 * @abstract ID of the choice that was selected in response to PerformInteraction. 
 * 
 * @discussion Only is valid if general result is "success:true".
 *
 * Optional, Integer, 0 - 2,000,000,000
 */
@property (strong) NSNumber *choiceID;

/**
 * @abstract Manually entered text selection, e.g. through keyboard
 * 
 * @discussion Can be returned in lieu of choiceID, depending on trigger source
 *
 * Optional, Max length 500 chars
 */
@property (strong) NSString *manualTextEntry;

/**
 * @abstract A *SDLTriggerSource* object which will be shown in the HMI
 *
 * @discussion Only is valid if resultCode is SUCCESS.
 */
@property (strong) SDLTriggerSource triggerSource;


@end