diff options
author | Joel Fischer <joel@livioradio.com> | 2015-03-09 10:41:15 -0400 |
---|---|---|
committer | Joel Fischer <joel@livioradio.com> | 2015-03-09 10:50:44 -0400 |
commit | 25b881cf646de400b1a1b749dc0175a8d073e330 (patch) | |
tree | cfed62075bf052ad8c713fb1f8fd199f0b6f5901 /SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimer.h | |
parent | aea65586bb1817cfc9c6b47af273ac6498a27df6 (diff) | |
download | sdl_ios-25b881cf646de400b1a1b749dc0175a8d073e330.tar.gz |
Documentation of enums, rpcs, and more
Diffstat (limited to 'SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimer.h')
-rw-r--r-- | SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimer.h | 51 |
1 files changed, 50 insertions, 1 deletions
diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimer.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimer.h index 933599540..04bcd298b 100644 --- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimer.h +++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLSetMediaClockTimer.h @@ -1,6 +1,6 @@ // SDLSetMediaClockTimer.h // -// Copyright (c) 2014 Ford Motor Company. All rights reserved. + #import "SDLRPCRequest.h" @@ -8,13 +8,62 @@ #import "SDLStartTime.h" #import "SDLUpdateMode.h" +/** + * Sets the media clock/timer value and the update method (e.g.count-up, + * count-down, etc.) + * <p> + * Function Group: Base <p> + * <b>HMILevel needs to be FULL, LIMITIED or BACKGROUND</b> + * </p> + * + * Since SmartDeviceLink 1.0 + */ @interface SDLSetMediaClockTimer : SDLRPCRequest {} +/** + * @abstract Constructs a new SDLSetMediaClockTimer object + */ -(id) init; +/** + * @abstract Constructs a new SDLSetMediaClockTimer object indicated by the NSMutableDictionary + * parameter + * @param dict The NSMutableDictionary to use + */ -(id) initWithDictionary:(NSMutableDictionary*) dict; +/** + * @abstract A Start Time with specifying hour, minute, second values + * + * @discussion A startTime object with specifying hour, minute, second values + * <p> + * <b>Notes: </b> + * <ul> + * <li>If "updateMode" is COUNTUP or COUNTDOWN, this parameter + * must be provided</li> + * <li>Will be ignored for PAUSE/RESUME and CLEAR</li> + * </ul> + */ @property(strong) SDLStartTime* startTime; +/** + * @abstract An END time of type SDLStartTime, specifying hour, minute, second values + * + * @discussion An SDLStartTime object with specifying hour, minute, second values + */ @property(strong) SDLStartTime* endTime; +/** + * @abstract The media clock/timer update mode (COUNTUP/COUNTDOWN/PAUSE/RESUME) + * + * @discussion a Enumeration value (COUNTUP/COUNTDOWN/PAUSE/RESUME) + * <p> + * <b>Notes: </b> + * <ul> + * <li>When updateMode is PAUSE, RESUME or CLEAR, the start time value + * is ignored</li> + * <li>When updateMode is RESUME, the timer resumes counting from + * the timer's value when it was paused</li> + * </ul> + */ @property(strong) SDLUpdateMode* updateMode; @end + |