summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLMenuParams.h
blob: 14f51e390122bfb637dbd61d7ce23f75b5f88d11 (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
45
46
47
48
49
50
51
52
53
54
55
56
//  SDLMenuParams.h
//


#import "SDLRPCMessage.h"

/**
 * Used when adding a sub menu to an application menu or existing sub menu.
 *
 * @since SDL 1.0
 */
@interface SDLMenuParams : SDLRPCStruct {
}

/**
 * Constructs a newly allocated SDLMenuParams object
 */
- (instancetype)init;

/**
 * Constructs a newly allocated SDLMenuParams object indicated by the dictionary parameter
 * @param dict The dictionary to use
 */
- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;


/**
 * @abstract the unique ID of an existing submenu to which a command will be added
 * @discussion If this element is not provided, the command will be added to the top level of the Command Menu.
 *
 * Optional, Integer, 0 - 2,000,000,000
 */
@property (strong) NSNumber *parentID;

/**
 * @abstract The position within the items of the parent Command Menu
 * @discussion 0 will insert at the front, 1 will insert after the first existing element, etc.
 * 
 * Position of any submenu will always be located before the return and exit options.
 *
 * * If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.
 *
 * * If this element is omitted, the entry will be added at the end of the parent menu.
 *
 * Optional, Integer, 0 - 1000
 */
@property (strong) NSNumber *position;

/**
 * @abstract the menu name which appears in menu, representing this command
 * 
 * Required, max length 500 characters
 */
@property (strong) NSString *menuName;

@end