summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJustin Gluck <justin.gluck@livio.io>2019-10-30 13:56:42 -0400
committerJustin Gluck <justin.gluck@livio.io>2019-10-30 13:56:42 -0400
commit4a915a478275703e0e32405a1734a163108cd211 (patch)
tree3a4281165e09a6a7f2bc5f1d88d5da9d4d3dc97a
parente7c080a4876d9f7542eab5cff5a4a65887f34dc2 (diff)
downloadsdl_ios-4a915a478275703e0e32405a1734a163108cd211.tar.gz
no message
-rw-r--r--SmartDeviceLink/SDLNavigationAction.h4
-rw-r--r--SmartDeviceLink/SDLSISData.h8
-rw-r--r--SmartDeviceLink/SDLScreenManager.h3
-rw-r--r--SmartDeviceLink/SDLSeatControlCapabilities.h48
-rw-r--r--SmartDeviceLink/SDLSeatControlData.h67
-rw-r--r--SmartDeviceLink/SDLSeatLocationCapability.h7
-rw-r--r--SmartDeviceLink/SDLSendLocation.h3
-rw-r--r--SmartDeviceLink/SDLSetAppIcon.h5
-rw-r--r--SmartDeviceLink/SDLSetDisplayLayout.h15
-rw-r--r--SmartDeviceLink/SDLSetInteriorVehicleData.h4
-rw-r--r--SmartDeviceLink/SDLSetMediaClockTimer.h19
-rw-r--r--SmartDeviceLink/SDLShow.h58
-rw-r--r--SmartDeviceLink/SDLShowConstantTBT.h14
-rw-r--r--SmartDeviceLink/SDLSoftButton.h13
-rw-r--r--SmartDeviceLink/SDLSoftButtonObject.h3
-rw-r--r--SmartDeviceLink/SDLSoftButtonState.h1
-rw-r--r--SmartDeviceLink/SDLSpeak.h8
-rw-r--r--SmartDeviceLink/SDLSpeechCapabilities.h2
-rw-r--r--SmartDeviceLink/SDLStaticIconName.h356
19 files changed, 421 insertions, 217 deletions
diff --git a/SmartDeviceLink/SDLNavigationAction.h b/SmartDeviceLink/SDLNavigationAction.h
index c013770f5..6cc0edd9e 100644
--- a/SmartDeviceLink/SDLNavigationAction.h
+++ b/SmartDeviceLink/SDLNavigationAction.h
@@ -38,10 +38,10 @@ extern SDLNavigationAction const SDLNavigationActionMerge;
*/
extern SDLNavigationAction const SDLNavigationActionFerry;
-/**SDLNavigationCapability.h
+/**
* A navigation action of car shuttle train.
*/
-extern SDLNavigationAction const SDLNavigatiSDLNavigationCapability.honActionCarShuttleTrain;
+extern SDLNavigationAction const SDLNavigationActionCarShuttleTrain;
/**
* A navigation action of waypoint.
diff --git a/SmartDeviceLink/SDLSISData.h b/SmartDeviceLink/SDLSISData.h
index b7d939644..1ba5147b3 100644
--- a/SmartDeviceLink/SDLSISData.h
+++ b/SmartDeviceLink/SDLSISData.h
@@ -15,6 +15,14 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLSISData : SDLRPCStruct
+/// Convenience init to
+///
+/// @param stationShortName Identifies the 4-alpha-character station call sign
+/// @param id A SDLStationIDNumber
+/// @param stationLongName Identifies the station call sign or other identifying
+/// @param stationLocation Provides the 3-dimensional geographic station location
+/// @param stationMessage May be used to convey textual information of general interest
+/// @return An SDLSISData object
- (instancetype)initWithStationShortName:(nullable NSString *)stationShortName stationIDNumber:(nullable SDLStationIDNumber *)id stationLongName:(nullable NSString *)stationLongName stationLocation:(nullable SDLGPSData *)stationLocation stationMessage:(nullable NSString *)stationMessage;
/**
diff --git a/SmartDeviceLink/SDLScreenManager.h b/SmartDeviceLink/SDLScreenManager.h
index 51df716c9..f57ac5eec 100644
--- a/SmartDeviceLink/SDLScreenManager.h
+++ b/SmartDeviceLink/SDLScreenManager.h
@@ -45,6 +45,7 @@ typedef void(^SDLScreenManagerUpdateCompletionHandler)(NSError *__nullable error
*/
typedef void(^SDLPreloadChoiceCompletionHandler)(NSError *__nullable error);
+/// The SDLScreenManager is a manager to control certain UI features. Use the screen manager for setting up the UI of the template, creating a menu for your users, creating softbuttons and setting textfields.
@interface SDLScreenManager : NSObject
#pragma mark Text and Graphics
@@ -242,6 +243,8 @@ If set to `SDLDynamicMenuUpdatesModeForceOff`, menu updates will work the legacy
#pragma mark Soft Button
+/// Retrieve a SoftButtonObject from a SoftButtonObject name.
+/// @param name The name of the button
- (nullable SDLSoftButtonObject *)softButtonObjectNamed:(NSString *)name;
#pragma mark Choice Sets
diff --git a/SmartDeviceLink/SDLSeatControlCapabilities.h b/SmartDeviceLink/SDLSeatControlCapabilities.h
index b54287086..c55de4876 100644
--- a/SmartDeviceLink/SDLSeatControlCapabilities.h
+++ b/SmartDeviceLink/SDLSeatControlCapabilities.h
@@ -12,13 +12,61 @@ NS_ASSUME_NONNULL_BEGIN
*/
@interface SDLSeatControlCapabilities : SDLRPCStruct
+/// Constructs a newly allocated SDLSeatControlCapabilities object with moduleName
+///
+/// @param moduleName The short friendly name of the module.
+/// @return An SDLSeatControlCapabilities object
- (instancetype)initWithName:(NSString *)moduleName __deprecated_msg("Use initWithName:moduleInfo:");
+/// Constructs a newly allocated SDLSeatControlCapabilities object with moduleName and moduleInfo
+///
+/// @param moduleName The short friendly name of the module.
+/// @param moduleInfo Information about a RC module, including its id
+/// @return An SDLSeatControlCapabilities object
- (instancetype)initWithName:(NSString *)moduleName moduleInfo:(nullable SDLModuleInfo *)moduleInfo;
+/// Constructs a newly allocated SDLSeatControlCapabilities object with given parameters
+///
+/// @param moduleName The short friendly name of the module.
+/// @param heatingEnabledAvail Whether or not heating is available
+/// @param coolingEnabledAvail Whether or not heating is available
+/// @param heatingLevelAvail Whether or not heating level is available
+/// @param coolingLevelAvail Whether or not cooling level is available
+/// @param horizontalPositionAvail Whether or not horizontal Position is aavailable
+/// @param verticalPositionAvail Whether or not vertical position is available
+/// @param frontVerticalPositionAvail Whether or not front vertical position is available
+/// @param backVerticalPositionAvail Whether or not back vertical position is available
+/// @param backTitlAngleAvail Whether or not backTilt angle is available
+/// @param headSupportHorizontalPositionAvail Whether or not head supports for horizontal position is available
+/// @param headSupportVerticalPositionAvail Whether or not head supports for vertical position is available
+/// @param massageEnabledAvail Whether or not massage enabled is available
+/// @param massageModeAvail Whether or not massage mode is available
+/// @param massageCushionFirmnessAvail Whether or not massage cushion firmness is available
+/// @param memoryAvail Whether or not massage cushion firmness is available
+/// @return An SDLSeatControlCapabilities object
- (instancetype)initWithName:(NSString *)moduleName heatingEnabledAvailable:(BOOL)heatingEnabledAvail
coolingEnabledAvailable:(BOOL)coolingEnabledAvail heatingLevelAvailable:(BOOL)heatingLevelAvail coolingLevelAvailable:(BOOL)coolingLevelAvail horizontalPositionAvailable:(BOOL)horizontalPositionAvail verticalPositionAvailable:(BOOL)verticalPositionAvail frontVerticalPositionAvailable:(BOOL)frontVerticalPositionAvail backVerticalPositionAvailable:(BOOL)backVerticalPositionAvail backTiltAngleAvailable:(BOOL)backTitlAngleAvail headSupportHorizontalPositionAvailable:(BOOL)headSupportHorizontalPositionAvail headSupportVerticalPositionAvailable:(BOOL)headSupportVerticalPositionAvail massageEnabledAvailable:(BOOL)massageEnabledAvail massageModeAvailable:(BOOL)massageModeAvail massageCushionFirmnessAvailable:(BOOL)massageCushionFirmnessAvail memoryAvailable:(BOOL)memoryAvail __deprecated_msg("Use initWithName:moduleInfo:heatingEnabledAvailable:coolingEnabledAvailable:heatingLevelAvailable:coolingLevelAvailable:horizontalPositionAvailable:verticalPositionAvailable:frontVerticalPositionAvailable:backVerticalPositionAvailable:backTiltAngleAvailable:headSupportHorizontalPositionAvailable:headSupportVerticalPositionAvailable:massageEnabledAvailable:massageModeAvailable:massageCushionFirmnessAvailable:memoryAvailable:");
+/// Constructs a newly allocated SDLSeatControlCapabilities object with all parameters
+///
+/// @param moduleName The short friendly name of the module.
+/// @param moduleInfo Information about a RC module, including its id
+/// @param heatingEnabledAvail Whether or not heating is available
+/// @param coolingEnabledAvail Whether or not heating is available
+/// @param heatingLevelAvail Whether or not heating level is available
+/// @param coolingLevelAvail Whether or not cooling level is available
+/// @param horizontalPositionAvail Whether or not horizontal Position is aavailable
+/// @param verticalPositionAvail Whether or not vertical position is available
+/// @param frontVerticalPositionAvail Whether or not front vertical position is available
+/// @param backVerticalPositionAvail Whether or not back vertical position is available
+/// @param backTitlAngleAvail Whether or not backTilt angle is available
+/// @param headSupportHorizontalPositionAvail Whether or not head supports for horizontal position is available
+/// @param headSupportVerticalPositionAvail Whether or not head supports for vertical position is available
+/// @param massageEnabledAvail Whether or not massage enabled is available
+/// @param massageModeAvail Whether or not massage mode is available
+/// @param massageCushionFirmnessAvail Whether or not massage cushion firmness is available
+/// @param memoryAvail Whether or not massage cushion firmness is available
+/// @return An SDLSeatControlCapabilities object
- (instancetype)initWithName:(NSString *)moduleName moduleInfo:(nullable SDLModuleInfo *)moduleInfo heatingEnabledAvailable:(BOOL)heatingEnabledAvail
coolingEnabledAvailable:(BOOL)coolingEnabledAvail heatingLevelAvailable:(BOOL)heatingLevelAvail coolingLevelAvailable:(BOOL)coolingLevelAvail horizontalPositionAvailable:(BOOL)horizontalPositionAvail verticalPositionAvailable:(BOOL)verticalPositionAvail frontVerticalPositionAvailable:(BOOL)frontVerticalPositionAvail backVerticalPositionAvailable:(BOOL)backVerticalPositionAvail backTiltAngleAvailable:(BOOL)backTitlAngleAvail headSupportHorizontalPositionAvailable:(BOOL)headSupportHorizontalPositionAvail headSupportVerticalPositionAvailable:(BOOL)headSupportVerticalPositionAvail massageEnabledAvailable:(BOOL)massageEnabledAvail massageModeAvailable:(BOOL)massageModeAvail massageCushionFirmnessAvailable:(BOOL)massageCushionFirmnessAvail memoryAvailable:(BOOL)memoryAvail;
diff --git a/SmartDeviceLink/SDLSeatControlData.h b/SmartDeviceLink/SDLSeatControlData.h
index 73cd8a6e0..9bc716392 100644
--- a/SmartDeviceLink/SDLSeatControlData.h
+++ b/SmartDeviceLink/SDLSeatControlData.h
@@ -17,51 +17,52 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLSeatControlData : SDLRPCStruct
-/**
- Constructs a newly allocated SDLSeatControlData object with cushion and firmness
-
- @param supportedSeat id of remote controllable seat.
- @return An instance of the SDLSeatControlData class
- */
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+/**
+Constructs a newly allocated SDLSeatControlData object with cushion and firmness
+
+@param supportedSeat id of remote controllable seat.
+@return An instance of the SDLSeatControlData class
+*/
- (instancetype)initWithId:(SDLSupportedSeat)supportedSeat;
#pragma clang diagnostic pop
-/**
- Constructs a newly allocated SDLSeatControlData object with cushion and firmness
-
- @param supportedSeat id of remote controllable seat.
- @param heatingEnable Whether or not heating is enabled.
- @param coolingEnable Whether or not cooling is enabled.
- @param heatingLevel heating level
- @param coolingLevel cooling Level
- @param horizontal horizontal Position
- @param vertical vertical Position
- @param frontVertical frontVertical Position
- @param backVertical backVertical Position
- @param backAngle backAngle Position
- @param headSupportedHorizontal headSupportedHorizontal Position
- @param headSupportedVertical headSupportedVertical Position
- @param massageEnable Whether or not massage is enabled.
- @param massageMode Array of massage mode data.
- @param firmness Array of firmness data.
- @param memoryAction type of action to be performed.
- @return An instance of the SDLSeatControlData class
- */
+
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+/**
+ Constructs a newly allocated SDLSeatControlData object with cushion and firmness
+
+@param supportedSeat id of remote controllable seat.
+@param heatingEnable Whether or not heating is enabled.
+@param coolingEnable Whether or not cooling is enabled.
+@param heatingLevel heating level
+@param coolingLevel cooling Level
+@param horizontal horizontal Position
+@param vertical vertical Position
+@param frontVertical frontVertical Position
+@param backVertical backVertical Position
+@param backAngle backAngle Position
+@param headSupportedHorizontal headSupportedHorizontal Position
+@param headSupportedVertical headSupportedVertical Position
+@param massageEnable Whether or not massage is enabled.
+@param massageMode Array of massage mode data.
+@param firmness Array of firmness data.
+@param memoryAction type of action to be performed.
+@return An instance of the SDLSeatControlData class
+*/
- (instancetype)initWithId:(SDLSupportedSeat)supportedSeat heatingEnabled:(BOOL)heatingEnable coolingEnable:(BOOL)coolingEnable heatingLevel:(UInt8)heatingLevel coolingLevel:(UInt8)coolingLevel horizontalPostion:(UInt8)horizontal verticalPostion:(UInt8)vertical frontVerticalPostion:(UInt8)frontVertical backVerticalPostion:(UInt8)backVertical backTiltAngle:(UInt8)backAngle headSupportedHorizontalPostion:(UInt8)headSupportedHorizontal headSupportedVerticalPostion:(UInt8)headSupportedVertical massageEnabled:(BOOL)massageEnable massageMode:(NSArray<SDLMassageModeData *> *)massageMode massageCussionFirmness:(NSArray<SDLMassageCushionFirmness *> *)firmness memory:(SDLSeatMemoryAction *)memoryAction;
#pragma clang diagnostic pop
-/**
- * @abstract id of seat that is a remote controllable seat.
- * @warning This should not be used to identify a seat, this is a deprecated parameter.
- *
- * Required
- */
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+/**
+* @abstract id of seat that is a remote controllable seat.
+* @warning This should not be used to identify a seat, this is a deprecated parameter.
+*
+* Required
+*/
@property (strong, nonatomic) SDLSupportedSeat id;
#pragma clang diagnostic pop
diff --git a/SmartDeviceLink/SDLSeatLocationCapability.h b/SmartDeviceLink/SDLSeatLocationCapability.h
index 9f7d6a15f..1bd5f5693 100644
--- a/SmartDeviceLink/SDLSeatLocationCapability.h
+++ b/SmartDeviceLink/SDLSeatLocationCapability.h
@@ -17,6 +17,13 @@ NS_ASSUME_NONNULL_BEGIN
*/
@interface SDLSeatLocationCapability : SDLRPCStruct
+/// Constructs a newly allocated SDLSeatLocationCapability object with all parameters
+///
+/// @param seats Describes the location of a seat
+/// @param cols Number of columns
+/// @param rows Number of rows
+/// @param levels Number of levels
+/// @return An SDLSeatLocationCapability object
- (instancetype)initWithSeats:(NSArray<SDLSeatLocation *> *)seats cols:(NSNumber<SDLInt> *)cols rows:(NSNumber<SDLInt> *)rows levels:(NSNumber<SDLInt> *)levels;
/**
diff --git a/SmartDeviceLink/SDLSendLocation.h b/SmartDeviceLink/SDLSendLocation.h
index 0824ef7f2..39c08a1e8 100644
--- a/SmartDeviceLink/SDLSendLocation.h
+++ b/SmartDeviceLink/SDLSendLocation.h
@@ -13,6 +13,9 @@
NS_ASSUME_NONNULL_BEGIN
+/// Used to create a location object for navigation
+///
+/// @since RPC 3.0
@interface SDLSendLocation : SDLRPCRequest
/**
diff --git a/SmartDeviceLink/SDLSetAppIcon.h b/SmartDeviceLink/SDLSetAppIcon.h
index 5a8c2567f..53f3531b5 100644
--- a/SmartDeviceLink/SDLSetAppIcon.h
+++ b/SmartDeviceLink/SDLSetAppIcon.h
@@ -16,9 +16,12 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLSetAppIcon : SDLRPCRequest
+/// Convenience init to set an image icon from a file name. The file must already be uploaded to the head unit.
+///
+/// @param fileName A file reference name
+/// @return An SDLSetAppIcon object
- (instancetype)initWithFileName:(NSString *)fileName;
-
/**
* A file reference name
* @discussion A String value representing a file reference name
diff --git a/SmartDeviceLink/SDLSetDisplayLayout.h b/SmartDeviceLink/SDLSetDisplayLayout.h
index e19c2599c..e1c31d12d 100644
--- a/SmartDeviceLink/SDLSetDisplayLayout.h
+++ b/SmartDeviceLink/SDLSetDisplayLayout.h
@@ -19,13 +19,26 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLSetDisplayLayout : SDLRPCRequest
+/// Convenience init to set a display layout
+///
+/// @param predefinedLayout A template layout an app uses to display information
+/// @return An SDLSetDisplayLayout object
- (instancetype)initWithPredefinedLayout:(SDLPredefinedLayout)predefinedLayout;
+/// Convenience init to set a display layout
+///
+/// @param displayLayout A display layout name
+/// @return An SDLSetDisplayLayout object
- (instancetype)initWithLayout:(NSString *)displayLayout;
+/// Convenience init to set a display layout
+///
+/// @param predefinedLayout A display layout. Predefined or dynamically created screen layout
+/// @param dayColorScheme The color scheme to be used on a head unit using a "light" or "day" color scheme
+/// @param nightColorScheme The color scheme to be used on a head unit using a "dark" or "night" color scheme
+/// @return An SDLSetDisplayLayout object
- (instancetype)initWithPredefinedLayout:(SDLPredefinedLayout)predefinedLayout dayColorScheme:(SDLTemplateColorScheme *)dayColorScheme nightColorScheme:(SDLTemplateColorScheme *)nightColorScheme;
-
/**
* A display layout. Predefined or dynamically created screen layout.
* Currently only predefined screen layouts are defined. Predefined layouts
diff --git a/SmartDeviceLink/SDLSetInteriorVehicleData.h b/SmartDeviceLink/SDLSetInteriorVehicleData.h
index cf7e876a0..fdc1d312e 100644
--- a/SmartDeviceLink/SDLSetInteriorVehicleData.h
+++ b/SmartDeviceLink/SDLSetInteriorVehicleData.h
@@ -15,6 +15,10 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLSetInteriorVehicleData : SDLRPCRequest
+/// Convenience init to change settings of a module
+///
+/// @param moduleData A remote control module data object
+/// @return An SDLSetInteriorVehicleData object
- (instancetype)initWithModuleData:(SDLModuleData *)moduleData;
/**
diff --git a/SmartDeviceLink/SDLSetMediaClockTimer.h b/SmartDeviceLink/SDLSetMediaClockTimer.h
index 2ec5fe8e0..6b40e5d96 100644
--- a/SmartDeviceLink/SDLSetMediaClockTimer.h
+++ b/SmartDeviceLink/SDLSetMediaClockTimer.h
@@ -115,10 +115,29 @@ NS_ASSUME_NONNULL_BEGIN
*/
+ (instancetype)clearWithPlayPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator NS_SWIFT_NAME(clear(playPauseIndicator:));
+/// Convenience init to create a SDLSetMediaClockTimer object
+///
+/// @param updateMode The type of SetMediaClockTimer RPC
+/// @param hours Hour
+/// @param minutes Minuute
+/// @param seconds Seconds
+/// @param audioStreamingIndicator The audio streaming indicator used for a play/pause button
+/// @return An SDLSetMediaClockTimer object
- (instancetype)initWithUpdateMode:(SDLUpdateMode)updateMode hours:(UInt8)hours minutes:(UInt8)minutes seconds:(UInt8)seconds audioStreamingIndicator:(SDLAudioStreamingIndicator)audioStreamingIndicator __deprecated_msg("Use a specific initializer");
+/// Convenience init to create a SDLSetMediaClockTimer object
+///
+/// @param updateMode The type of SetMediaClockTimer RPC
+/// @param hours Hour
+/// @param minutes Minuute
+/// @param seconds Seconds
+/// @return An SDLSetMediaClockTimer object
- (instancetype)initWithUpdateMode:(SDLUpdateMode)updateMode hours:(UInt8)hours minutes:(UInt8)minutes seconds:(UInt8)seconds __deprecated_msg("Use a specific initializer");
+/// Convenience init to create a SDLSetMediaClockTimer object
+///
+/// @param updateMode he type of SetMediaClockTimer RPC
+/// @return An SDLSetMediaClockTimer object
- (instancetype)initWithUpdateMode:(SDLUpdateMode)updateMode __deprecated_msg("Use a specific initializer");
/**
diff --git a/SmartDeviceLink/SDLShow.h b/SmartDeviceLink/SDLShow.h
index 18f95107d..723e5fd83 100644
--- a/SmartDeviceLink/SDLShow.h
+++ b/SmartDeviceLink/SDLShow.h
@@ -39,16 +39,74 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLShow : SDLRPCRequest
+/// Convenience init to set template elements with the following parameters
+///
+/// @param mainField1 The text displayed on the first display line
+/// @param mainField2 The text displayed on the second display line
+/// @param alignment The alignment that specifies how the text should be aligned on display
+/// @return An SDLShow object
- (instancetype)initWithMainField1:(nullable NSString *)mainField1 mainField2:(nullable NSString *)mainField2 alignment:(nullable SDLTextAlignment)alignment;
+/// Convenience init to set template elements with the following parameters
+///
+/// @param mainField1 The text displayed on the first display line
+/// @param mainField1Type Text field metadata types
+/// @param mainField2 The text displayed on the second display line
+/// @param mainField2Type Text field metadata types
+/// @param alignment The alignment that specifies how the text should be aligned on display
+/// @return An SDLShow object
- (instancetype)initWithMainField1:(nullable NSString *)mainField1 mainField1Type:(nullable SDLMetadataType)mainField1Type mainField2:(nullable NSString *)mainField2 mainField2Type:(nullable SDLMetadataType)mainField2Type alignment:(nullable SDLTextAlignment)alignment;
+/// Convenience init to set template elements with the following parameters
+///
+/// @param mainField1 The text displayed on the first display line
+/// @param mainField2 The text displayed on the second display line
+/// @param mainField3 The text displayed on the third display line
+/// @param mainField4 The text displayed on the fourth display line
+/// @param alignment The alignment that specifies how the text should be aligned on display
+/// @return An SDLShow object
- (instancetype)initWithMainField1:(nullable NSString *)mainField1 mainField2:(nullable NSString *)mainField2 mainField3:(nullable NSString *)mainField3 mainField4:(nullable NSString *)mainField4 alignment:(nullable SDLTextAlignment)alignment;
+/// Convenience init to set template elements with the following parameters
+///
+/// @param mainField1 The text displayed on the first display line
+/// @param mainField1Type Text field metadata types
+/// @param mainField2 The text displayed on the second display line
+/// @param mainField2Type Text field metadata types
+/// @param mainField3 The text displayed on the third display line
+/// @param mainField3Type Text field metadata types
+/// @param mainField4 The text displayed on the fourth display line
+/// @param mainField4Type Text field metadata types
+/// @param alignment The alignment that specifies how the text should be aligned on display
+/// @return An SDLShow object
- (instancetype)initWithMainField1:(nullable NSString *)mainField1 mainField1Type:(nullable SDLMetadataType)mainField1Type mainField2:(nullable NSString *)mainField2 mainField2Type:(nullable SDLMetadataType)mainField2Type mainField3:(nullable NSString *)mainField3 mainField3Type:(nullable SDLMetadataType)mainField3Type mainField4:(nullable NSString *)mainField4 mainField4Type:(nullable SDLMetadataType)mainField4Type alignment:(nullable SDLTextAlignment)alignment;
+/// Convenience init to set template elements with the following parameters
+///
+/// @param mainField1 The text displayed on the first display line
+/// @param mainField2 The text displayed on the second display line
+/// @param alignment The alignment that specifies how the text should be aligned on display
+/// @param statusBar Text in the status Bar
+/// @param mediaClock The value for the mediaClock field
+/// @param mediaTrack The text in the track field
+/// @return An SDLShow object
- (instancetype)initWithMainField1:(nullable NSString *)mainField1 mainField2:(nullable NSString *)mainField2 alignment:(nullable SDLTextAlignment)alignment statusBar:(nullable NSString *)statusBar mediaClock:(nullable NSString *)mediaClock mediaTrack:(nullable NSString *)mediaTrack;
+/// Convenience init to set template elements with the following parameters
+///
+/// @param mainField1 The text displayed on the first display line
+/// @param mainField2 The text displayed on the second display line
+/// @param mainField3 The text displayed on the third display line
+/// @param mainField4 The text displayed on the fourth display line
+/// @param alignment The alignment that specifies how the text should be aligned on display
+/// @param statusBar Text in the status bar
+/// @param mediaClock The value for the mediaClock field
+/// @param mediaTrack The text in the track field
+/// @param graphic An image to be shown on supported displays
+/// @param softButtons The the Soft buttons defined by the app
+/// @param customPresets The custom presets defined by the App
+/// @param metadata Text field metadata
+/// @return An SDLShow object
- (instancetype)initWithMainField1:(nullable NSString *)mainField1 mainField2:(nullable NSString *)mainField2 mainField3:(nullable NSString *)mainField3 mainField4:(nullable NSString *)mainField4 alignment:(nullable SDLTextAlignment)alignment statusBar:(nullable NSString *)statusBar mediaClock:(nullable NSString *)mediaClock mediaTrack:(nullable NSString *)mediaTrack graphic:(nullable SDLImage *)graphic softButtons:(nullable NSArray<SDLSoftButton *> *)softButtons customPresets:(nullable NSArray<NSString *> *)customPresets textFieldMetadata:(nullable SDLMetadataTags *)metadata;
/**
diff --git a/SmartDeviceLink/SDLShowConstantTBT.h b/SmartDeviceLink/SDLShowConstantTBT.h
index e3a484598..3ac01780d 100644
--- a/SmartDeviceLink/SDLShowConstantTBT.h
+++ b/SmartDeviceLink/SDLShowConstantTBT.h
@@ -16,6 +16,20 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLShowConstantTBT : SDLRPCRequest
+/// Convenience init to create navigation directions
+///
+/// @param navigationText1 The first line of text in a multi-line overlay screen
+/// @param navigationText2 The second line of text in a multi-line overlay screen
+/// @param eta Estimated Time of Arrival time at final destination
+/// @param timeToDestination The amount of time needed to reach the final destination
+/// @param totalDistance The distance to the final destination
+/// @param turnIcon An icon to show with the turn description
+/// @param nextTurnIcon An icon to show with the next turn description
+/// @param distanceToManeuver Fraction of distance till next maneuver
+/// @param distanceToManeuverScale Distance till next maneuver
+/// @param maneuverComplete If and when a maneuver has completed while an AlertManeuver is active, the app must send this value set to TRUE in order to clear the AlertManeuver overlay. If omitted the value will be assumed as FALSE
+/// @param softButtons Three dynamic SoftButtons available (first SoftButton is fixed to "Turns")
+/// @return An SDLShowConstantTBT object
- (instancetype)initWithNavigationText1:(nullable NSString *)navigationText1 navigationText2:(nullable NSString *)navigationText2 eta:(nullable NSString *)eta timeToDestination:(nullable NSString *)timeToDestination totalDistance:(nullable NSString *)totalDistance turnIcon:(nullable SDLImage *)turnIcon nextTurnIcon:(nullable SDLImage *)nextTurnIcon distanceToManeuver:(double)distanceToManeuver distanceToManeuverScale:(double)distanceToManeuverScale maneuverComplete:(BOOL)maneuverComplete softButtons:(nullable NSArray<SDLSoftButton *> *)softButtons;
/**
diff --git a/SmartDeviceLink/SDLSoftButton.h b/SmartDeviceLink/SDLSoftButton.h
index 742b1026c..9b75b20f4 100644
--- a/SmartDeviceLink/SDLSoftButton.h
+++ b/SmartDeviceLink/SDLSoftButton.h
@@ -16,10 +16,23 @@ NS_ASSUME_NONNULL_BEGIN
*/
@interface SDLSoftButton : SDLRPCStruct
+/// Convenience init
+///
+/// @param handler A handler that may optionally be run when an SDLSubscribeButton or SDLSoftButton has a corresponding notification occur
- (instancetype)initWithHandler:(nullable SDLRPCButtonNotificationHandler)handler;
+/// Convenience init
+///
+/// @param type Describes whether this soft button displays only text, only an image, or both
+/// @param text Optional text to display (if defined as TEXT or BOTH type)
+/// @param image Optional image struct for SoftButton (if defined as IMAGE or BOTH type)
+/// @param highlighted Displays in an alternate mode, e.g. with a colored background or foreground. Depends on the IVI system
+/// @param buttonId Value which is returned via OnButtonPress / OnButtonEvent
+/// @param systemAction Parameter indicating whether selecting a SoftButton shall call a specific system action
+/// @param handler A handler that may optionally be run when an SDLSubscribeButton or SDLSoftButton has a corresponding notification occur.
- (instancetype)initWithType:(SDLSoftButtonType)type text:(nullable NSString *)text image:(nullable SDLImage *)image highlighted:(BOOL)highlighted buttonId:(UInt16)buttonId systemAction:(nullable SDLSystemAction)systemAction handler:(nullable SDLRPCButtonNotificationHandler)handler;
+/// A handler that may optionally be run when an SDLSubscribeButton or SDLSoftButton has a corresponding notification occur.
@property (copy, nonatomic) SDLRPCButtonNotificationHandler handler;
/**
diff --git a/SmartDeviceLink/SDLSoftButtonObject.h b/SmartDeviceLink/SDLSoftButtonObject.h
index eb2512fca..298ecccf8 100644
--- a/SmartDeviceLink/SDLSoftButtonObject.h
+++ b/SmartDeviceLink/SDLSoftButtonObject.h
@@ -38,6 +38,7 @@ NS_ASSUME_NONNULL_BEGIN
*/
@property (copy, nonatomic, readonly) SDLSoftButtonState *currentState;
+/// Describes an on-screen button which may be presented in various contexts, e.g. templates or alerts
@property (strong, nonatomic, readonly) SDLSoftButton *currentStateSoftButton;
/**
@@ -57,7 +58,7 @@ NS_ASSUME_NONNULL_BEGIN
/**
Create a single-state soft button. For example, a button that brings up a Perform Interaction menu.
-
+
@param name The name of the button
@param state The single state of the button
@param eventHandler The handler to be called when the button is pressed
diff --git a/SmartDeviceLink/SDLSoftButtonState.h b/SmartDeviceLink/SDLSoftButtonState.h
index 48b4d7587..b9560d9c0 100644
--- a/SmartDeviceLink/SDLSoftButtonState.h
+++ b/SmartDeviceLink/SDLSoftButtonState.h
@@ -15,6 +15,7 @@
NS_ASSUME_NONNULL_BEGIN
+/// A soft button state, includes data such as text, name and artwork
@interface SDLSoftButtonState : NSObject
/**
diff --git a/SmartDeviceLink/SDLSpeak.h b/SmartDeviceLink/SDLSpeak.h
index ea8782d0c..31b69d85d 100644
--- a/SmartDeviceLink/SDLSpeak.h
+++ b/SmartDeviceLink/SDLSpeak.h
@@ -43,8 +43,16 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLSpeak : SDLRPCRequest
+/// Convenience init to create a speak message
+///
+/// @param ttsText The text to speak
+/// @return An SDLSpeak object
- (instancetype)initWithTTS:(NSString *)ttsText;
+/// Convenience init to create a speak message
+///
+/// @param ttsChunks An array of TTSChunk structs which, taken together, specify the phrase to be spoken
+/// @return An SDLSpeak object
- (instancetype)initWithTTSChunks:(NSArray<SDLTTSChunk *> *)ttsChunks;
/**
diff --git a/SmartDeviceLink/SDLSpeechCapabilities.h b/SmartDeviceLink/SDLSpeechCapabilities.h
index 6f25deebc..985de6171 100644
--- a/SmartDeviceLink/SDLSpeechCapabilities.h
+++ b/SmartDeviceLink/SDLSpeechCapabilities.h
@@ -4,7 +4,7 @@
#import "SDLEnum.h"
-/*
+/**
* Contains information about TTS capabilities on the SDL platform. Used in RegisterAppInterfaceResponse, and TTSChunk.
*
* @since SDL 1.0
diff --git a/SmartDeviceLink/SDLStaticIconName.h b/SmartDeviceLink/SDLStaticIconName.h
index fcda703f1..db143a9c7 100644
--- a/SmartDeviceLink/SDLStaticIconName.h
+++ b/SmartDeviceLink/SDLStaticIconName.h
@@ -8,892 +8,892 @@
#import "SDLEnum.h"
-/*
+/**
* Static icon names
*/
typedef SDLEnum SDLStaticIconName SDL_SWIFT_ENUM;
-/*
+/**
* Static icon accept call / active phone call in progress / initiate a phone call
*/
extern SDLStaticIconName const SDLStaticIconNameAcceptCall;
-/*
+/**
* Static icon add waypoint
*/
extern SDLStaticIconName const SDLStaticIconNameAddWaypoint;
-/*
+/**
* Static icon album
*/
extern SDLStaticIconName const SDLStaticIconNameAlbum;
-/*
+/**
* Static icon ambient lighting
*/
extern SDLStaticIconName const SDLStaticIconNameAmbientLighting;
-/*
+/**
* Static icon arrow - north
*/
extern SDLStaticIconName const SDLStaticIconNameArrowNorth;
-/*
+/**
* Static icon audio mute
*/
extern SDLStaticIconName const SDLStaticIconNameAudioMute;
-/*
+/**
* Static icon audiobook episode
*/
extern SDLStaticIconName const SDLStaticIconNameAudiobookEpisode;
-/*
+/**
* Static icon audiobook narrator
*/
extern SDLStaticIconName const SDLStaticIconNameAudiobookNarrator;
-/*
+/**
* Static icon auxillary audio
*/
extern SDLStaticIconName const SDLStaticIconNameAuxillaryAudio;
-/*
+/**
* Static icon back / return
*/
extern SDLStaticIconName const SDLStaticIconNameBack;
-/*
+/**
* Static icon battery capacity 0 of 5
*/
extern SDLStaticIconName const SDLStaticIconNameBatteryCapacity0Of5;
-/*
+/**
* Static icon battery capacity 1 of 5
*/
extern SDLStaticIconName const SDLStaticIconNameBatteryCapacity1Of5;
-/*
+/**
* Static icon battery capacity 2 of 5
*/
extern SDLStaticIconName const SDLStaticIconNameBatteryCapacity2Of5;
-/*
+/**
* Static icon battery capacity 3 of 5
*/
extern SDLStaticIconName const SDLStaticIconNameBatteryCapacity3Of5;
-/*
+/**
* Static icon battery capacity 4 of 5
*/
extern SDLStaticIconName const SDLStaticIconNameBatteryCapacity4Of5;
-/*
+/**
* Static icon battery capacity 5 of 5
*/
extern SDLStaticIconName const SDLStaticIconNameBatteryCapacity5Of5;
-/*
+/**
* Static icon bluetooth audio source
*/
extern SDLStaticIconName const SDLStaticIconNameBluetoothAudioSource;
-/*
+/**
* Static icon bluetooth1
*/
extern SDLStaticIconName const SDLStaticIconNameBluetooth1;
-/*
+/**
* Static icon bluetooth2
*/
extern SDLStaticIconName const SDLStaticIconNameBluetooth2;
-/*
+/**
* Static icon browse
*/
extern SDLStaticIconName const SDLStaticIconNameBrowse;
-/*
+/**
* Static icon cell phone in roaming mode
*/
extern SDLStaticIconName const SDLStaticIconNameCellPhoneInRoamingMode;
-/*
+/**
* Static icon cell service signal strength 0 of 5 bars
*/
extern SDLStaticIconName const SDLStaticIconNameCellServiceSignalStrength0Of5Bars;
-/*
+/**
* Static icon cell service signal strength 1 of 5 bars
*/
extern SDLStaticIconName const SDLStaticIconNameCellServiceSignalStrength1Of5Bars;
-/*
+/**
* Static icon cell service signal strength 2 of 5 bars
*/
extern SDLStaticIconName const SDLStaticIconNameCellServiceSignalStrength2Of5Bars;
-/*
+/**
* Static icon cell service signal strength 3 of 5 bars
*/
extern SDLStaticIconName const SDLStaticIconNameCellServiceSignalStrength3Of5Bars;
-/*
+/**
* Static icon cell service signal strength 4 of 5 bars
*/
extern SDLStaticIconName const SDLStaticIconNameCellServiceSignalStrength4Of5Bars;
-/*
+/**
* Static icon cell service signal strength 5 of 5 bars
*/
extern SDLStaticIconName const SDLStaticIconNameCellServiceSignalStrength5Of5Bars;
-/*
+/**
* Static icon change lane left
*/
extern SDLStaticIconName const SDLStaticIconNameChangeLaneLeft;
-/*
+/**
* Static icon change lane right
*/
extern SDLStaticIconName const SDLStaticIconNameChangeLaneRight;
-/*
+/**
* Static icon check box checked
*/
extern SDLStaticIconName const SDLStaticIconNameCheckBoxChecked;
-/*
+/**
* Static icon check box unchecked
*/
extern SDLStaticIconName const SDLStaticIconNameCheckBoxUnchecked;
-/*
+/**
* Static icon climate
*/
extern SDLStaticIconName const SDLStaticIconNameClimate;
-/*
+/**
* Static icon clock
*/
extern SDLStaticIconName const SDLStaticIconNameClock;
-/*
+/**
* Static icon compose (e.g. message)
*/
extern SDLStaticIconName const SDLStaticIconNameCompose;
-/*
+/**
* Static icon contact / person
*/
extern SDLStaticIconName const SDLStaticIconNameContact;
-/*
+/**
* Static icon continue
*/
extern SDLStaticIconName const SDLStaticIconNameContinue;
-/*
+/**
* Static icon dash / bullet point
*/
extern SDLStaticIconName const SDLStaticIconNameDash;
-/*
+/**
* Static icon date / calendar
*/
extern SDLStaticIconName const SDLStaticIconNameDate;
-/*
+/**
* Static icon delete/remove - trash
*/
extern SDLStaticIconName const SDLStaticIconNameDelete;
-/*
+/**
* Static icon destination
*/
extern SDLStaticIconName const SDLStaticIconNameDestination;
-/*
+/**
* Static icon destination ferry ahead
*/
extern SDLStaticIconName const SDLStaticIconNameDestinationFerryAhead;
-/*
+/**
* Static icon ebookmark (e.g. message, feed)
*/
extern SDLStaticIconName const SDLStaticIconNameEbookmark;
-/*
+/**
* Static icon empty (i.e. no image)
*/
extern SDLStaticIconName const SDLStaticIconNameEmpty;
-/*
+/**
* Static icon end call / reject call
*/
extern SDLStaticIconName const SDLStaticIconNameEndCall;
-/*
+/**
* Static icon fail / X
*/
extern SDLStaticIconName const SDLStaticIconNameFail;
-/*
+/**
* Static icon fast forward 30 secs
*/
extern SDLStaticIconName const SDLStaticIconNameFastForward30Secs;
-/*
+/**
* Static icon favorite / heart
*/
extern SDLStaticIconName const SDLStaticIconNameFavoriteHeart;
-/*
+/**
* Static icon favorite / star
*/
extern SDLStaticIconName const SDLStaticIconNameFavoriteStar;
-/*
+/**
* Static icon fax number
*/
extern SDLStaticIconName const SDLStaticIconNameFaxNumber;
-/*
+/**
* Static icon filename
*/
extern SDLStaticIconName const SDLStaticIconNameFilename;
-/*
+/**
* Static icon filter / search
*/
extern SDLStaticIconName const SDLStaticIconNameFilter;
-/*
+/**
* Static icon folder
*/
extern SDLStaticIconName const SDLStaticIconNameFolder;
-/*
+/**
* Static icon fuel prices
*/
extern SDLStaticIconName const SDLStaticIconNameFuelPrices;
-/*
+/**
* Static icon full map
*/
extern SDLStaticIconName const SDLStaticIconNameFullMap;
-/*
+/**
* Static icon generic phone number
*/
extern SDLStaticIconName const SDLStaticIconNameGenericPhoneNumber;
-/*
+/**
* Static icon genre
*/
extern SDLStaticIconName const SDLStaticIconNameGenre;
-/*
+/**
* Static icon global keyboard
*/
extern SDLStaticIconName const SDLStaticIconNameGlobalKeyboard;
-/*
+/**
* Static icon highway exit information
*/
extern SDLStaticIconName const SDLStaticIconNameHighwayExitInformation;
-/*
+/**
* Static icon home phone number
*/
extern SDLStaticIconName const SDLStaticIconNameHomePhoneNumber;
-/*
+/**
* Static icon hyperlink
*/
extern SDLStaticIconName const SDLStaticIconNameHyperlink;
-/*
+/**
* Static icon ID3 tag unknown
*/
extern SDLStaticIconName const SDLStaticIconNameID3TagUnknown;
-/*
+/**
* Static icon incoming calls (in list of phone calls)
*/
extern SDLStaticIconName const SDLStaticIconNameIncomingCalls;
-/*
+/**
* Static icon information
*/
extern SDLStaticIconName const SDLStaticIconNameInformation;
-/*
+/**
* Static icon IPOD media source
*/
extern SDLStaticIconName const SDLStaticIconNameIPodMediaSource;
-/*
+/**
* Static icon join calls
*/
extern SDLStaticIconName const SDLStaticIconNameJoinCalls;
-/*
+/**
* Static icon keep left
*/
extern SDLStaticIconName const SDLStaticIconNameKeepLeft;
-/*
+/**
* Static icon keep right
*/
extern SDLStaticIconName const SDLStaticIconNameKeepRight;
-/*
+/**
* Static icon key / keycode
*/
extern SDLStaticIconName const SDLStaticIconNameKey;
-/*
+/**
* Static icon left
*/
extern SDLStaticIconName const SDLStaticIconNameLeft;
-/*
+/**
* Static icon left arrow / back
*/
extern SDLStaticIconName const SDLStaticIconNameLeftArrow;
-/*
+/**
* Static icon left exit
*/
extern SDLStaticIconName const SDLStaticIconNameLeftExit;
-/*
+/**
* Static icon LINE IN audio source
*/
extern SDLStaticIconName const SDLStaticIconNameLineInAudioSource;
-/*
+/**
* Static icon locked
*/
extern SDLStaticIconName const SDLStaticIconNameLocked;
-/*
+/**
* Static icon media control - left arrow
*/
extern SDLStaticIconName const SDLStaticIconNameMediaControlLeftArrow;
-/*
+/**
* Static icon media control - recording
*/
extern SDLStaticIconName const SDLStaticIconNameMediaControlRecording;
-/*
+/**
* Static icon media control - right arrow
*/
extern SDLStaticIconName const SDLStaticIconNameMediaControlRightArrow;
-/*
+/**
* Static icon media control - stop (e.g. streaming)
*/
extern SDLStaticIconName const SDLStaticIconNameMediaControlStop;
-/*
+/**
* Static icon microphone
*/
extern SDLStaticIconName const SDLStaticIconNameMicrophone;
-/*
+/**
* Static icon missed calls (in list of phone calls)
*/
extern SDLStaticIconName const SDLStaticIconNameMissedCalls;
-/*
+/**
* Static icon mobile phone number
*/
extern SDLStaticIconName const SDLStaticIconNameMobilePhoneNumber;
-/*
+/**
* Static icon move down / download
*/
extern SDLStaticIconName const SDLStaticIconNameMoveDown;
-/*
+/**
* Static icon move up
*/
extern SDLStaticIconName const SDLStaticIconNameMoveUp;
-/*
+/**
* Static icon MP3 tag artist
*/
extern SDLStaticIconName const SDLStaticIconNameMP3TagArtist;
-/*
+/**
* Static icon navigation / navigation settings
*/
extern SDLStaticIconName const SDLStaticIconNameNavigation;
-/*
+/**
* Static icon navigation current direction
*/
extern SDLStaticIconName const SDLStaticIconNameNavigationCurrentDirection;
-/*
+/**
* Static icon negative rating - thumbs down
*/
extern SDLStaticIconName const SDLStaticIconNameNegativeRatingThumbsDown;
-/*
+/**
* Static icon new/unread text message/email
*/
extern SDLStaticIconName const SDLStaticIconNameNew;
-/*
+/**
* Static icon office phone number / work phone number
*/
extern SDLStaticIconName const SDLStaticIconNameOfficePhoneNumber;
-/*
+/**
* Static icon opened/read text message/email
*/
extern SDLStaticIconName const SDLStaticIconNameOpened;
-/*
+/**
* Static icon origin / nearby locale / current position
*/
extern SDLStaticIconName const SDLStaticIconNameOrigin;
-/*
+/**
* Static icon outgoing calls (in list of phone calls)
*/
extern SDLStaticIconName const SDLStaticIconNameOutgoingCalls;
-/*
+/**
* Static icon play / pause - pause active
*/
extern SDLStaticIconName const SDLStaticIconNamePause;
-/*
+/**
* Static icon phone call 1
*/
extern SDLStaticIconName const SDLStaticIconNamePhoneCall1;
-/*
+/**
* Static icon phone call 2
*/
extern SDLStaticIconName const SDLStaticIconNamePhoneCall2;
-/*
+/**
* Static icon phone device
*/
extern SDLStaticIconName const SDLStaticIconNamePhoneDevice;
-/*
+/**
* Static icon phonebook
*/
extern SDLStaticIconName const SDLStaticIconNamePhonebook;
-/*
+/**
* Static icon photo / picture
*/
extern SDLStaticIconName const SDLStaticIconNamePhoto;
-/*
+/**
* Static icon play / pause - play active
*/
extern SDLStaticIconName const SDLStaticIconNamePlay;
-/*
+/**
* Static icon playlist
*/
extern SDLStaticIconName const SDLStaticIconNamePlaylist;
-/*
+/**
* Static icon pop-up
*/
extern SDLStaticIconName const SDLStaticIconNamePopUp;
-/*
+/**
* Static icon positive rating - thumbs up
*/
extern SDLStaticIconName const SDLStaticIconNamePositiveRatingThumbsUp;
-/*
+/**
* Static icon power
*/
extern SDLStaticIconName const SDLStaticIconNamePower;
-/*
+/**
* Static icon primary phone (favorite)
*/
extern SDLStaticIconName const SDLStaticIconNamePrimaryPhone;
-/*
+/**
* Static icon radio button checked
*/
extern SDLStaticIconName const SDLStaticIconNameRadioButtonChecked;
-/*
+/**
* Static icon radio button unchecked
*/
extern SDLStaticIconName const SDLStaticIconNameRadioButtonUnchecked;
-/*
+/**
* Static icon recent calls / history
*/
extern SDLStaticIconName const SDLStaticIconNameRecentCalls;
-/*
+/**
* Static icon recent destinations
*/
extern SDLStaticIconName const SDLStaticIconNameRecentDestinations;
-/*
+/**
* Static icon redo
*/
extern SDLStaticIconName const SDLStaticIconNameRedo;
-/*
+/**
* Static icon refresh
*/
extern SDLStaticIconName const SDLStaticIconNameRefresh;
-/*
+/**
* Static icon remote diagnostics - check engine
*/
extern SDLStaticIconName const SDLStaticIconNameRemoteDiagnosticsCheckEngine;
-/*
+/**
* Static icon rendered 911 assist / emergency assistance
*/
extern SDLStaticIconName const SDLStaticIconNameRendered911Assist;
-/*
+/**
* Static icon repeat
*/
extern SDLStaticIconName const SDLStaticIconNameRepeat;
-/*
+/**
* Static icon repeat play
*/
extern SDLStaticIconName const SDLStaticIconNameRepeatPlay;
-/*
+/**
* Static icon reply
*/
extern SDLStaticIconName const SDLStaticIconNameReply;
-/*
+/**
* Static icon rewind 30 secs
*/
extern SDLStaticIconName const SDLStaticIconNameRewind30Secs;
-/*
+/**
* Static icon right
*/
extern SDLStaticIconName const SDLStaticIconNameRight;
-/*
+/**
* Static icon right exit
*/
extern SDLStaticIconName const SDLStaticIconNameRightExit;
-/*
+/**
* Static icon ringtones
*/
extern SDLStaticIconName const SDLStaticIconNameRingtones;
-/*
+/**
* Static icon roundabout left hand 1
*/
extern SDLStaticIconName const SDLStaticIconNameRoundaboutLeftHand1;
-/*
+/**
* Static icon roundabout left hand 2
*/
extern SDLStaticIconName const SDLStaticIconNameRoundaboutLeftHand2;
-/*
+/**
* Static icon roundabout left hand 3
*/
extern SDLStaticIconName const SDLStaticIconNameRoundaboutLeftHand3;
-/*
+/**
* Static icon roundabout left hand 4
*/
extern SDLStaticIconName const SDLStaticIconNameRoundaboutLeftHand4;
-/*
+/**
* Static icon roundabout left hand 5
*/
extern SDLStaticIconName const SDLStaticIconNameRoundaboutLeftHand5;
-/*
+/**
* Static icon roundabout left hand 6
*/
extern SDLStaticIconName const SDLStaticIconNameRoundaboutLeftHand6;
-/*
+/**
* Static icon roundabout left hand 7
*/
extern SDLStaticIconName const SDLStaticIconNameRoundaboutLeftHand7;
-/*
+/**
* Static icon roundabout right hand 1
*/
extern SDLStaticIconName const SDLStaticIconNameRoundaboutRightHand1;
-/*
+/**
* Static icon roundabout right hand 2
*/
extern SDLStaticIconName const SDLStaticIconNameRoundaboutRightHand2;
-/*
+/**
* Static icon roundabout right hand 3
*/
extern SDLStaticIconName const SDLStaticIconNameRoundaboutRightHand3;
-/*
+/**
* Static icon roundabout right hand 4
*/
extern SDLStaticIconName const SDLStaticIconNameRoundaboutRightHand4;
-/*
+/**
* Static icon roundabout right hand 5
*/
extern SDLStaticIconName const SDLStaticIconNameRoundaboutRightHand5;
-/*
+/**
* Static icon roundabout right hand 6
*/
extern SDLStaticIconName const SDLStaticIconNameRoundaboutRightHand6;
-/*
+/**
* Static icon roundabout right hand 7
*/
extern SDLStaticIconName const SDLStaticIconNameRoundaboutRightHand7;
-/*
+/**
* Static icon RSS
*/
extern SDLStaticIconName const SDLStaticIconNameRSS;
-/*
+/**
* Static icon settings / menu
*/
extern SDLStaticIconName const SDLStaticIconNameSettings;
-/*
+/**
* Static icon sharp left
*/
extern SDLStaticIconName const SDLStaticIconNameSharpLeft;
-/*
+/**
* Static icon sharp right
*/
extern SDLStaticIconName const SDLStaticIconNameSharpRight;
-/*
+/**
* Static icon show
*/
extern SDLStaticIconName const SDLStaticIconNameShow;
-/*
+/**
* Static icon shuffle play
*/
extern SDLStaticIconName const SDLStaticIconNameShufflePlay;
-/*
+/**
* Static icon ski places / elevation / altitude
*/
extern SDLStaticIconName const SDLStaticIconNameSkiPlaces;
-/*
+/**
* Static icon slight left
*/
extern SDLStaticIconName const SDLStaticIconNameSlightLeft;
-/*
+/**
* Static icon slight right
*/
extern SDLStaticIconName const SDLStaticIconNameSlightRight;
-/*
+/**
* Static icon smartphone
*/
extern SDLStaticIconName const SDLStaticIconNameSmartphone;
-/*
+/**
* Static icon sort list
*/
extern SDLStaticIconName const SDLStaticIconNameSortList;
-/*
+/**
* Static icon speed dial numbers - number 0
*/
extern SDLStaticIconName const SDLStaticIconNameSpeedDialNumbersNumber0;
-/*
+/**
* Static icon speed dial numbers - number 1
*/
extern SDLStaticIconName const SDLStaticIconNameSpeedDialNumbersNumber1;
-/*
+/**
* Static icon speed dial numbers - number 2
*/
extern SDLStaticIconName const SDLStaticIconNameSpeedDialNumbersNumber2;
-/*
+/**
* Static icon speed dial numbers - number 3
*/
extern SDLStaticIconName const SDLStaticIconNameSpeedDialNumbersNumber3;
-/*
+/**
* Static icon speed dial numbers - number 4
*/
extern SDLStaticIconName const SDLStaticIconNameSpeedDialNumbersNumber4;
-/*
+/**
* Static icon speed dial numbers - number 5
*/
extern SDLStaticIconName const SDLStaticIconNameSpeedDialNumbersNumber5;
-/*
+/**
* Static icon speed dial numbers - number 6
*/
extern SDLStaticIconName const SDLStaticIconNameSpeedDialNumbersNumber6;
-/*
+/**
* Static icon speed dial numbers - number 7
*/
extern SDLStaticIconName const SDLStaticIconNameSpeedDialNumbersNumber7;
-/*
+/**
* Static icon speed dial numbers - number 8
*/
extern SDLStaticIconName const SDLStaticIconNameSpeedDialNumbersNumber8;
-/*
+/**
* Static icon speed dial numbers - number 9
*/
extern SDLStaticIconName const SDLStaticIconNameSpeedDialNumbersNumber9;
-/*
+/**
* Static icon success / check
*/
extern SDLStaticIconName const SDLStaticIconNameSuccess;
-/*
+/**
* Static icon track title / song title
*/
extern SDLStaticIconName const SDLStaticIconNameTrackTitle;
-/*
+/**
* Static icon traffic report
*/
extern SDLStaticIconName const SDLStaticIconNameTrafficReport;
-/*
+/**
* Static icon turn list
*/
extern SDLStaticIconName const SDLStaticIconNameTurnList;
-/*
+/**
* Static icon u-turn left traffic
*/
extern SDLStaticIconName const SDLStaticIconNameUTurnLeftTraffic;
-/*
+/**
* Static icon u-turn right traffic
*/
extern SDLStaticIconName const SDLStaticIconNameUTurnRightTraffic;
-/*
+/**
* Static icon undo
*/
extern SDLStaticIconName const SDLStaticIconNameUndo;
-/*
+/**
* Static icon unlocked
*/
extern SDLStaticIconName const SDLStaticIconNameUnlocked;
-/*
+/**
* Static icon USB media audio source
*/
extern SDLStaticIconName const SDLStaticIconNameUSBMediaAudioSource;
-/*
+/**
* Static icon voice control scrollbar - list item no. 1
*/
extern SDLStaticIconName const SDLStaticIconNameVoiceControlScrollbarListItemNo1;
-/*
+/**
* Static icon voice control scrollbar - list item no. 2
*/
extern SDLStaticIconName const SDLStaticIconNameVoiceControlScrollbarListItemNo2;
-/*
+/**
* Static icon voice control scrollbar - list item no. 3
*/
extern SDLStaticIconName const SDLStaticIconNameVoiceControlScrollbarListItemNo3;
-/*
+/**
* Static icon voice control scrollbar - list item no. 4
*/
extern SDLStaticIconName const SDLStaticIconNameVoiceControlScrollbarListItemNo4;
-/*
+/**
* Static icon voice recognition - failed
*/
extern SDLStaticIconName const SDLStaticIconNameVoiceRecognitionFailed;
-/*
+/**
* Static icon voice recognition - pause
*/
extern SDLStaticIconName const SDLStaticIconNameVoiceRecognitionPause;
-/*
+/**
* Static icon voice recognition - successful
*/
extern SDLStaticIconName const SDLStaticIconNameVoiceRecognitionSuccessful;
-/*
+/**
* Static icon voice recognition - system active
*/
extern SDLStaticIconName const SDLStaticIconNameVoiceRecognitionSystemActive;
-/*
+/**
* Static icon voice recognition - system listening
*/
extern SDLStaticIconName const SDLStaticIconNameVoiceRecognitionSystemListening;
-/*
+/**
* Static icon voice recognition - try again
*/
extern SDLStaticIconName const SDLStaticIconNameVoiceRecognitionTryAgain;
-/*
+/**
* Static icon warning / safety alert
*/
extern SDLStaticIconName const SDLStaticIconNameWarning;
-/*
+/**
* Static icon weather
*/
extern SDLStaticIconName const SDLStaticIconNameWeather;
-/*
+/**
* Static icon wifi full
*/
extern SDLStaticIconName const SDLStaticIconNameWifiFull;
-/*
+/**
* Static icon zoom in
*/
extern SDLStaticIconName const SDLStaticIconNameZoomIn;
-/*
+/**
* Static icon zoom out
*/
extern SDLStaticIconName const SDLStaticIconNameZoomOut;