diff options
Diffstat (limited to 'SmartDeviceLink/SDLShow.h')
| -rw-r--r-- | SmartDeviceLink/SDLShow.h | 233 |
1 files changed, 233 insertions, 0 deletions
diff --git a/SmartDeviceLink/SDLShow.h b/SmartDeviceLink/SDLShow.h new file mode 100644 index 000000000..20cf84a92 --- /dev/null +++ b/SmartDeviceLink/SDLShow.h @@ -0,0 +1,233 @@ +// SDLShow.h +// + +#import "SDLRPCRequest.h" + +@class SDLImage; +@class SDLTextAlignment; + + +/** + * Updates the application's display text area, regardless of whether or not + * this text area is visible to the user at the time of the request. The + * application's display text area remains unchanged until updated by subsequent + * calls to Show + * <p> + * The content of the application's display text area is visible to the user + * when the application + * is FULL or LIMITED, and the + * SDLSystemContext=MAIN and no + * SDLAlert is in progress + * <p> + * The Show operation cannot be used to create an animated scrolling screen. To + * avoid distracting the driver, Show commands cannot be issued more than once + * every 4 seconds. Requests made more frequently than this will be rejected + * <p> + * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> + * </p> + * + * Since SmartDeviceLink 1.0 + * See SDLAlert SDLSetMediaClockTimer + */ +@interface SDLShow : SDLRPCRequest { +} + +/** + * @abstract Constructs a new SDLShow object + */ +- (instancetype)init; +/** + * @abstract Constructs a new SDLShow object indicated by the dictionary parameter + * @param dict The dictionary to use + */ +- (instancetype)initWithDictionary:(NSMutableDictionary *)dict; + +/** + * @abstract The text displayed in a single-line display, or in the upper display + * line in a two-line display + * @discussion The String value representing the text displayed in a + * single-line display, or in the upper display line in a + * two-line display + * <p> + * <b>Notes: </b> + * <ul> + * <li>If this parameter is omitted, the text of mainField1 does + * not change</li> + * <li>If this parameter is an empty string, the field will be + * cleared</li> + * </ul> + */ +@property (strong) NSString *mainField1; +/** + * @abstract The text displayed on the second display line of a two-line display + * + * @discussion The String value representing the text displayed on the second + * display line of a two-line display + * <p> + * <b>Notes: </b> + * <ul> + * <li>If this parameter is omitted, the text of mainField2 does + * not change</li> + * <li>If this parameter is an empty string, the field will be + * cleared</li> + * <li>If provided and the display is a single-line display, the + * parameter is ignored</li> + * <li>Maxlength = 500</li> + * </ul> + */ +@property (strong) NSString *mainField2; +/** + * @abstract The text displayed on the first display line of the second page + * + * @discussion The String value representing the text displayed on the first + * display line of the second page + * <p> + * <b>Notes: </b> + * <ul> + * <li>If this parameter is omitted, the text of mainField3 does + * not change</li> + * <li>If this parameter is an empty string, the field will be + * cleared</li> + * <li>If provided and the display is a single-line display, the + * parameter is ignored</li> + * <li>Maxlength = 500</li> + * </ul> + * @since SmartDeviceLink 2.0 + */ +@property (strong) NSString *mainField3; +/** + * @abstract The text displayed on the second display line of the second page + * + * @discussion The String value representing the text displayed on the second + * display line of the second page + * <p> + * <b>Notes: </b> + * <ul> + * <li>If this parameter is omitted, the text of mainField4 does + * not change</li> + * <li>If this parameter is an empty string, the field will be + * cleared</li> + * <li>If provided and the display is a single-line display, the + * parameter is ignored</li> + * <li>Maxlength = 500</li> + * </ul> + * @since SmartDeviceLink 2.0 + */ +@property (strong) NSString *mainField4; +/** + * @abstract The alignment that Specifies how mainField1 and mainField2 text + * should be aligned on display + * + * @discussion An Enumeration value + * <p> + * <b>Notes: </b> + * <ul> + * <li>Applies only to mainField1 and mainField2 provided on this + * call, not to what is already showing in display</li> + * <li>If this parameter is omitted, text in both mainField1 and + * mainField2 will be centered</li> + * <li>Has no effect with navigation display</li> + * </ul> + */ +@property (strong) SDLTextAlignment *alignment; +/** + * @abstract Text in the Status Bar + * + * @discussion A String representing the text you want to add in the Status + * Bar + * <p> + * <b>Notes: </b><i>The status bar only exists on navigation + * displays</i><br/> + * <ul> + * <li>If this parameter is omitted, the status bar text will + * remain unchanged</li> + * <li>If this parameter is an empty string, the field will be + * cleared</li> + * <li>If provided and the display has no status bar, this + * parameter is ignored</li> + * </ul> + */ +@property (strong) NSString *statusBar; +/** + * @abstract This property is deprecated use SetMediaClockTimer instead. + * <p> The value for the MediaClock field using a format described in the + * MediaClockFormat enumeration + * + * @discussion A String value for the MediaClock + * <p> + * <b>Notes: </b><br/> + * <ul> + * <li>Must be properly formatted as described in the + * MediaClockFormat enumeration</li> + * <li>If a value of five spaces is provided, this will clear + * that field on the display (i.e. the media clock timer field + * will not display anything)</li> + * </ul> + */ +@property (strong) NSString *mediaClock; +/** + * @abstract The text in the track field + * + * @discussion A String value disaplayed in the track field + * <p> + * <b>Notes: </b><br/> + * <ul> + * <li>If parameter is omitted, the track field remains unchanged</li> + * <li>If an empty string is provided, the field will be cleared</li> + * <li>This field is only valid for media applications on navigation displays</li> + * </ul> + */ +@property (strong) NSString *mediaTrack; +/** + * @abstract An image to be shown on supported displays + * + * @discussion The value representing the image shown on supported displays + * <p> + * <b>Notes: </b>If omitted on supported displays, the displayed + * graphic shall not change<br/> + * @since SmartDeviceLink 2.0 + */ +@property (strong) SDLImage *graphic; +/** + * @abstract An image to be shown on supported displays + * + * @discussion The value representing the image shown on supported displays + * <p> + * <b>Notes: </b>If omitted on supported displays, the displayed + * graphic shall not change<br/> + * @since SmartDeviceLink 2.0 + */ +@property (strong) SDLImage *secondaryGraphic; +/** + * @abstract The the Soft buttons defined by the App + * + * @discussion A Vector value represemting the Soft buttons defined by the + * App + * <p> + * <b>Notes: </b><br/> + * <ul> + * <li>If omitted on supported displays, the currently displayed + * SoftButton values will not change</li> + * <li>Array Minsize: 0</li> + * <li>Array Maxsize: 8</li> + * </ul> + * + * @since SmartDeviceLink 2.0 + */ +@property (strong) NSMutableArray *softButtons; +/** + * @abstract The Custom Presets defined by the App + * + * @discussion A Vector value representing the Custom Presets defined by the + * App + * <p> + * <ul> + * <li>If omitted on supported displays, the presets will be shown as not defined</li> + * <li>Array Minsize: 0</li> + * <li>Array Maxsize: 6</li> + * </ul> + * @since SmartDeviceLink 2.0 + */ +@property (strong) NSMutableArray *customPresets; + +@end |