// 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.
*
Parameter List
*
*
* Name |
* Type |
* Description |
* SmartDeviceLink Ver. Available |
*
*
* choiceID |
* NSNumber * |
* Application-scoped identifier that uniquely identifies this choice.
* Min: 0
* Max: 65535
* |
* SmartDeviceLink 1.0 |
*
*
* menuName |
* NSString * |
* Text which appears in menu, representing this choice.
* Min: 1
* Max: 100
* |
* SmartDeviceLink 1.0 |
*
*
* vrCommands |
* NSMutableArray * |
* 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 |
* SmartDeviceLink 1.0 |
*
*
* image |
* SDLImage * |
* Either a static hex icon value or a binary image file name identifier (sent by PutFile). |
* SmartDeviceLink 2.0 |
*
*
*
* Since SmartDeviceLink 1.0
*/
@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