*vrCommands;
/**
- * @abstract Image struct containing a static or dynamic icon
+ * Image struct containing a static or dynamic icon
*
* @discussion If provided, defines the image to be be shown along with a command
*
diff --git a/SmartDeviceLink/SDLAddCommandResponse.h b/SmartDeviceLink/SDLAddCommandResponse.h
index 554f59d82..29b305fc8 100644
--- a/SmartDeviceLink/SDLAddCommandResponse.h
+++ b/SmartDeviceLink/SDLAddCommandResponse.h
@@ -5,9 +5,9 @@
/**
- * SDLAddCommandResponse is sent, when SDLAddCommand has been called
- *
- * Since SmartDeviceLink 1.0
+ Response to `SDLAddCommand`
+
+ Since SmartDeviceLink 1.0
*/
NS_ASSUME_NONNULL_BEGIN
diff --git a/SmartDeviceLink/SDLAddSubMenu.h b/SmartDeviceLink/SDLAddSubMenu.h
index b411a43bd..7a4471f60 100644
--- a/SmartDeviceLink/SDLAddSubMenu.h
+++ b/SmartDeviceLink/SDLAddSubMenu.h
@@ -26,14 +26,14 @@ NS_ASSUME_NONNULL_BEGIN
- (instancetype)initWithId:(UInt32)menuId menuName:(NSString *)menuName position:(UInt8)position;
/**
- * @abstract a Menu ID that identifies a sub menu
+ * a Menu ID that identifies a sub menu
* @discussion This value is used in
* SDLAddCommand to which SDLSubMenu is the parent of the command being added
*
*/
@property (strong, nonatomic) NSNumber *menuID;
/**
- * @abstract a position of menu
+ * a position of menu
* @discussion An NSNumber pointer representing the position within the items
* of the top level Command Menu. 0 will insert at the front, 1
* will insert after the first existing element, etc. Position of
@@ -52,7 +52,7 @@ NS_ASSUME_NONNULL_BEGIN
*/
@property (nullable, strong, nonatomic) NSNumber *position;
/**
- * @abstract a menuName which is displayed representing this submenu item
+ * a menuName which is displayed representing this submenu item
* @discussion NSString which will be displayed representing this submenu item
*/
@property (strong, nonatomic) NSString *menuName;
diff --git a/SmartDeviceLink/SDLAddSubMenuResponse.h b/SmartDeviceLink/SDLAddSubMenuResponse.h
index 17305aace..4f7db98fc 100644
--- a/SmartDeviceLink/SDLAddSubMenuResponse.h
+++ b/SmartDeviceLink/SDLAddSubMenuResponse.h
@@ -4,8 +4,9 @@
#import "SDLRPCResponse.h"
/**
- * SDLAddSubMenuResponse is sent, when SDLAddSubMenu has been called
- * Since SmartDeviceLink 1.0
+ Response to `SDLAddSubMenu`
+
+ Since SmartDeviceLink 1.0
*/
NS_ASSUME_NONNULL_BEGIN
diff --git a/SmartDeviceLink/SDLAirbagStatus.h b/SmartDeviceLink/SDLAirbagStatus.h
index ce10945c7..140b6af07 100644
--- a/SmartDeviceLink/SDLAirbagStatus.h
+++ b/SmartDeviceLink/SDLAirbagStatus.h
@@ -7,15 +7,65 @@
NS_ASSUME_NONNULL_BEGIN
+/**
+ A vehicle data status struct for airbags
+ */
@interface SDLAirbagStatus : SDLRPCStruct
+/**
+ References signal "VedsDrvBag_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus driverAirbagDeployed;
+
+/**
+ References signal "VedsDrvSideBag_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus driverSideAirbagDeployed;
+
+/**
+ References signal "VedsDrvCrtnBag_D_Ltchd". See VehicleDataEventStatus
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus driverCurtainAirbagDeployed;
+
+/**
+ References signal "VedsPasBag_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus passengerAirbagDeployed;
+
+/**
+ References signal "VedsPasCrtnBag_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus passengerCurtainAirbagDeployed;
+
+/**
+ References signal "VedsKneeDrvBag_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus driverKneeAirbagDeployed;
+
+/**
+ References signal "VedsPasSideBag_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus passengerSideAirbagDeployed;
+
+/**
+ References signal "VedsKneePasBag_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus passengerKneeAirbagDeployed;
@end
diff --git a/SmartDeviceLink/SDLAlert.h b/SmartDeviceLink/SDLAlert.h
index d8f893b7e..ad97d7e43 100644
--- a/SmartDeviceLink/SDLAlert.h
+++ b/SmartDeviceLink/SDLAlert.h
@@ -63,7 +63,7 @@ NS_ASSUME_NONNULL_BEGIN
/**
- * @abstract The String to be displayed in the first field of the display during the Alert
+ * The String to be displayed in the first field of the display during the Alert
*
* @discussion Length is limited to what is indicated in *SDLRegisterAppInterface* response
*
@@ -76,7 +76,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSString *alertText1;
/**
- * @abstract The String to be displayed in the second field of the display during the Alert
+ * The String to be displayed in the second field of the display during the Alert
*
* @discussion Only permitted if HMI supports a second display line
*
@@ -91,7 +91,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSString *alertText2;
/**
- * @abstract the String to be displayed in the third field of the display during the Alert
+ * the String to be displayed in the third field of the display during the Alert
* @discussion Only permitted if HMI supports a third display line
*
* Length is limited to what is indicated in *SDLRegisterAppInterface* response
@@ -105,7 +105,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSString *alertText3;
/**
- * @abstract An array which, taken together, specify what is to be spoken to the user
+ * An array which, taken together, specify what is to be spoken to the user
*
* Optional, Array of SDLTTSChunk, Array length 1 - 100
*
@@ -114,7 +114,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSArray *ttsChunks;
/**
- * @abstract The duration of the displayed portion of the alert, in milliseconds.
+ * The duration of the displayed portion of the alert, in milliseconds.
*
* @discussion After this amount of time has passed, the display fields alertText1 and alertText2 will revert to what was displayed in those fields before the alert began.
*
@@ -127,7 +127,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSNumber *duration;
/**
- * @abstract Whether the alert tone should be played before the TTS (if any) is spoken.
+ * Whether the alert tone should be played before the TTS (if any) is spoken.
*
* @discussion If ommitted, no tone is played
*
@@ -136,7 +136,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSNumber *playTone;
/**
- * @abstract If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc.
+ * If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc.
*
* Optional, Boolean
*
@@ -145,7 +145,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSNumber *progressIndicator;
/**
- * @abstract App defined SoftButtons.
+ * App defined SoftButtons.
*
* @discussion If omitted on supported displays, the displayed alert shall not have any SoftButtons
*
diff --git a/SmartDeviceLink/SDLAlertManeuver.h b/SmartDeviceLink/SDLAlertManeuver.h
index b7181c04f..afb0e51e1 100644
--- a/SmartDeviceLink/SDLAlertManeuver.h
+++ b/SmartDeviceLink/SDLAlertManeuver.h
@@ -9,6 +9,8 @@
/**
+ * Shows a SDLShowConstantTBT message with an optional voice command. This message is shown as an overlay over the display's base screen.
+ *
* @since SmartDeviceLink 1.0
*/
@@ -19,7 +21,22 @@ NS_ASSUME_NONNULL_BEGIN
- (instancetype)initWithTTS:(nullable NSString *)ttsText softButtons:(nullable NSArray *)softButtons;
- (instancetype)initWithTTSChunks:(nullable NSArray *)ttsChunks softButtons:(nullable NSArray *)softButtons;
+/**
+ * An array of text chunks.
+ *
+ * Optional, Array of SDLTTSChunk, Array length 1 - 100
+ *
+ * @see SDLTTSChunk
+ */
@property (nullable, strong, nonatomic) NSArray *ttsChunks;
+
+/**
+ * An arry of soft buttons. If omitted on supported displays, only the system defined "Close" SoftButton shall be displayed.
+ *
+ * Optional, Array of SDLSoftButton, Array length 0 - 3
+ *
+ * @see SDLSoftButton
+ */
@property (nullable, strong, nonatomic) NSArray *softButtons;
@end
diff --git a/SmartDeviceLink/SDLAlertManeuverResponse.h b/SmartDeviceLink/SDLAlertManeuverResponse.h
index d541cde0e..39a5d536b 100644
--- a/SmartDeviceLink/SDLAlertManeuverResponse.h
+++ b/SmartDeviceLink/SDLAlertManeuverResponse.h
@@ -4,8 +4,10 @@
#import "SDLRPCResponse.h"
-/** SDLAlertManeuverResponse is sent, when SDLAlertManeuver has been called.
- * @since SmartDeviceLink 1.0
+/**
+ Response to SDLAlertManeuver
+
+ @since SmartDeviceLink 1.0
*/
NS_ASSUME_NONNULL_BEGIN
diff --git a/SmartDeviceLink/SDLAlertResponse.h b/SmartDeviceLink/SDLAlertResponse.h
index a2883778c..771d666e1 100644
--- a/SmartDeviceLink/SDLAlertResponse.h
+++ b/SmartDeviceLink/SDLAlertResponse.h
@@ -5,8 +5,9 @@
#import "SDLRPCResponse.h"
/**
- * Sent after SDLAlert has been sent
- * @since SDL 1.0
+ Response to SDLAlert
+
+ @since SDL 1.0
*/
NS_ASSUME_NONNULL_BEGIN
diff --git a/SmartDeviceLink/SDLAmbientLightStatus.h b/SmartDeviceLink/SDLAmbientLightStatus.h
index 0a1235a8b..f4663ec61 100644
--- a/SmartDeviceLink/SDLAmbientLightStatus.h
+++ b/SmartDeviceLink/SDLAmbientLightStatus.h
@@ -5,16 +5,48 @@
#import "SDLEnum.h"
/**
- * Reflects the status of the ambient light sensor
+ * Reflects the status of the ambient light sensor for headlamps
+ *
* @since SDL 3.0
*/
typedef SDLEnum SDLAmbientLightStatus SDL_SWIFT_ENUM;
+/**
+ * Represents a "night" ambient light status
+ */
extern SDLAmbientLightStatus const SDLAmbientLightStatusNight;
+
+/**
+ * Represents a "twilight 1" ambient light status
+ */
extern SDLAmbientLightStatus const SDLAmbientLightStatusTwilight1;
+
+/**
+ * Represents a "twilight 2" ambient light status
+ */
extern SDLAmbientLightStatus const SDLAmbientLightStatusTwilight2;
+
+/**
+ * Represents a "twilight 3" ambient light status
+ */
extern SDLAmbientLightStatus const SDLAmbientLightStatusTwilight3;
+
+/**
+ * Represents a "twilight 4" ambient light status
+ */
extern SDLAmbientLightStatus const SDLAmbientLightStatusTwilight4;
+
+/**
+ * Represents a "day" ambient light status
+ */
extern SDLAmbientLightStatus const SDLAmbientLightStatusDay;
+
+/**
+ * Represents an "unknown" ambient light status
+ */
extern SDLAmbientLightStatus const SDLAmbientLightStatusUnknown;
+
+/**
+ * Represents a "invalid" ambient light status
+ */
extern SDLAmbientLightStatus const SDLAmbientLightStatusInvalid;
diff --git a/SmartDeviceLink/SDLAppHMIType.h b/SmartDeviceLink/SDLAppHMIType.h
index 021f324e3..21ff96e61 100644
--- a/SmartDeviceLink/SDLAppHMIType.h
+++ b/SmartDeviceLink/SDLAppHMIType.h
@@ -12,57 +12,60 @@
typedef SDLEnum SDLAppHMIType SDL_SWIFT_ENUM;
/**
- * @abstract The App will have default rights.
+ * The App will have default rights.
*/
extern SDLAppHMIType const SDLAppHMITypeDefault;
/**
- * @abstract Communication type of App
+ * Communication type of App
*/
extern SDLAppHMIType const SDLAppHMITypeCommunication;
/**
- * @abstract App dealing with Media
+ * App dealing with Media
*/
extern SDLAppHMIType const SDLAppHMITypeMedia;
/**
- * @abstract Messaging App
+ * Messaging App
*/
extern SDLAppHMIType const SDLAppHMITypeMessaging;
/**
- * @abstract Navigation App
+ * Navigation App
*/
extern SDLAppHMIType const SDLAppHMITypeNavigation;
/**
- * @abstract Information App
+ * Information App
*/
extern SDLAppHMIType const SDLAppHMITypeInformation;
/**
- * @abstract App dealing with social media
+ * App dealing with social media
*/
extern SDLAppHMIType const SDLAppHMITypeSocial;
/**
- * @abstract App dealing with Mobile Projection applications
+ * App dealing with Mobile Projection applications
*/
extern SDLAppHMIType const SDLAppHMITypeProjection;
+/**
+ * App designed for use in the background
+ */
extern SDLAppHMIType const SDLAppHMITypeBackgroundProcess;
/**
- * @abstract App only for Testing purposes
+ * App only for Testing purposes
*/
extern SDLAppHMIType const SDLAppHMITypeTesting;
/**
- * @abstract System App
+ * System App
*/
extern SDLAppHMIType const SDLAppHMITypeSystem;
/**
- * @abstract Remote control */
+ * Remote control */
extern SDLAppHMIType const SDLAppHMITypeRemoteControl;
diff --git a/SmartDeviceLink/SDLAppInfo.h b/SmartDeviceLink/SDLAppInfo.h
index 98a573970..c73064de8 100644
--- a/SmartDeviceLink/SDLAppInfo.h
+++ b/SmartDeviceLink/SDLAppInfo.h
@@ -5,12 +5,32 @@
NS_ASSUME_NONNULL_BEGIN
+/**
+ A struct used in register app interface. Contains detailed information about the registered application.
+ */
@interface SDLAppInfo : SDLRPCStruct
+ (instancetype)currentAppInfo;
+/**
+ The name displayed for the mobile application on the mobile device (can differ from the app name set in the initial RAI request).
+
+ Required
+ */
@property (strong, nonatomic) NSString *appDisplayName;
+
+/**
+ The AppBundleID of an iOS application or package name of the Android application. This supports App Launch strategies for each platform.
+
+ Required
+ */
@property (strong, nonatomic) NSString *appBundleID;
+
+/**
+ Represents the build version number of this particular mobile app.
+
+ Required
+ */
@property (strong, nonatomic) NSString *appVersion;
@end
diff --git a/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.h b/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.h
index 0cdf0f192..79b3f1cf4 100644
--- a/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.h
+++ b/SmartDeviceLink/SDLAppInterfaceUnregisteredReason.h
@@ -13,52 +13,52 @@ typedef SDLEnum SDLAppInterfaceUnregisteredReason SDL_SWIFT_ENUM;
/**
- * @abstract Vehicle ignition turned off.
+ * Vehicle ignition turned off.
*/
extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonIgnitionOff;
/**
- * @abstract Bluetooth was turned off, causing termination of a necessary Bluetooth connection.
+ * Bluetooth was turned off, causing termination of a necessary Bluetooth connection.
*/
extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonBluetoothOff;
/**
- * @abstract USB was disconnected, causing termination of a necessary iAP connection.
+ * USB was disconnected, causing termination of a necessary iAP connection.
*/
extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonUSBDisconnected;
/**
- * @abstract Application attempted SmartDeviceLink RPC request while HMILevel = NONE. App must have HMILevel other than NONE to issue RPC requests or get notifications or RPC responses.
+ * Application attempted SmartDeviceLink RPC request while HMILevel = NONE. App must have HMILevel other than NONE to issue RPC requests or get notifications or RPC responses.
*/
extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonRequestWhileInNoneHMILevel;
/**
- * @abstract Either too many -- or too many per unit of time -- requests were made by the application.
+ * Either too many -- or too many per unit of time -- requests were made by the application.
*/
extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonTooManyRequests;
/**
- * @abstract The application has issued requests which cause driver distraction rules to be violated.
+ * The application has issued requests which cause driver distraction rules to be violated.
*/
extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonDriverDistractionViolation;
/**
- * @abstract The user performed a language change on the SDL platform, causing the application to need to be reregistered for the new language.
+ * The user performed a language change on the SDL platform, causing the application to need to be reregistered for the new language.
*/
extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonLanguageChange;
/**
- * @abstract The user performed a MASTER RESET on the SDL platform, causing removal of a necessary Bluetooth pairing.
+ * The user performed a MASTER RESET on the SDL platform, causing removal of a necessary Bluetooth pairing.
*/
extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonMasterReset;
/**
- * @abstract The user restored settings to FACTORY DEFAULTS on the SDL platform.
+ * The user restored settings to FACTORY DEFAULTS on the SDL platform.
*/
extern SDLAppInterfaceUnregisteredReason const SDLAppInterfaceUnregisteredReasonFactoryDefaults;
/**
- * @abstract The app is not being authorized to be connected to SDL.
+ * The app is not being authorized to be connected to SDL.
*
* @since SDL 2.0
*/
diff --git a/SmartDeviceLink/SDLArtwork.m b/SmartDeviceLink/SDLArtwork.m
index 062374858..bf2861b67 100644
--- a/SmartDeviceLink/SDLArtwork.m
+++ b/SmartDeviceLink/SDLArtwork.m
@@ -111,6 +111,30 @@ + (NSString *)sdl_md5HashFromNSData:(NSData *)data {
return formattedHash;
}
+#pragma mark - NSObject overrides
+
+- (NSUInteger)hash {
+ return self.name.hash ^ self.data.hash;
+}
+
+- (BOOL)isEqual:(id)object {
+ if (self == object) { return YES; }
+
+ if (![object isKindOfClass:[SDLArtwork class]]) { return NO; }
+
+ return [self isEqualToArtwork:(SDLArtwork *)object];
+}
+
+- (BOOL)isEqualToArtwork:(SDLArtwork *)artwork {
+ if (!artwork) { return NO; }
+
+ BOOL haveEqualNames = [self.name isEqualToString:artwork.name];
+ BOOL haveEqualData = [self.data isEqualToData:artwork.data];
+ BOOL haveEqualFormats = [self.fileType isEqualToEnum:artwork.fileType];
+
+ return haveEqualNames && haveEqualData && haveEqualFormats;
+}
+
@end
NS_ASSUME_NONNULL_END
diff --git a/SmartDeviceLink/SDLAsynchronousRPCRequestOperation.h b/SmartDeviceLink/SDLAsynchronousRPCRequestOperation.h
index b08c700a2..a24165dad 100644
--- a/SmartDeviceLink/SDLAsynchronousRPCRequestOperation.h
+++ b/SmartDeviceLink/SDLAsynchronousRPCRequestOperation.h
@@ -17,6 +17,8 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLAsynchronousRPCRequestOperation : SDLAsynchronousOperation
+@property (copy, nonatomic) NSArray *requests;
+
- (instancetype)initWithConnectionManager:(id)connectionManager requests:(NSArray *)requests progressHandler:(nullable SDLMultipleAsyncRequestProgressHandler)progressHandler completionHandler:(nullable SDLMultipleRequestCompletionHandler)completionHandler;
- (instancetype)initWithConnectionManager:(id)connectionManager request:(SDLRPCRequest *)request responseHandler:(nullable SDLResponseHandler)responseHandler;
diff --git a/SmartDeviceLink/SDLAsynchronousRPCRequestOperation.m b/SmartDeviceLink/SDLAsynchronousRPCRequestOperation.m
index a79b30b09..c92a23c74 100644
--- a/SmartDeviceLink/SDLAsynchronousRPCRequestOperation.m
+++ b/SmartDeviceLink/SDLAsynchronousRPCRequestOperation.m
@@ -16,7 +16,6 @@
@interface SDLAsynchronousRPCRequestOperation ()
-@property (copy, nonatomic) NSArray *requests;
@property (weak, nonatomic) id connectionManager;
@property (copy, nonatomic, nullable) SDLMultipleAsyncRequestProgressHandler progressHandler;
@property (copy, nonatomic, nullable) SDLMultipleRequestCompletionHandler completionHandler;
@@ -160,6 +159,14 @@ - (NSOperationQueuePriority)queuePriority {
return NSOperationQueuePriorityNormal;
}
+- (NSString *)description {
+ return [NSString stringWithFormat:@"%@, request count=%lu, requests started=%lu, finished=%lu, failed=%@", self.name, self.requests.count, self.requestsStarted, self.requestsComplete, (self.requestFailed ? @"YES": @"NO")];
+}
+
+- (NSString *)debugDescription {
+ return [NSString stringWithFormat:@"%@, request count=%lu, requests started=%lu, finished=%lu, failed=%@, requests=%@", self.name, self.requests.count, self.requestsStarted, self.requestsComplete, (self.requestFailed ? @"YES": @"NO"), self.requests];
+}
+
@end
NS_ASSUME_NONNULL_END
diff --git a/SmartDeviceLink/SDLAudioPassThruCapabilities.h b/SmartDeviceLink/SDLAudioPassThruCapabilities.h
index f4f14b598..67f229281 100644
--- a/SmartDeviceLink/SDLAudioPassThruCapabilities.h
+++ b/SmartDeviceLink/SDLAudioPassThruCapabilities.h
@@ -10,37 +10,8 @@
/**
* Describes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM}
- * Parameter List
- *
- *
- * | Name |
- * Type |
- * Description |
- * SmartDeviceLink Ver. Available |
- *
- *
- * | samplingRate |
- * SDLSamplingRate |
- * Describes the sampling rate for AudioPassThru
- * |
- * SmartDeviceLink 2.0 |
- *
- *
- * | bitsPerSample |
- * SDLBitsPerSample |
- * Describes the sample depth in bit for AudioPassThru
- * |
- * SmartDeviceLink 2.0 |
- *
- *
- * | audioType |
- * SDLAudioType |
- * Describes the audiotype for AudioPassThru
- * |
- * SmartDeviceLink 2.0 |
- *
- *
- * Since SmartDeviceLink 2.0
+
+ * Since SmartDeviceLink 2.0
*/
NS_ASSUME_NONNULL_BEGIN
@@ -48,18 +19,23 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLAudioPassThruCapabilities : SDLRPCStruct
/**
- * @abstract The sampling rate for AudioPassThru
- *
+ The sampling rate for AudioPassThru
+
+ Required
*/
@property (strong, nonatomic) SDLSamplingRate samplingRate;
+
/**
- * @abstract The sample depth in bit for AudioPassThru
- *
+ The sample depth in bit for AudioPassThru
+
+ Required
*/
@property (strong, nonatomic) SDLBitsPerSample bitsPerSample;
+
/**
- * @abstract The audiotype for AudioPassThru
- *
+ The audiotype for AudioPassThru
+
+ Required
*/
@property (strong, nonatomic) SDLAudioType audioType;
diff --git a/SmartDeviceLink/SDLAudioStreamManager.h b/SmartDeviceLink/SDLAudioStreamManager.h
index 1e4eb3969..e6608f8e1 100755
--- a/SmartDeviceLink/SDLAudioStreamManager.h
+++ b/SmartDeviceLink/SDLAudioStreamManager.h
@@ -25,13 +25,36 @@ typedef NS_ENUM(NSInteger, SDLAudioStreamManagerError) {
@interface SDLAudioStreamManager : NSObject
+/**
+ The delegate describing when files are done playing or any errors that occur
+ */
@property (weak, nonatomic) id delegate;
+/**
+ Whether or not we are currently playing audio
+ */
@property (assign, nonatomic, readonly, getter=isPlaying) BOOL playing;
+
+/**
+ The queue of audio files that will be played in sequence
+ */
@property (copy, nonatomic, readonly) NSArray *queue;
+/**
+ Init should only occur with dependencies. use `initWithManager:`
+
+ @return A failure
+ */
- (instancetype)init NS_UNAVAILABLE;
+/**
+ Create an audio stream manager with a reference to the parent stream manager.
+
+ @warning For internal use
+
+ @param streamManager The parent stream manager
+ @return The audio stream manager
+ */
- (instancetype)initWithManager:(id)streamManager NS_DESIGNATED_INITIALIZER;
/**
diff --git a/SmartDeviceLink/SDLAudioStreamManagerDelegate.h b/SmartDeviceLink/SDLAudioStreamManagerDelegate.h
index f1fdb781a..acad1472c 100755
--- a/SmartDeviceLink/SDLAudioStreamManagerDelegate.h
+++ b/SmartDeviceLink/SDLAudioStreamManagerDelegate.h
@@ -16,7 +16,23 @@ NS_ASSUME_NONNULL_BEGIN
@protocol SDLAudioStreamManagerDelegate
@required
+
+/**
+ Called when a file from the SDLAudioStreamManager finishes playing
+
+ @param audioManager A reference to the audio stream manager
+ @param fileURL The URL that finished playing
+ @param successfully Whether or not it was played successfully
+ */
- (void)audioStreamManager:(SDLAudioStreamManager *)audioManager fileDidFinishPlaying:(NSURL *)fileURL successfully:(BOOL)successfully;
+
+/**
+ Called when a file from the SDLAudioStreamManager could not play
+
+ @param audioManager A reference to the audio stream manager
+ @param fileURL The URL that failed
+ @param error The error that occurred
+ */
- (void)audioStreamManager:(SDLAudioStreamManager *)audioManager errorDidOccurForFile:(NSURL *)fileURL error:(NSError *)error;
@end
diff --git a/SmartDeviceLink/SDLAudioStreamingState.h b/SmartDeviceLink/SDLAudioStreamingState.h
index b786fffc8..6aa746757 100644
--- a/SmartDeviceLink/SDLAudioStreamingState.h
+++ b/SmartDeviceLink/SDLAudioStreamingState.h
@@ -12,18 +12,18 @@
typedef SDLEnum SDLAudioStreamingState SDL_SWIFT_ENUM;
/**
- * @abstract Currently streaming audio, if any, is audible to user.
+ * Currently streaming audio, if any, is audible to user.
*/
extern SDLAudioStreamingState const SDLAudioStreamingStateAudible;
/**
- * @abstract Some kind of audio mixing is taking place. Currently streaming audio, if any, is audible to the user at a lowered volume.
+ * Some kind of audio mixing is taking place. Currently streaming audio, if any, is audible to the user at a lowered volume.
*
* @since SDL 2.0
*/
extern SDLAudioStreamingState const SDLAudioStreamingStateAttenuated;
/**
- * @abstract Currently streaming audio, if any, is not audible to user. made via VR session.
+ * Currently streaming audio, if any, is not audible to user. made via VR session.
*/
extern SDLAudioStreamingState const SDLAudioStreamingStateNotAudible;
diff --git a/SmartDeviceLink/SDLAudioType.h b/SmartDeviceLink/SDLAudioType.h
index e040ffd6a..283be1ea8 100644
--- a/SmartDeviceLink/SDLAudioType.h
+++ b/SmartDeviceLink/SDLAudioType.h
@@ -10,7 +10,7 @@
typedef SDLEnum SDLAudioType SDL_SWIFT_ENUM;
/**
- * @abstract PCM raw audio
+ * PCM raw audio
*
* @since SDL 2.0
*/
diff --git a/SmartDeviceLink/SDLBeltStatus.h b/SmartDeviceLink/SDLBeltStatus.h
index 9b60b9dc7..4b71c3764 100644
--- a/SmartDeviceLink/SDLBeltStatus.h
+++ b/SmartDeviceLink/SDLBeltStatus.h
@@ -7,22 +7,114 @@
NS_ASSUME_NONNULL_BEGIN
+/**
+ Vehicle data struct for the seat belt status
+ */
@interface SDLBeltStatus : SDLRPCStruct
+/**
+ References signal "VedsDrvBelt_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus driverBeltDeployed;
+
+/**
+ References signal "VedsPasBelt_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus passengerBeltDeployed;
+
+/**
+ References signal "VedsRw1PasBckl_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus passengerBuckleBelted;
+
+/**
+ References signal "VedsRw1DrvBckl_D_Ltchd". See VehicleDataEventStatus
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus driverBuckleBelted;
+
+/**
+ References signal "VedsRw2lBckl_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus leftRow2BuckleBelted;
+
+/**
+ References signal "VedsRw1PasChld_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus passengerChildDetected;
+
+/**
+ References signal "VedsRw2rBckl_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus rightRow2BuckleBelted;
+
+/**
+ References signal "VedsRw2mBckl_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus middleRow2BuckleBelted;
+
+/**
+ References signal "VedsRw3mBckl_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus middleRow3BuckleBelted;
+
+/**
+ References signal "VedsRw3lBckl_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus leftRow3BuckleBelted;
+
+/**
+ References signal "VedsRw3rBckl_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus rightRow3BuckleBelted;
+
+/**
+ References signal "VedsRw2lRib_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus leftRearInflatableBelted;
+
+/**
+ References signal "VedsRw2rRib_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus rightRearInflatableBelted;
+
+/**
+ References signal "VedsRw1mBelt_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus middleRow1BeltDeployed;
+
+/**
+ References signal "VedsRw1mBckl_D_Ltchd". See VehicleDataEventStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataEventStatus middleRow1BuckleBelted;
@end
diff --git a/SmartDeviceLink/SDLBitsPerSample.h b/SmartDeviceLink/SDLBitsPerSample.h
index 55c99b242..366dab9ef 100644
--- a/SmartDeviceLink/SDLBitsPerSample.h
+++ b/SmartDeviceLink/SDLBitsPerSample.h
@@ -12,11 +12,11 @@
typedef SDLEnum SDLBitsPerSample SDL_SWIFT_ENUM;
/**
- * @abstract 8 bits per sample
+ * 8 bits per sample
*/
extern SDLBitsPerSample const SDLBitsPerSample8Bit;
/**
- * @abstract 16 bits per sample
+ * 16 bits per sample
*/
extern SDLBitsPerSample const SDLBitsPerSample16Bit;
diff --git a/SmartDeviceLink/SDLBodyInformation.h b/SmartDeviceLink/SDLBodyInformation.h
index a0d626b57..bed364503 100644
--- a/SmartDeviceLink/SDLBodyInformation.h
+++ b/SmartDeviceLink/SDLBodyInformation.h
@@ -16,37 +16,51 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLBodyInformation : SDLRPCStruct
/**
- * @abstract References signal "PrkBrkActv_B_Actl".
+ * References signal "PrkBrkActv_B_Actl".
+
+ Required
*/
@property (strong, nonatomic) NSNumber *parkBrakeActive;
/**
- * @abstract References signal "Ignition_Switch_Stable". See IgnitionStableStatus.
+ * References signal "Ignition_Switch_Stable". See IgnitionStableStatus.
+
+ Required
*/
@property (strong, nonatomic) SDLIgnitionStableStatus ignitionStableStatus;
/**
- * @abstract References signal "Ignition_status". See IgnitionStatus.
+ * References signal "Ignition_status". See IgnitionStatus.
+
+ Required
*/
@property (strong, nonatomic) SDLIgnitionStatus ignitionStatus;
/**
- * @abstract References signal "DrStatDrv_B_Actl".
+ * References signal "DrStatDrv_B_Actl".
+
+ Optional
*/
@property (nullable, strong, nonatomic) NSNumber *driverDoorAjar;
/**
- * @abstract References signal "DrStatPsngr_B_Actl".
+ * References signal "DrStatPsngr_B_Actl".
+
+ Optional
*/
@property (nullable, strong, nonatomic) NSNumber *passengerDoorAjar;
/**
- * @abstract References signal "DrStatRl_B_Actl".
+ * References signal "DrStatRl_B_Actl".
+
+ Optional
*/
@property (nullable, strong, nonatomic) NSNumber *rearLeftDoorAjar;
/**
- * @abstract References signal "DrStatRr_B_Actl".
+ * References signal "DrStatRr_B_Actl".
+
+ Optional
*/
@property (nullable, strong, nonatomic) NSNumber *rearRightDoorAjar;
diff --git a/SmartDeviceLink/SDLButtonCapabilities.h b/SmartDeviceLink/SDLButtonCapabilities.h
index cc24f84fa..35600f5b2 100644
--- a/SmartDeviceLink/SDLButtonCapabilities.h
+++ b/SmartDeviceLink/SDLButtonCapabilities.h
@@ -17,26 +17,28 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLButtonCapabilities : SDLRPCStruct
/**
- * @abstract The name of the SDL HMI button.
+ * The name of the SDL HMI button.
+
+ Required
*/
@property (strong, nonatomic) SDLButtonName name;
/**
- * @abstract A NSNumber value indicates whether the button supports a SHORT press
+ * A NSNumber value indicates whether the button supports a SHORT press
*
* Required, Boolean
*/
@property (strong, nonatomic) NSNumber *shortPressAvailable;
/**
- * @abstract A NSNumber value indicates whether the button supports a LONG press
+ * A NSNumber value indicates whether the button supports a LONG press
*
* Required, Boolean
*/
@property (strong, nonatomic) NSNumber *longPressAvailable;
/**
- * @abstract A NSNumber value indicates whether the button supports "button down" and "button up"
+ * A NSNumber value indicates whether the button supports "button down" and "button up"
*
* Required, Boolean
*/
diff --git a/SmartDeviceLink/SDLButtonEventMode.h b/SmartDeviceLink/SDLButtonEventMode.h
index 72cf5d3ec..5facb9f73 100644
--- a/SmartDeviceLink/SDLButtonEventMode.h
+++ b/SmartDeviceLink/SDLButtonEventMode.h
@@ -12,11 +12,11 @@
typedef SDLEnum SDLButtonEventMode SDL_SWIFT_ENUM;
/**
- * @abstract The button was released
+ * The button was released
*/
extern SDLButtonEventMode const SDLButtonEventModeButtonUp;
/**
- * @abstract The button was depressed
+ * The button was depressed
*/
extern SDLButtonEventMode const SDLButtonEventModeButtonDown;
diff --git a/SmartDeviceLink/SDLButtonName.h b/SmartDeviceLink/SDLButtonName.h
index 0956c80e3..5299910c8 100644
--- a/SmartDeviceLink/SDLButtonName.h
+++ b/SmartDeviceLink/SDLButtonName.h
@@ -5,107 +5,99 @@
#import "SDLEnum.h"
/**
- * Defines logical buttons which, on a given SDL unit, would correspond to
- * either physical or soft (touchscreen) buttons. These logical buttons present
- * a standard functional abstraction which the developer can rely upon,
- * independent of the SDL unit. For example, the developer can rely upon the OK
- * button having the same meaning to the user across SDL platforms.
- *
- * The preset buttons (0-9) can typically be interpreted by the application as
- * corresponding to some user-configured choices, though the application is free
- * to interpret these button presses as it sees fit.
+ * Defines logical buttons which, on a given SDL unit, would correspond to either physical or soft (touchscreen) buttons. These logical buttons present a standard functional abstraction which the developer can rely upon, independent of the SDL unit. For example, the developer can rely upon the OK button having the same meaning to the user across SDL platforms.
+
+ * The preset buttons (0-9) can typically be interpreted by the application as corresponding to some user-configured choices, though the application is free to interpret these button presses as it sees fit.
*
- * The application can discover which buttons a given SDL unit implements by
- * interrogating the ButtonCapabilities parameter of the
- * RegisterAppInterface response.
+ * The application can discover which buttons a given SDL unit implements by interrogating the ButtonCapabilities parameter of the RegisterAppInterface response.
*
* @since SDL 1.0
*/
typedef SDLEnum SDLButtonName SDL_SWIFT_ENUM;
/**
- * @abstract Represents the button usually labeled "OK". A typical use of this button is for the user to press it to make a selection.
+ * Represents the button usually labeled "OK". A typical use of this button is for the user to press it to make a selection.
*/
extern SDLButtonName const SDLButtonNameOk;
/**
- * @abstract Represents the seek-left button. A typical use of this button is for the user to scroll to the left through menu choices one menu item per press.
+ * Represents the seek-left button. A typical use of this button is for the user to scroll to the left through menu choices one menu item per press.
*/
extern SDLButtonName const SDLButtonNameSeekLeft;
/**
- * @abstract Represents the seek-right button. A typical use of this button is for the user to scroll to the right through menu choices one menu item per press.
+ * Represents the seek-right button. A typical use of this button is for the user to scroll to the right through menu choices one menu item per press.
*/
extern SDLButtonName const SDLButtonNameSeekRight;
/**
- * @abstract Represents a turn of the tuner knob in the clockwise direction one tick.
+ * Represents a turn of the tuner knob in the clockwise direction one tick.
*/
extern SDLButtonName const SDLButtonNameTuneUp;
/**
- * @abstract Represents a turn of the tuner knob in the counter-clockwise direction one tick.
+ * Represents a turn of the tuner knob in the counter-clockwise direction one tick.
*/
extern SDLButtonName const SDLButtonNameTuneDown;
/**
- * @abstract Represents the preset 0 button.
+ * Represents the preset 0 button.
*/
extern SDLButtonName const SDLButtonNamePreset0;
/**
- * @abstract Represents the preset 1 button.
+ * Represents the preset 1 button.
*/
extern SDLButtonName const SDLButtonNamePreset1;
/**
- * @abstract Represents the preset 2 button.
+ * Represents the preset 2 button.
*/
extern SDLButtonName const SDLButtonNamePreset2;
/**
- * @abstract Represents the preset 3 button.
+ * Represents the preset 3 button.
*/
extern SDLButtonName const SDLButtonNamePreset3;
/**
- * @abstract Represents the preset 4 button.
+ * Represents the preset 4 button.
*/
extern SDLButtonName const SDLButtonNamePreset4;
/**
- * @abstract Represents the preset 5 button.
+ * Represents the preset 5 button.
*/
extern SDLButtonName const SDLButtonNamePreset5;
/**
- * @abstract Represents the preset 6 button.
+ * Represents the preset 6 button.
*/
extern SDLButtonName const SDLButtonNamePreset6;
/**
- * @abstract Represents the preset 7 button.
+ * Represents the preset 7 button.
*/
extern SDLButtonName const SDLButtonNamePreset7;
/**
- * @abstract Represents the preset 8 button.
+ * Represents the preset 8 button.
*/
extern SDLButtonName const SDLButtonNamePreset8;
/**
- * @abstract Represents the preset 9 button.
+ * Represents the preset 9 button.
*/
extern SDLButtonName const SDLButtonNamePreset9;
/**
- * @abstract Represents the Custom button.
+ * Represents the Custom button.
*
*/
extern SDLButtonName const SDLButtonNameCustomButton;
/**
- * @abstract Represents the SEARCH button.
+ * Represents the SEARCH button.
*
*/
extern SDLButtonName const SDLButtonNameSearch;
@@ -113,101 +105,101 @@ extern SDLButtonName const SDLButtonNameSearch;
#pragma mark - Climate Buttons
/**
- * @abstract Represents AC max button *
+ * Represents AC max button *
*/
extern SDLButtonName const SDLButtonNameACMax;
/**
- * @abstract Represents AC button *
+ * Represents AC button *
*/
extern SDLButtonName const SDLButtonNameAC;
/**
- * @abstract Represents a Recirculate button
+ * Represents a Recirculate button
*/
extern SDLButtonName const SDLButtonNameRecirculate;
/**
- * @abstract Represents a Fan up button
+ * Represents a Fan up button
*/
extern SDLButtonName const SDLButtonNameFanUp;
/**
- * @abstract Represents a fan down button
+ * Represents a fan down button
*/
extern SDLButtonName const SDLButtonNameFanDown;
/**
- * @abstract Represents a temperature up button
+ * Represents a temperature up button
*/
extern SDLButtonName const SDLButtonNameTempUp;
/**
- * @abstract Represents a temperature down button
+ * Represents a temperature down button
*/
extern SDLButtonName const SDLButtonNameTempDown;
/**
- * @abstract Represents a Defrost max button.
+ * Represents a Defrost max button.
*
*/
extern SDLButtonName const SDLButtonNameDefrostMax;
/**
- * @abstract Represents a Defrost button.
+ * Represents a Defrost button.
*
*/
extern SDLButtonName const SDLButtonNameDefrost;
/**
- * @abstract Represents a Defrost rear button.
+ * Represents a Defrost rear button.
*
*/
extern SDLButtonName const SDLButtonNameDefrostRear;
/**
- * @abstract Represents a Upper Vent button.
+ * Represents a Upper Vent button.
*
*/
extern SDLButtonName const SDLButtonNameUpperVent;
/**
- * @abstract Represents a Lower vent button.
+ * Represents a Lower vent button.
*
*/
extern SDLButtonName const SDLButtonNameLowerVent;
#pragma mark - Radio Buttons
/**
- * @abstract Represents a volume up button.
+ * Represents a volume up button.
*/
extern SDLButtonName const SDLButtonNameVolumeUp;
/**
- * @abstract Represents a volume down button.
+ * Represents a volume down button.
*
*/
extern SDLButtonName const SDLButtonNameVolumeDown;
/**
- * @abstract Represents a Eject Button.
+ * Represents a Eject Button.
*
*/
extern SDLButtonName const SDLButtonNameEject;
/**
- * @abstract Represents a Source button.
+ * Represents a Source button.
*
*/
extern SDLButtonName const SDLButtonNameSource;
/**
- * @abstract Represents a SHUFFLE button.
+ * Represents a SHUFFLE button.
*
*/
extern SDLButtonName const SDLButtonNameShuffle;
/**
- * @abstract Represents a Repeat button.
+ * Represents a Repeat button.
*/
extern SDLButtonName const SDLButtonNameRepeat;
diff --git a/SmartDeviceLink/SDLButtonPressMode.h b/SmartDeviceLink/SDLButtonPressMode.h
index 7fd6084ea..0272e0eab 100644
--- a/SmartDeviceLink/SDLButtonPressMode.h
+++ b/SmartDeviceLink/SDLButtonPressMode.h
@@ -12,11 +12,11 @@
typedef SDLEnum SDLButtonPressMode SDL_SWIFT_ENUM;
/**
- * @abstract A button was released, after it was pressed for a long time. Actual timing is defined by the head unit and may vary.
+ * A button was released, after it was pressed for a long time. Actual timing is defined by the head unit and may vary.
*/
extern SDLButtonPressMode const SDLButtonPressModeLong;
/**
- * @abstract A button was released, after it was pressed for a short time. Actual timing is defined by the head unit and may vary.
+ * A button was released, after it was pressed for a short time. Actual timing is defined by the head unit and may vary.
*/
extern SDLButtonPressMode const SDLButtonPressModeShort;
diff --git a/SmartDeviceLink/SDLButtonPressResponse.h b/SmartDeviceLink/SDLButtonPressResponse.h
index 7a717d310..fe23ec0fe 100644
--- a/SmartDeviceLink/SDLButtonPressResponse.h
+++ b/SmartDeviceLink/SDLButtonPressResponse.h
@@ -6,6 +6,9 @@
NS_ASSUME_NONNULL_BEGIN
+/**
+ Response to SDLButtonPress
+ */
@interface SDLButtonPressResponse : SDLRPCResponse
@end
diff --git a/SmartDeviceLink/SDLCarModeStatus.h b/SmartDeviceLink/SDLCarModeStatus.h
index 32dab6bd3..e98ada744 100644
--- a/SmartDeviceLink/SDLCarModeStatus.h
+++ b/SmartDeviceLink/SDLCarModeStatus.h
@@ -4,23 +4,29 @@
#import "SDLEnum.h"
-/** Describes the carmode the vehicle is in.
- * Since SmartDeviceLink 2.0
+/**
+ Describes the carmode the vehicle is in. Used in ClusterModeStatus
+
+ * Since SmartDeviceLink 2.0
*/
typedef SDLEnum SDLCarModeStatus SDL_SWIFT_ENUM;
-/** Provides carmode NORMAL to each module.
+/**
+ Provides carmode NORMAL to each module.
*/
extern SDLCarModeStatus const SDLCarModeStatusNormal;
-/** Provides carmode FACTORY to each module.
+/**
+ Provides carmode FACTORY to each module.
*/
extern SDLCarModeStatus const SDLCarModeStatusFactory;
-/** Provides carmode TRANSPORT to each module.
+/**
+ Provides carmode TRANSPORT to each module.
*/
extern SDLCarModeStatus const SDLCarModeStatusTransport;
-/** Provides carmode CRASH to each module.
+/**
+ Provides carmode CRASH to each module.
*/
extern SDLCarModeStatus const SDLCarModeStatusCrash;
diff --git a/SmartDeviceLink/SDLCarWindowViewController.h b/SmartDeviceLink/SDLCarWindowViewController.h
index 2dac757ca..ef46095b3 100644
--- a/SmartDeviceLink/SDLCarWindowViewController.h
+++ b/SmartDeviceLink/SDLCarWindowViewController.h
@@ -13,6 +13,9 @@
*/
@interface SDLCarWindowViewController : UIViewController
+/**
+ The supported interface orientation you wish to use. Defaults to MaskPortrait.
+ */
@property (nonatomic, assign) UIInterfaceOrientation supportedOrientation;
@end
diff --git a/SmartDeviceLink/SDLChangeRegistration.h b/SmartDeviceLink/SDLChangeRegistration.h
index 063e24654..9f5e2e26b 100644
--- a/SmartDeviceLink/SDLChangeRegistration.h
+++ b/SmartDeviceLink/SDLChangeRegistration.h
@@ -24,12 +24,12 @@ NS_ASSUME_NONNULL_BEGIN
- (instancetype)initWithLanguage:(SDLLanguage)language hmiDisplayLanguage:(SDLLanguage)hmiDisplayLanguage appName:(nullable NSString *)appName ttsName:(nullable NSArray *)ttsName ngnMediaScreenAppName:(nullable NSString *)ngnMediaScreenAppName vrSynonyms:(nullable NSArray *)vrSynonyms;
/**
- * @abstract The language the app wants to change to
+ * The language the app wants to change to
*/
@property (strong, nonatomic) SDLLanguage language;
/**
- * @abstract HMI display language
+ * HMI display language
*/
@property (strong, nonatomic) SDLLanguage hmiDisplayLanguage;
diff --git a/SmartDeviceLink/SDLChangeRegistrationResponse.h b/SmartDeviceLink/SDLChangeRegistrationResponse.h
index 89c469fd9..55f733f81 100644
--- a/SmartDeviceLink/SDLChangeRegistrationResponse.h
+++ b/SmartDeviceLink/SDLChangeRegistrationResponse.h
@@ -5,9 +5,9 @@
#import "SDLRPCResponse.h"
/**
- * SDLChangeRegistrationResponse is sent, when SDLChangeRegistration has been called
- *
- * @since SDL 2.0
+ Response to SDLChangeRegistrations
+
+ @since SDL 2.0
*/
NS_ASSUME_NONNULL_BEGIN
diff --git a/SmartDeviceLink/SDLCharacterSet.h b/SmartDeviceLink/SDLCharacterSet.h
index 4aaf52745..51771fe77 100644
--- a/SmartDeviceLink/SDLCharacterSet.h
+++ b/SmartDeviceLink/SDLCharacterSet.h
@@ -5,17 +5,29 @@
#import "SDLEnum.h"
/**
- * Character sets supported by SDL.
+ * Character sets supported by SDL. Used to describe text field capabilities.
*
* @since SDL 1.0
*/
typedef SDLEnum SDLCharacterSet SDL_SWIFT_ENUM;
+/**
+ Character Set Type 2
+ */
extern SDLCharacterSet const SDLCharacterSetType2;
+/**
+ Character Set Type 5
+ */
extern SDLCharacterSet const SDLCharacterSetType5;
+/**
+ Character Set CID1
+ */
extern SDLCharacterSet const SDLCharacterSetCID1;
+/**
+ Character Set CID2
+ */
extern SDLCharacterSet const SDLCharacterSetCID2;
diff --git a/SmartDeviceLink/SDLChoice.h b/SmartDeviceLink/SDLChoice.h
index d5f521882..96860909f 100644
--- a/SmartDeviceLink/SDLChoice.h
+++ b/SmartDeviceLink/SDLChoice.h
@@ -8,47 +8,8 @@
/**
* 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 |
- * NSArray * |
- * 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
+ * Since SmartDeviceLink 1.0
*/
NS_ASSUME_NONNULL_BEGIN
@@ -59,49 +20,49 @@ NS_ASSUME_NONNULL_BEGIN
- (instancetype)initWithId:(UInt16)choiceId menuName:(NSString *)menuName vrCommands:(NSArray *)vrCommands image:(nullable SDLImage *)image secondaryText:(nullable NSString *)secondaryText secondaryImage:(nullable SDLImage *)secondaryImage tertiaryText:(nullable NSString *)tertiaryText;
/**
- * @abstract the application-scoped identifier that uniquely identifies this choice
+ * The application-scoped identifier that uniquely identifies this choice
*
* Required, Integer 0 - 65535
*/
@property (strong, nonatomic) NSNumber *choiceID;
/**
- * @abstract Text which appears in menu, representing this choice
+ * Text which appears in menu, representing this choice
*
* Required, Max string length 500 chars
*/
@property (strong, nonatomic) NSString *menuName;
/**
- * @abstract VR synonyms for this choice
+ * VR synonyms for this choice
*
* Required, Array of Strings, Array length 1 - 100, Max String length 99 chars
*/
@property (strong, nonatomic) NSArray *vrCommands;
/**
- * @abstract The image of the choice
+ * The image of the choice
*
* Optional
*/
@property (nullable, strong, nonatomic) SDLImage *image;
/**
- * @abstract Optional secondary text to display; e.g. address of POI in a search result entry
+ * Secondary text to display; e.g. address of POI in a search result entry
*
* Optional, Max String length 500 chars
*/
@property (nullable, strong, nonatomic) NSString *secondaryText;
/**
- * @abstract Optional tertiary text to display; e.g. distance to POI for a search result entry
+ * Tertiary text to display; e.g. distance to POI for a search result entry
*
* Optional, Max String length 500 chars
*/
@property (nullable, strong, nonatomic) NSString *tertiaryText;
/**
- * @abstract Optional secondary image for choice
+ * Secondary image for choice
*
* Optional
*/
diff --git a/SmartDeviceLink/SDLClimateControlCapabilities.h b/SmartDeviceLink/SDLClimateControlCapabilities.h
index 46482057e..4b5c105c3 100644
--- a/SmartDeviceLink/SDLClimateControlCapabilities.h
+++ b/SmartDeviceLink/SDLClimateControlCapabilities.h
@@ -16,15 +16,17 @@ NS_ASSUME_NONNULL_BEGIN
- (instancetype)initWithModuleName:(NSString *)moduleName fanSpeedAvailable:(BOOL)fanSpeedAvailable desiredTemperatureAvailable:(BOOL)desiredTemperatureAvailable acEnableAvailable:(BOOL)acEnableAvailable acMaxEnableAvailable:(BOOL)acMaxEnableAvailable circulateAirAvailable:(BOOL)circulateAirEnableAvailable autoModeEnableAvailable:(BOOL)autoModeEnableAvailable dualModeEnableAvailable:(BOOL)dualModeEnableAvailable defrostZoneAvailable:(BOOL)defrostZoneAvailable ventilationModeAvailable:(BOOL)ventilationModeAvailable;
/**
- * @abstract The short friendly name of the climate control module.
+ * The short friendly name of the climate control module.
* It should not be used to identify a module by mobile application.
*
* Max string length 100 chars
+
+ Required
*/
@property (strong, nonatomic) NSString *moduleName;
/**
- * @abstract Availability of the control of fan speed.
+ * Availability of the control of fan speed.
* True: Available, False: Not Available, Not present: Not Available.
*
* Optional, Boolean
@@ -32,7 +34,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSNumber *fanSpeedAvailable;
/**
- * @abstract Availability of the control of desired temperature.
+ * Availability of the control of desired temperature.
* True: Available, False: Not Available, Not present: Not Available.
*
* Optional, Boolean
@@ -40,7 +42,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSNumber *desiredTemperatureAvailable;
/**
- * @abstract Availability of the control of turn on/off AC.
+ * Availability of the control of turn on/off AC.
* True: Available, False: Not Available, Not present: Not Available.
*
* Optional, Boolean
@@ -48,7 +50,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSNumber *acEnableAvailable;
/**
- * @abstract Availability of the control of enable/disable air conditioning is ON on the maximum level.
+ * Availability of the control of enable/disable air conditioning is ON on the maximum level.
* True: Available, False: Not Available, Not present: Not Available.
*
* Optional, Boolean
@@ -56,7 +58,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSNumber *acMaxEnableAvailable;
/**
- * @abstract Availability of the control of enable/disable circulate Air mode.
+ * Availability of the control of enable/disable circulate Air mode.
* True: Available, False: Not Available, Not present: Not Available.
*
* Optional, Boolean
@@ -64,7 +66,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSNumber *circulateAirEnableAvailable;
/**
- * @abstract Availability of the control of enable/disable auto mode.
+ * Availability of the control of enable/disable auto mode.
* True: Available, False: Not Available, Not present: Not Available.
*
* Optional, Boolean
@@ -72,7 +74,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSNumber *autoModeEnableAvailable;
/**
- * @abstract Availability of the control of enable/disable dual mode.
+ * Availability of the control of enable/disable dual mode.
* True: Available, False: Not Available, Not present: Not Available.
*
* Optional, Boolean
@@ -80,7 +82,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSNumber *dualModeEnableAvailable;
/**
- * @abstract Availability of the control of defrost zones.
+ * Availability of the control of defrost zones.
* True: Available, False: Not Available, Not present: Not Available.
*
* Optional, Boolean
@@ -88,14 +90,14 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSNumber *defrostZoneAvailable;
/**
- * @abstract A set of all defrost zones that are controllable.
+ * A set of all defrost zones that are controllable.
*
* Optional, NSArray of type SDLDefrostZone minsize="1" maxsize="100"
*/
@property (nullable, strong, nonatomic) NSArray *defrostZone;
/**
- * @abstract Availability of the control of air ventilation mode.
+ * Availability of the control of air ventilation mode.
* True: Available, False: Not Available, Not present: Not Available.
*
* Optional, Boolean
@@ -103,7 +105,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) NSNumber *ventilationModeAvailable;
/**
- * @abstract A set of all ventilation modes that are controllable.
+ * A set of all ventilation modes that are controllable.
* True: Available, False: Not Available, Not present: Not Available.
*
* Optional, NSArray of type SDLVentilationMode minsize="1" maxsize="100"
diff --git a/SmartDeviceLink/SDLClimateControlData.h b/SmartDeviceLink/SDLClimateControlData.h
index 722bcd395..42c4c2761 100644
--- a/SmartDeviceLink/SDLClimateControlData.h
+++ b/SmartDeviceLink/SDLClimateControlData.h
@@ -11,19 +11,22 @@ NS_ASSUME_NONNULL_BEGIN
@class SDLTemperature;
+/**
+ The current information for the Climate Remote Control Module
+ */
@interface SDLClimateControlData : SDLRPCStruct
- (instancetype)initWithFanSpeed:(nullable NSNumber *)fanSpeed desiredTemperature:(nullable SDLTemperature *)desiredTemperature acEnable:(nullable NSNumber *)acEnable circulateAirEnable:(nullable NSNumber *)circulateAirEnable autoModeEnable:(nullable NSNumber *)autoModeEnable defrostZone:(nullable SDLDefrostZone)defrostZone dualModeEnable:(nullable NSNumber *)dualModeEnable acMaxEnable:(nullable NSNumber *)acMaxEnable ventilationMode:(nullable SDLVentilationMode)ventilationMode;
/**
- * @abstract Speed of Fan in integer
+ * Speed of Fan in integer
*
* Optional, MinValue- 0 MaxValue= 100
*/
@property (nullable, strong, nonatomic) NSNumber *fanSpeed;
/**
- * @abstract The Current Temperature in SDLTemperature
+ * The Current Temperature in SDLTemperature
*
* @warning This property is readonly and cannot be set on the module.
*
@@ -32,56 +35,56 @@ NS_ASSUME_NONNULL_BEGIN
@property (nullable, strong, nonatomic) SDLTemperature *currentTemperature;
/**
- * @abstract Desired Temperature in SDLTemperature
+ * Desired Temperature in SDLTemperature
*
* Optional
*/
@property (nullable, strong, nonatomic) SDLTemperature *desiredTemperature;
/**
- * @abstract Represents if AC is enabled.
+ * Represents if AC is enabled.
*
* Optional, Boolean
*/
@property (nullable, strong, nonatomic) NSNumber *acEnable;
/**
- * @abstract Represents if circulation of air is enabled.
+ * Represents if circulation of air is enabled.
*
* Optional, Boolean
*/
@property (nullable, strong, nonatomic) NSNumber *circulateAirEnable;
/**
- * @abstract Represents if auto mode is enabled.
+ * Represents if auto mode is enabled.
*
* Optional, Boolean
*/
@property (nullable, strong, nonatomic) NSNumber *autoModeEnable;
/**
- * @abstract Represents the kind of defrost zone
+ * Represents the kind of defrost zone
*
* Optional, SDLDefrostZone
*/
@property (nullable, strong, nonatomic) SDLDefrostZone defrostZone;
/**
- * @abstract Represents if dual mode is enabled.
+ * Represents if dual mode is enabled.
*
* Optional, Boolean
*/
@property (nullable, strong, nonatomic) NSNumber *dualModeEnable;
/**
- * @abstract Represents if ac max is enabled.
+ * Represents if ac max is enabled.
*
* Optional, Boolean
*/
@property (nullable, strong, nonatomic) NSNumber *acMaxEnable;
/**
- * @abstract Represents the kind of Ventilation zone
+ * Represents the kind of Ventilation zone
*
* Optional, SDLVentilationMode
*/
diff --git a/SmartDeviceLink/SDLClusterModeStatus.h b/SmartDeviceLink/SDLClusterModeStatus.h
index 558a1fdcc..2a3fa5956 100644
--- a/SmartDeviceLink/SDLClusterModeStatus.h
+++ b/SmartDeviceLink/SDLClusterModeStatus.h
@@ -9,11 +9,37 @@
NS_ASSUME_NONNULL_BEGIN
+/**
+ A vehicle data struct for the cluster mode and power status
+ */
@interface SDLClusterModeStatus : SDLRPCStruct
+/**
+ References signal "PowerMode_UB".
+
+ Required
+ */
@property (strong, nonatomic) NSNumber *powerModeActive;
+
+/**
+ References signal "PowerModeQF". See PowerModeQualificationStatus.
+
+ Required
+ */
@property (strong, nonatomic) SDLPowerModeQualificationStatus powerModeQualificationStatus;
+
+/**
+ References signal "CarMode". See CarMode.
+
+ Required
+ */
@property (strong, nonatomic) SDLCarModeStatus carModeStatus;
+
+/**
+ References signal "PowerMode". See PowerMode.
+
+ Required
+ */
@property (strong, nonatomic) SDLPowerModeStatus powerModeStatus;
@end
diff --git a/SmartDeviceLink/SDLCompassDirection.h b/SmartDeviceLink/SDLCompassDirection.h
index 712081452..ed11f0310 100644
--- a/SmartDeviceLink/SDLCompassDirection.h
+++ b/SmartDeviceLink/SDLCompassDirection.h
@@ -5,48 +5,48 @@
#import "SDLEnum.h"
/**
- * The list of potential compass directions.
+ * The list of potential compass directions. Used in GPS data
*
* @since SDL 2.0
*/
typedef SDLEnum SDLCompassDirection SDL_SWIFT_ENUM;
/**
- * @abstract Direction North
+ * Direction North
*/
extern SDLCompassDirection const SDLCompassDirectionNorth;
/**
- * @abstract Direction Northwest
+ * Direction Northwest
*/
extern SDLCompassDirection const SDLCompassDirectionNorthwest;
/**
- * @abstract Direction West
+ * Direction West
*/
extern SDLCompassDirection const SDLCompassDirectionWest;
/**
- * @abstract Direction Southwest
+ * Direction Southwest
*/
extern SDLCompassDirection const SDLCompassDirectionSouthwest;
/**
- * @abstract Direction South
+ * Direction South
*/
extern SDLCompassDirection const SDLCompassDirectionSouth;
/**
- * @abstract Direction Southeast
+ * Direction Southeast
*/
extern SDLCompassDirection const SDLCompassDirectionSoutheast;
/**
- * @abstract Direction East
+ * Direction East
*/
extern SDLCompassDirection const SDLCompassDirectionEast;
/**
- * @abstract Direction Northeast
+ * Direction Northeast
*/
extern SDLCompassDirection const SDLCompassDirectionNortheast;
diff --git a/SmartDeviceLink/SDLComponentVolumeStatus.h b/SmartDeviceLink/SDLComponentVolumeStatus.h
index b9e69b7ed..dc710a573 100644
--- a/SmartDeviceLink/SDLComponentVolumeStatus.h
+++ b/SmartDeviceLink/SDLComponentVolumeStatus.h
@@ -5,38 +5,38 @@
#import "SDLEnum.h"
/**
- * The volume status of a vehicle component.
+ * The volume status of a vehicle component. Used in SingleTireStatus and VehicleData Fuel Level
*
* @since SDL 2.0
*/
typedef SDLEnum SDLComponentVolumeStatus SDL_SWIFT_ENUM;
/**
- * @abstract Unknown SDLComponentVolumeStatus
+ * Unknown SDLComponentVolumeStatus
*/
extern SDLComponentVolumeStatus const SDLComponentVolumeStatusUnknown;
/**
- * @abstract Normal SDLComponentVolumeStatus
+ * Normal SDLComponentVolumeStatus
*/
extern SDLComponentVolumeStatus const SDLComponentVolumeStatusNormal;
/**
- * @abstract Low SDLComponentVolumeStatus
+ * Low SDLComponentVolumeStatus
*/
extern SDLComponentVolumeStatus const SDLComponentVolumeStatusLow;
/**
- * @abstract Fault SDLComponentVolumeStatus
+ * Fault SDLComponentVolumeStatus
*/
extern SDLComponentVolumeStatus const SDLComponentVolumeStatusFault;
/**
- * @abstract Alert SDLComponentVolumeStatus
+ * Alert SDLComponentVolumeStatus
*/
extern SDLComponentVolumeStatus const SDLComponentVolumeStatusAlert;
/**
- * @abstract Not supported SDLComponentVolumeStatus
+ * Not supported SDLComponentVolumeStatus
*/
extern SDLComponentVolumeStatus const SDLComponentVolumeStatusNotSupported;
diff --git a/SmartDeviceLink/SDLConnectionManagerType.h b/SmartDeviceLink/SDLConnectionManagerType.h
index d1b316343..f7052f67d 100644
--- a/SmartDeviceLink/SDLConnectionManagerType.h
+++ b/SmartDeviceLink/SDLConnectionManagerType.h
@@ -33,6 +33,10 @@ NS_ASSUME_NONNULL_BEGIN
*/
- (void)sendConnectionRequest:(__kindof SDLRPCRequest *)request withResponseHandler:(nullable SDLResponseHandler)handler;
+- (void)sendRequests:(NSArray *)requests progressHandler:(nullable SDLMultipleAsyncRequestProgressHandler)progressHandler completionHandler:(nullable SDLMultipleRequestCompletionHandler)completionHandler;
+
+- (void)sendSequentialRequests:(NSArray *)requests progressHandler:(nullable SDLMultipleSequentialRequestProgressHandler)progressHandler completionHandler:(nullable SDLMultipleRequestCompletionHandler)completionHandler;
+
@end
NS_ASSUME_NONNULL_END
diff --git a/SmartDeviceLink/SDLCreateInteractionChoiceSet.h b/SmartDeviceLink/SDLCreateInteractionChoiceSet.h
index 80ae3e9a9..1e094468d 100644
--- a/SmartDeviceLink/SDLCreateInteractionChoiceSet.h
+++ b/SmartDeviceLink/SDLCreateInteractionChoiceSet.h
@@ -26,14 +26,14 @@ NS_ASSUME_NONNULL_BEGIN
- (instancetype)initWithId:(UInt32)choiceId choiceSet:(NSArray *)choiceSet;
/**
- * @abstract A unique ID that identifies the Choice Set
+ * A unique ID that identifies the Choice Set
*
* Required, Integer, 0 - 2,000,000,000
*/
@property (strong, nonatomic) NSNumber *interactionChoiceSetID;
/**
- * @abstract Array of choices, which the user can select by menu or voice recognition
+ * Array of choices, which the user can select by menu or voice recognition
*
* Required, SDLChoice, Array size 1 - 100
*/
diff --git a/SmartDeviceLink/SDLCreateInteractionChoiceSetResponse.h b/SmartDeviceLink/SDLCreateInteractionChoiceSetResponse.h
index 0f9cd4346..c208cd8b8 100644
--- a/SmartDeviceLink/SDLCreateInteractionChoiceSetResponse.h
+++ b/SmartDeviceLink/SDLCreateInteractionChoiceSetResponse.h
@@ -5,10 +5,9 @@
#import "SDLRPCResponse.h"
/**
- * SDLCreateInteractionChoiceSetResponse is sent, when SDLCreateInteractionChoiceSet
- * has been called
- *
- * Since SmartDeviceLink 1.0
+ Response to SDLCreateInteractionChoiceSet has been called
+
+ Since SmartDeviceLink 1.0
*/
NS_ASSUME_NONNULL_BEGIN
diff --git a/SmartDeviceLink/SDLDIDResult.h b/SmartDeviceLink/SDLDIDResult.h
index 2ee14af44..673ccaacc 100644
--- a/SmartDeviceLink/SDLDIDResult.h
+++ b/SmartDeviceLink/SDLDIDResult.h
@@ -7,10 +7,30 @@
NS_ASSUME_NONNULL_BEGIN
+/**
+ A vehicle data struct
+ */
@interface SDLDIDResult : SDLRPCStruct
+/**
+ Individual DID result code.
+
+ Required
+ */
@property (strong, nonatomic) SDLVehicleDataResultCode resultCode;
+
+/**
+ Location of raw data from vehicle data DID
+
+ Required
+ */
@property (strong, nonatomic) NSNumber *didLocation;
+
+/**
+ Raw DID-based data returned for requested element.
+
+ Optional
+ */
@property (nullable, strong, nonatomic) NSString *data;
@end
diff --git a/SmartDeviceLink/SDLDateTime.h b/SmartDeviceLink/SDLDateTime.h
index 9239696c9..a7c6e3696 100644
--- a/SmartDeviceLink/SDLDateTime.h
+++ b/SmartDeviceLink/SDLDateTime.h
@@ -5,6 +5,9 @@
NS_ASSUME_NONNULL_BEGIN
+/**
+ A struct referenced in SendLocation for an absolute date
+ */
@interface SDLDateTime : SDLRPCStruct
- (instancetype)initWithHour:(UInt8)hour minute:(UInt8)minute;
@@ -16,63 +19,63 @@ NS_ASSUME_NONNULL_BEGIN
- (instancetype)initWithHour:(UInt8)hour minute:(UInt8)minute second:(UInt8)second millisecond:(UInt16)millisecond day:(UInt8)day month:(UInt8)month year:(UInt16)year timezoneMinuteOffset:(UInt8)timezoneMinuteOffset timezoneHourOffset:(int)timezoneHourOffset;
/**
- * @abstract Milliseconds part of time
+ * Milliseconds part of time
*
* Optional, Integer 0 - 999
*/
@property (copy, nonatomic) NSNumber *millisecond;
/**
- * @abstract Seconds part of time
+ * Seconds part of time
*
* Optional, Integer 0 - 59
*/
@property (copy, nonatomic) NSNumber *second;
/**
- * @abstract Minutes part of time
+ * Minutes part of time
*
* Optional, Integer 0 - 59
*/
@property (copy, nonatomic) NSNumber *minute;
/**
- * @abstract Hour part of time
+ * Hour part of time
*
* Optional, Integer 0 - 23
*/
@property (copy, nonatomic) NSNumber *hour;
/**
- * @abstract Day of the month
+ * Day of the month
*
* Optional, Integer 1 - 31
*/
@property (copy, nonatomic) NSNumber *day;
/**
- * @abstract Month of the year
+ * Month of the year
*
* Optional, Integer 1 - 12
*/
@property (copy, nonatomic) NSNumber *month;
/**
- * @abstract The year in YYYY format
+ * The year in YYYY format
*
* Optional, Max Value 4095
*/
@property (copy, nonatomic) NSNumber *year;
/**
- * @abstract Time zone offset in Min with regard to UTC
+ * Time zone offset in Min with regard to UTC
*
* Optional, Integer 0 - 59
*/
@property (copy, nonatomic) NSNumber *timezoneMinuteOffset;
/**
- * @abstract Time zone offset in Hours with regard to UTC
+ * Time zone offset in Hours with regard to UTC
*
* Optional, Integer -12 - 14
*/
diff --git a/SmartDeviceLink/SDLDefrostZone.h b/SmartDeviceLink/SDLDefrostZone.h
index 3563b58f3..04519a6a2 100644
--- a/SmartDeviceLink/SDLDefrostZone.h
+++ b/SmartDeviceLink/SDLDefrostZone.h
@@ -5,28 +5,28 @@
#import "SDLEnum.h"
/**
- * Enumeration listing possible defrost zones.
+ * Enumeration listing possible defrost zones. Used in ClimateControlCapabilities and Data.
*
* @since SDL 2.0
*/
typedef SDLEnum SDLDefrostZone SDL_SWIFT_ENUM;
/**
- * @abstract A SDLDefrostZone with the value of *FRONT*
+ * A SDLDefrostZone with the value of *FRONT*
*/
extern SDLDefrostZone const SDLDefrostZoneFront;
/**
- * @abstract A SDLDefrostZone with the value of *REAR*
+ * A SDLDefrostZone with the value of *REAR*
*/
extern SDLDefrostZone const SDLDefrostZoneRear;
/**
- * @abstract A SDLDefrostZone with the value of *All*
+ * A SDLDefrostZone with the value of *All*
*/
extern SDLDefrostZone const SDLDefrostZoneAll;
/**
- * @abstract A SDLDefrostZone with the value of *None*
+ * A SDLDefrostZone with the value of *None*
*/
extern SDLDefrostZone const SDLDefrostZoneNone;
diff --git a/SmartDeviceLink/SDLDeleteCommand.h b/SmartDeviceLink/SDLDeleteCommand.h
index 2bc9e7769..3d7e45801 100644
--- a/SmartDeviceLink/SDLDeleteCommand.h
+++ b/SmartDeviceLink/SDLDeleteCommand.h
@@ -24,7 +24,7 @@ NS_ASSUME_NONNULL_BEGIN
- (instancetype)initWithId:(UInt32)commandId;
/**
- * @abstract the Command ID that identifies the Command to be deleted from Command Menu
+ * the Command ID that identifies the Command to be deleted from Command Menu
* @discussion an NSNumber value representing Command ID
*
* Notes: Min Value: 0; Max Value: 2000000000
diff --git a/SmartDeviceLink/SDLDeleteCommandResponse.h b/SmartDeviceLink/SDLDeleteCommandResponse.h
index 95df39a6f..6237313ee 100644
--- a/SmartDeviceLink/SDLDeleteCommandResponse.h
+++ b/SmartDeviceLink/SDLDeleteCommandResponse.h
@@ -5,9 +5,9 @@
#import "SDLRPCResponse.h"
/**
- * SDLDeleteCommandResponse is sent, when SDLDeleteCommand has been called
- *
- * Since SmartDeviceLink 1.0
+ Response to SDLDeleteCommand
+
+ Since SmartDeviceLink 1.0
*/
NS_ASSUME_NONNULL_BEGIN
diff --git a/SmartDeviceLink/SDLDeleteFile.h b/SmartDeviceLink/SDLDeleteFile.h
index 4372e4333..927d2a7cc 100644
--- a/SmartDeviceLink/SDLDeleteFile.h
+++ b/SmartDeviceLink/SDLDeleteFile.h
@@ -20,7 +20,7 @@ NS_ASSUME_NONNULL_BEGIN
- (instancetype)initWithFileName:(NSString *)fileName;
/**
- * @abstract a file reference name
+ * a file reference name
* @discussion a String value representing a file reference name
*/
@property (strong, nonatomic) NSString *syncFileName;
diff --git a/SmartDeviceLink/SDLDeleteFileResponse.h b/SmartDeviceLink/SDLDeleteFileResponse.h
index aaf8e8f9e..8c3fc4fc5 100644
--- a/SmartDeviceLink/SDLDeleteFileResponse.h
+++ b/SmartDeviceLink/SDLDeleteFileResponse.h
@@ -4,16 +4,19 @@
#import "SDLRPCResponse.h"
-/**
- * Delete File Response is sent, when DeleteFile has been called
- *
- * Since SmartDeviceLink 2.0
- */
NS_ASSUME_NONNULL_BEGIN
+/**
+ Response to SDLDeleteFile
+
+ Since SmartDeviceLink 2.0
+ */
@interface SDLDeleteFileResponse : SDLRPCResponse
+/**
+ The remaining available space for your application to store data on the remote system.
+ */
@property (strong, nonatomic) NSNumber *spaceAvailable;
@end
diff --git a/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h b/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h
index 8c03f2eca..3bef8d740 100644
--- a/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h
+++ b/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h
@@ -26,7 +26,7 @@ NS_ASSUME_NONNULL_BEGIN
- (instancetype)initWithId:(UInt32)choiceId;
/**
- * @abstract a unique ID that identifies the Choice Set
+ * a unique ID that identifies the Choice Set
* @discussion a unique ID that identifies the Choice Set
*
* Notes: Min Value: 0; Max Value: 2000000000
diff --git a/SmartDeviceLink/SDLDeleteInteractionChoiceSetResponse.h b/SmartDeviceLink/SDLDeleteInteractionChoiceSetResponse.h
index ad0dc0fc7..55267a604 100644
--- a/SmartDeviceLink/SDLDeleteInteractionChoiceSetResponse.h
+++ b/SmartDeviceLink/SDLDeleteInteractionChoiceSetResponse.h
@@ -5,9 +5,9 @@
#import "SDLRPCResponse.h"
/**
- * SDLDeleteInteractionChoiceSetResponse is sent, when SDLDeleteInteractionChoiceSet has been called
- *
- * Since SmartDeviceLink 1.0
+ SDLDeleteInteractionChoiceSetResponse is sent, when SDLDeleteInteractionChoiceSet has been called
+
+ Since SmartDeviceLink 1.0
*/
NS_ASSUME_NONNULL_BEGIN
diff --git a/SmartDeviceLink/SDLDeleteSubMenu.h b/SmartDeviceLink/SDLDeleteSubMenu.h
index 74a6363a9..c6562e924 100644
--- a/SmartDeviceLink/SDLDeleteSubMenu.h
+++ b/SmartDeviceLink/SDLDeleteSubMenu.h
@@ -24,7 +24,7 @@ NS_ASSUME_NONNULL_BEGIN
- (instancetype)initWithId:(UInt32)menuId;
/**
- * @abstract the MenuID that identifies the SDLSubMenu to be delete
+ * the MenuID that identifies the SDLSubMenu to be delete
* @discussion Notes: Min Value: 0; Max Value: 2000000000
*/
@property (strong, nonatomic) NSNumber *menuID;
diff --git a/SmartDeviceLink/SDLDeleteSubMenuResponse.h b/SmartDeviceLink/SDLDeleteSubMenuResponse.h
index e50781e85..7b3282e45 100644
--- a/SmartDeviceLink/SDLDeleteSubMenuResponse.h
+++ b/SmartDeviceLink/SDLDeleteSubMenuResponse.h
@@ -5,9 +5,9 @@
#import "SDLRPCResponse.h"
/**
- * SDLDeleteSubMenuResponse is sent, when SDLDeleteSubMenu has been called
- *
- * Since SmartDeviceLink 1.0
+ Response to SDLDeleteSubMenu
+
+ Since SmartDeviceLink 1.0
*/
NS_ASSUME_NONNULL_BEGIN
diff --git a/SmartDeviceLink/SDLDeliveryMode.h b/SmartDeviceLink/SDLDeliveryMode.h
index 84575bc2f..61f9dcf29 100644
--- a/SmartDeviceLink/SDLDeliveryMode.h
+++ b/SmartDeviceLink/SDLDeliveryMode.h
@@ -4,24 +4,21 @@
#import "SDLEnum.h"
/**
- *Specifies the mode in which the sendLocation request is sent.
+ * Specifies the mode in which the sendLocation request is sent. Used in SendLocation.
*/
typedef SDLEnum SDLDeliveryMode SDL_SWIFT_ENUM;
/**
- * @abstract User is prompted on HMI
- *
+ * User is prompted on HMI
*/
extern SDLDeliveryMode const SDLDeliveryModePrompt;
/**
- * @abstract Set the location as destination without prompting the user
- *
+ * Set the location as destination without prompting the user
*/
extern SDLDeliveryMode const SDLDeliveryModeDestination;
/**
- * @abstract Adds the current location to navigation queue
- *
+ * Adds the current location to navigation queue
*/
extern SDLDeliveryMode const SDLDeliveryModeQueue;
diff --git a/SmartDeviceLink/SDLDeviceInfo.h b/SmartDeviceLink/SDLDeviceInfo.h
index 0af061abc..ba43d32ee 100644
--- a/SmartDeviceLink/SDLDeviceInfo.h
+++ b/SmartDeviceLink/SDLDeviceInfo.h
@@ -5,15 +5,55 @@
NS_ASSUME_NONNULL_BEGIN
+/**
+ Various information about connecting device. Referenced in RegisterAppInterface
+ */
@interface SDLDeviceInfo : SDLRPCStruct
+ (instancetype)currentDevice;
+/**
+ Device model
+
+ Optional
+ */
@property (nullable, strong, nonatomic) NSString *hardware;
+
+/**
+ Device firmware version
+
+ Optional
+ */
@property (nullable, strong, nonatomic) NSString *firmwareRev;
+
+/**
+ Device OS
+
+ Optional
+ */
@property (nullable, strong, nonatomic) NSString *os;
+
+/**
+ Device OS version
+
+ Optional
+ */
@property (nullable, strong, nonatomic) NSString *osVersion;
+
+/**
+ Device mobile carrier
+
+ Optional
+ */
@property (nullable, strong, nonatomic) NSString *carrier;
+
+/**
+ Number of bluetooth RFCOMM ports available.
+
+ Omitted if not connected via BT or on iOS
+
+ Optional
+ */
@property (nullable, strong, nonatomic) NSNumber *maxNumberRFCOMMPorts;
@end
diff --git a/SmartDeviceLink/SDLDeviceLevelStatus.h b/SmartDeviceLink/SDLDeviceLevelStatus.h
index 95a3d3ccd..fb6a58d24 100644
--- a/SmartDeviceLink/SDLDeviceLevelStatus.h
+++ b/SmartDeviceLink/SDLDeviceLevelStatus.h
@@ -5,38 +5,38 @@
#import "SDLEnum.h"
/**
- * Reflects the reported battery status of the connected device, if reported.
+ * Reflects the reported battery status of the connected device, if reported. Used in DeviceStatus.
*
* @since SDL 2.0
*/
typedef SDLEnum SDLDeviceLevelStatus SDL_SWIFT_ENUM;
/**
- * @abstract Device battery level is zero bars
+ * Device battery level is zero bars
*/
extern SDLDeviceLevelStatus const SDLDeviceLevelStatusZeroBars;
/**
- * @abstract Device battery level is one bar
+ * Device battery level is one bar
*/
extern SDLDeviceLevelStatus const SDLDeviceLevelStatusOneBar;
/**
- * @abstract Device battery level is two bars
+ * Device battery level is two bars
*/
extern SDLDeviceLevelStatus const SDLDeviceLevelStatusTwoBars;
/**
- * @abstract Device battery level is three bars
+ * Device battery level is three bars
*/
extern SDLDeviceLevelStatus const SDLDeviceLevelStatusThreeBars;
/**
- * @abstract Device battery level is four bars
+ * Device battery level is four bars
*/
extern SDLDeviceLevelStatus const SDLDeviceLevelStatusFourBars;
/**
- * @abstract Device battery level is unknown
+ * Device battery level is unknown
*/
extern SDLDeviceLevelStatus const SDLDeviceLevelStatusNotProvided;
diff --git a/SmartDeviceLink/SDLDeviceStatus.h b/SmartDeviceLink/SDLDeviceStatus.h
index d1f36d215..4764ca223 100644
--- a/SmartDeviceLink/SDLDeviceStatus.h
+++ b/SmartDeviceLink/SDLDeviceStatus.h
@@ -8,95 +8,9 @@
/**
- * Describes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle.
- *
- * Parameter List
- *
- *
- * | Name |
- * Type |
- * Description |
- * SmartDeviceLink Ver. Available |
- *
- *
- * | voiceRecOn |
- * NSNumber * |
- * Voice recognition is on
- * |
- * SmartDeviceLink 2.0 |
- *
- *
- * | btIconOn |
- * NSNumber * |
- * Bluetooth connection established
- * |
- * SmartDeviceLink 2.0 |
- *
- *
- * | callActive |
- * NSNumber * |
- * A call is being active
- * |
- * SmartDeviceLink 2.0 |
- *
- *
- * | phoneRoaming |
- * NSNumber * |
- * The phone is in roaming mode
- * |
- * SmartDeviceLink 2.0 |
- *
- *
- * | textMsgAvailable |
- * NSNumber * |
- * A textmessage is available
- * |
- * SmartDeviceLink 2.0 |
- *
- *
- * | battLevelStatus |
- * SDLDeviceLevelStatus * |
- * Battery level status
- * |
- * SmartDeviceLink 2.0 |
- *
- *
- * | stereoAudioOutputMuted |
- * NSNumber * |
- * Status of the stereo audio output channel
- * |
- * SmartDeviceLink 2.0 |
- *
- *
- * | monoAudioOutputMuted |
- * NSNumber * |
- * Status of the mono audio output channel
- * |
- * SmartDeviceLink 2.0 |
- *
- *
- * | signalLevelStatus |
- * SDLDeviceLevelStatus * |
- * Signal level status
- * |
- * SmartDeviceLink 2.0 |
- *
- *
- * | primaryAudioSource |
- * PrimaryAudioSource * |
- * Reflects the current primary audio source of SDL (if selected).
- * |
- * SmartDeviceLink 2.0 |
- *
- *
- * | eCallEventActive |
- * NSNumber * |
- * Reflects, if an eCall event is active
- * |
- * SmartDeviceLink 2.0 |
- *
- *
- * @since SDL 2.0
+ Describes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle.
+
+ @since SDL 2.0
*/
NS_ASSUME_NONNULL_BEGIN
@@ -104,42 +18,42 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLDeviceStatus : SDLRPCStruct
/**
- * @abstract Indicates whether the voice recognition is on or off
+ * Indicates whether the voice recognition is on or off
*
* Required, Boolean
*/
@property (strong, nonatomic) NSNumber *voiceRecOn;
/**
- * @abstract Indicates whether the bluetooth connection established
+ * Indicates whether the bluetooth connection established
*
* Required, Boolean
*/
@property (strong, nonatomic) NSNumber *btIconOn;
/**
- * @abstract Indicates whether a call is being active
+ * Indicates whether a call is being active
*
* Required, Boolean
*/
@property (strong, nonatomic) NSNumber *callActive;
/**
- * @abstract Indicates whether the phone is in roaming mode
+ * Indicates whether the phone is in roaming mode
*
* Required, Boolean
*/
@property (strong, nonatomic) NSNumber *phoneRoaming;
/**
- * @abstract Indicates whether a textmessage is available
+ * Indicates whether a textmessage is available
*
* Required, Boolean
*/
@property (strong, nonatomic) NSNumber *textMsgAvailable;
/**
- * @abstract Battery level status
+ * Battery level status
*
* @see SDLDeviceLevelStatus
*
@@ -148,21 +62,21 @@ NS_ASSUME_NONNULL_BEGIN
@property (strong, nonatomic) SDLDeviceLevelStatus battLevelStatus;
/**
- * @abstract The status of the stereo audio output channel
+ * The status of the stereo audio output channel
*
* Required, Boolean
*/
@property (strong, nonatomic) NSNumber *stereoAudioOutputMuted;
/**
- * @abstract The status of the mono audio output channel
+ * The status of the mono audio output channel
*
* Required, Boolean
*/
@property (strong, nonatomic) NSNumber *monoAudioOutputMuted;
/**
- * @abstract Signal level status
+ * Signal level status
*
* @see SDLDeviceLevelStatus
*
@@ -171,7 +85,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (strong, nonatomic) SDLDeviceLevelStatus signalLevelStatus;
/**
- * @abstract The current primary audio source of SDL (if selected).
+ * The current primary audio source of SDL (if selected).
*
* @see SDLPrimaryAudioSource
*
@@ -180,7 +94,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (strong, nonatomic) SDLPrimaryAudioSource primaryAudioSource;
/**
- * @abstract Indicates if an emergency call is active
+ * Indicates if an emergency call is active
*
* Required, Boolean
*/
diff --git a/SmartDeviceLink/SDLDiagnosticMessage.h b/SmartDeviceLink/SDLDiagnosticMessage.h
index d056c5488..c4ede3b4a 100644
--- a/SmartDeviceLink/SDLDiagnosticMessage.h
+++ b/SmartDeviceLink/SDLDiagnosticMessage.h
@@ -5,9 +5,9 @@
#import "SDLRPCRequest.h"
/**
- * Non periodic vehicle diagnostic request
+ * Non periodic vehicle diagnostic request
*
- * @since SDL 3.0
+ * @since SDL 3.0
*/
NS_ASSUME_NONNULL_BEGIN
@@ -17,23 +17,23 @@ NS_ASSUME_NONNULL_BEGIN
- (instancetype)initWithTargetId:(UInt16)targetId length:(UInt16)length data:(NSArray *> *)data;
/**
- * Name of target ECU
+ * Name of target ECU
*
- * Required, Integer, 0 - 65535
+ * Required, Integer, 0 - 65535
*/
@property (strong, nonatomic) NSNumber *targetID;
/**
- * Length of message (in bytes)
+ * Length of message (in bytes)
*
- * Required, Integer, 65535
+ * Required, Integer, 65535
*/
@property (strong, nonatomic) NSNumber *messageLength;
/**
* Array of bytes comprising CAN message.
*
- * Required, Array of NSNumber (Integers), Array size 1 - 65535, Integer Size 0 - 255
+ * Required, Array of NSNumber (Integers), Array size 1 - 65535, Integer Size 0 - 255
*/
@property (strong, nonatomic) NSArray *> *messageData;
diff --git a/SmartDeviceLink/SDLDiagnosticMessageResponse.h b/SmartDeviceLink/SDLDiagnosticMessageResponse.h
index 60124540e..f78dbe2dc 100644
--- a/SmartDeviceLink/SDLDiagnosticMessageResponse.h
+++ b/SmartDeviceLink/SDLDiagnosticMessageResponse.h
@@ -4,14 +4,20 @@
#import "SDLRPCResponse.h"
-/** SDLDiagnosticMessageResponse is sent, when SDLDiagnosticMessage has been called.
- * SinceSmartDeviceLink 3.0
- */
-
NS_ASSUME_NONNULL_BEGIN
+/**
+ Response to SDLDiagnosticMessage
+
+ Since SmartDeviceLink 3.0
+ */
@interface SDLDiagnosticMessageResponse : SDLRPCResponse
+/**
+ Array of bytes comprising CAN message result.
+
+ Required
+ */
@property (strong, nonatomic) NSArray *> *messageDataResult;
@end
diff --git a/SmartDeviceLink/SDLDialNumberResponse.h b/SmartDeviceLink/SDLDialNumberResponse.h
index 7f8dfaa14..f1a9265ab 100644
--- a/SmartDeviceLink/SDLDialNumberResponse.h
+++ b/SmartDeviceLink/SDLDialNumberResponse.h
@@ -5,7 +5,7 @@
#import "SDLRPCResponse.h"
/**
- Indicates the result, success, or failure of the SDLDialNumber request.
+ The response to SDLDialNumber
@since SDL 4.0
*/
diff --git a/SmartDeviceLink/SDLDimension.h b/SmartDeviceLink/SDLDimension.h
index a05d9f1f0..a1c5ab858 100644
--- a/SmartDeviceLink/SDLDimension.h
+++ b/SmartDeviceLink/SDLDimension.h
@@ -5,23 +5,23 @@
#import "SDLEnum.h"
/**
- * The supported dimensions of the GPS.
+ * The supported dimensions of the GPS. Used in GPSData
*
* @since SDL 2.0
*/
typedef SDLEnum SDLDimension SDL_SWIFT_ENUM;
/**
- * @abstract No GPS at all
+ * No GPS at all
*/
extern SDLDimension const SDLDimensionNoFix;
/**
- * @abstract Longitude and latitude of the GPS
+ * Longitude and latitude of the GPS
*/
extern SDLDimension const SDLDimension2D;
/**
- * @abstract Longitude and latitude and altitude of the GPS
+ * Longitude and latitude and altitude of the GPS
*/
extern SDLDimension const SDLDimension3D;
diff --git a/SmartDeviceLink/SDLDisplayCapabilities+ShowManagerExtensions.m b/SmartDeviceLink/SDLDisplayCapabilities+ShowManagerExtensions.m
index 351c62532..188b10729 100644
--- a/SmartDeviceLink/SDLDisplayCapabilities+ShowManagerExtensions.m
+++ b/SmartDeviceLink/SDLDisplayCapabilities+ShowManagerExtensions.m
@@ -40,6 +40,10 @@ - (NSUInteger)maxNumberOfMainFieldLines {
}
- (BOOL)hasImageFieldOfName:(SDLImageFieldName)name {
+ if (!self.graphicSupported.boolValue) {
+ return NO;
+ }
+
for (SDLImageField *imageField in self.imageFields) {
if ([imageField.name isEqualToString:name]) {
return YES;
diff --git a/SmartDeviceLink/SDLDisplayCapabilities.h b/SmartDeviceLink/SDLDisplayCapabilities.h
index 3ef70cb1b..5df48f201 100644
--- a/SmartDeviceLink/SDLDisplayCapabilities.h
+++ b/SmartDeviceLink/SDLDisplayCapabilities.h
@@ -21,14 +21,14 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLDisplayCapabilities : SDLRPCStruct
/**
- * @abstract The type of display
+ * The type of display
*
* Required
*/
@property (strong, nonatomic) SDLDisplayType displayType;
/**
- * @abstract An array of SDLTextField structures, each of which describes a field in the HMI which the application can write to using operations such as *SDLShow*, *SDLSetMediaClockTimer*, etc.
+ * An array of SDLTextField structures, each of which describes a field in the HMI which the application can write to using operations such as *SDLShow*, *SDLSetMediaClockTimer*, etc.
*
* @discussion This array of SDLTextField structures identify all the text fields to which the application can write on the current display (identified by SDLDisplayType).
*
@@ -39,7 +39,7 @@ NS_ASSUME_NONNULL_BEGIN
@property (strong, nonatomic) NSArray