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

#import "SDLRPCNotification.h"

#import "SDLTriggerSource.h"

/**
 * This is called when a command was selected via VR after pressing the PTT button, or selected from the menu after
 * pressing the MENU button.
 *
 * <b>Note:</b> The sequence of *SDLOnHMIStatus* and *SDLOnCommand* notifications for user-initiated interactions is indeterminate.
 * 
 * @since SDL 1.0
 * @see SDLAddCommand SDLDeleteCommand SDLDeleteSubMenu
 */

NS_ASSUME_NONNULL_BEGIN

@interface SDLOnCommand : SDLRPCNotification

/**
 * @abstract The command ID of the command the user selected. This is the command ID value provided by the application in the <i>SDLAddCommand</i> operation that created the command.
 */
@property (strong) NSNumber<SDLInt> *cmdID;

/**
 * @abstract Indicates whether command was selected via voice or via a menu selection (using the OK button).
 */
@property (strong) SDLTriggerSource triggerSource;

@end

NS_ASSUME_NONNULL_END