Shift files into root directory

1 files changed, 116 insertions, 0 deletions

diff --git a/SmartDeviceLink/SDLChoice.h b/SmartDeviceLink/SDLChoice.h
new file mode 100644
index 000000000..478b33b5f
--- /dev/null
+++ b/SmartDeviceLink/SDLChoice.h
@@ -0,0 +1,116 @@
+//  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 {
+}
+
+/**
+ * Constructs a newly allocated SDLChoice object
+ */
+- (instancetype)init;
+
+/**
+ * Constructs a newly allocated SDLChoice object indicated by the dictionary parameter
+ * @param dict The dictionary to use
+ */
+- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;
+
+/**
+ * @abstract the application-scoped identifier that uniquely identifies this choice
+ * 
+ * Required, Integer 0 - 65535
+ */
+@property (strong) NSNumber *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 *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