diff options
Diffstat (limited to 'SmartDeviceLink/SDLSlider.h')
| -rw-r--r-- | SmartDeviceLink/SDLSlider.h | 31 |
1 files changed, 29 insertions, 2 deletions
diff --git a/SmartDeviceLink/SDLSlider.h b/SmartDeviceLink/SDLSlider.h index fa1dc7acc..c23606350 100644 --- a/SmartDeviceLink/SDLSlider.h +++ b/SmartDeviceLink/SDLSlider.h @@ -16,10 +16,37 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLSlider : SDLRPCRequest +/** + Create an SDLSlider with only the number of ticks and position. Note that this is not enough to get a SUCCESS response. You must supply additional data. See below for required parameters. + + @param numTicks The number of ticks present on the slider. + @param position The default starting position of the slider. + @return An SDLSlider RPC Request. + */ - (instancetype)initWithNumTicks:(UInt8)numTicks position:(UInt8)position; +/** + Create an SDLSlider with all required data and a static footer (or no footer). + + @param numTicks The number of ticks present on the slider. + @param position The default starting position of the slider. + @param sliderHeader The header describing the slider. + @param sliderFooter A static footer with text, or nil for no footer. + @param timeout The length of time in milliseconds the popup should be displayed before automatically disappearing. + @return An SDLSlider RPC Request. + */ - (instancetype)initWithNumTicks:(UInt8)numTicks position:(UInt8)position sliderHeader:(NSString *)sliderHeader sliderFooter:(nullable NSString *)sliderFooter timeout:(UInt16)timeout; +/** + Create an SDLSlider with all required data and a dynamic footer (or no footer). + + @param numTicks The number of ticks present on the slider. + @param position The default starting position of the slider. + @param sliderHeader The header describing the slider. + @param sliderFooters An array of footers. This should be the same length as `numTicks` as each footer should correspond to a tick, or no footer if nil. + @param timeout The length of time in milliseconds the popup should be displayed before automatically disappearing. + @return An SDLSlider RPC Request. + */ - (instancetype)initWithNumTicks:(UInt8)numTicks position:(UInt8)position sliderHeader:(NSString *)sliderHeader sliderFooters:(nullable NSArray<NSString *> *)sliderFooters timeout:(UInt16)timeout; /** @@ -39,7 +66,7 @@ NS_ASSUME_NONNULL_BEGIN /** * @abstract A text header to display * - * Rquired, Max length 500 chars + * Required, Max length 500 chars */ @property (strong, nonatomic) NSString *sliderHeader; @@ -59,7 +86,7 @@ NS_ASSUME_NONNULL_BEGIN @property (strong, nonatomic, nullable) NSArray<NSString *> *sliderFooter; /** - * @abstract An App defined timeout + * @abstract An App defined timeout in milliseconds * * @discussion Indicates how long of a timeout from the last action (i.e. sliding control resets timeout). * |