blob: b35deb2993fd2e95a00e56e6df3857e4eadb6be0 (
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
// SDLChoice.h
//
#import "SDLRPCMessage.h"
@class SDLImage;
/**
* A choice is an option which a user can select either via the menu or via voice recognition (VR) during an application initiated interaction.
* <p><b> Parameter List</b>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
* <th>Type</th>
* <th>Description</th>
* <th>SmartDeviceLink Ver. Available</th>
* </tr>
* <tr>
* <td>choiceID</td>
* <td>NSNumber * </td>
* <td>Application-scoped identifier that uniquely identifies this choice.
* <br/>Min: 0
* <br/>Max: 65535
* </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>menuName</td>
* <td>NSString * </td>
* <td>Text which appears in menu, representing this choice.
* <br/>Min: 1
* <br/>Max: 100
* </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>vrCommands</td>
* <td>NSMutableArray *</td>
* <td>An array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty element</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>image</td>
* <td>SDLImage * </td>
* <td>Either a static hex icon value or a binary image file name identifier (sent by PutFile).</td>
* <td>SmartDeviceLink 2.0</td>
* </tr>
* </table>
*
* Since <b>SmartDeviceLink 1.0</b><br>
*/
@interface SDLChoice : SDLRPCStruct
- (instancetype)initWithId:(UInt16)choiceId menuName:(NSString *)menuName vrCommands:(NSArray<NSString *> *)vrCommands;
- (instancetype)initWithId:(UInt16)choiceId menuName:(NSString *)menuName vrCommands:(NSArray<NSString *> *)vrCommands image:(SDLImage *)image secondaryText:(NSString *)secondaryText secondaryImage:(SDLImage *)secondaryImage tertiaryText:(NSString *)tertiaryText;
/**
* @abstract the application-scoped identifier that uniquely identifies this choice
*
* Required, Integer 0 - 65535
*/
@property (strong) NSNumber<SDLInt> *choiceID;
/**
* @abstract Text which appears in menu, representing this choice
*
* Required, Max string length 500 chars
*/
@property (strong) NSString *menuName;
/**
* @abstract VR synonyms for this choice
*
* Required, Array of Strings, Array length 1 - 100, Max String length 99 chars
*/
@property (strong) NSMutableArray<NSString *> *vrCommands;
/**
* @abstract The image of the choice
*
* Optional
*/
@property (strong) SDLImage *image;
/**
* @abstract Optional secondary text to display; e.g. address of POI in a search result entry
*
* Optional, Max String length 500 chars
*/
@property (strong) NSString *secondaryText;
/**
* @abstract Optional tertiary text to display; e.g. distance to POI for a search result entry
*
* Optional, Max String length 500 chars
*/
@property (strong) NSString *tertiaryText;
/**
* @abstract Optional secondary image for choice
*
* Optional
*/
@property (strong) SDLImage *secondaryImage;
@end
|
