diff options
author | Joel Fischer <joeljfischer@gmail.com> | 2018-05-25 10:07:35 -0400 |
---|---|---|
committer | Joel Fischer <joeljfischer@gmail.com> | 2018-05-25 10:07:35 -0400 |
commit | f5eff2f886242be39cdf2e0ae49dd5bdcee9d56b (patch) | |
tree | b6a2a32ba4f9c566b10b96d3ae0d9a778f020454 | |
parent | 25bfc4623148f7629f9f40ce515bd3eb13108a8e (diff) | |
download | sdl_ios-f5eff2f886242be39cdf2e0ae49dd5bdcee9d56b.tar.gz |
Add more documentationbug/issue_97_add_remaining_documentation
-rw-r--r-- | SmartDeviceLink/SDLNotificationConstants.h | 11 | ||||
-rw-r--r-- | SmartDeviceLink/SDLOnInteriorVehicleData.h | 3 | ||||
-rw-r--r-- | SmartDeviceLink/SDLRPCNotification.h | 3 | ||||
-rw-r--r-- | SmartDeviceLink/SDLRPCNotificationNotification.h | 14 | ||||
-rw-r--r-- | SmartDeviceLink/SDLRPCResponseNotification.h | 14 | ||||
-rw-r--r-- | SmartDeviceLink/SDLScreenManager.h | 75 | ||||
-rw-r--r-- | SmartDeviceLink/SDLSecurityType.h | 45 | ||||
-rw-r--r-- | SmartDeviceLink/SDLSetDisplayLayoutResponse.h | 15 | ||||
-rw-r--r-- | SmartDeviceLink/SDLSetGlobalProperties.h | 127 | ||||
-rw-r--r-- | SmartDeviceLink/SDLSoftButtonObject.h | 6 | ||||
-rw-r--r-- | SmartDeviceLink/SDLStreamingMediaConfiguration.h | 7 | ||||
-rw-r--r-- | SmartDeviceLink/SDLStreamingMediaManagerConstants.h | 7 | ||||
-rw-r--r-- | SmartDeviceLink/SDLSubscribeVehicleData.h | 49 | ||||
-rw-r--r-- | SmartDeviceLink/SDLSyncPData.h | 5 | ||||
-rw-r--r-- | SmartDeviceLink/SDLTTSChunk.h | 36 | ||||
-rw-r--r-- | SmartDeviceLink/SDLUnsubscribeVehicleData.h | 24 | ||||
-rw-r--r-- | SmartDeviceLink/SDLUnsubscribeWayPoints.h | 3 |
17 files changed, 383 insertions, 61 deletions
diff --git a/SmartDeviceLink/SDLNotificationConstants.h b/SmartDeviceLink/SDLNotificationConstants.h index 52b025303..41b220134 100644 --- a/SmartDeviceLink/SDLNotificationConstants.h +++ b/SmartDeviceLink/SDLNotificationConstants.h @@ -192,7 +192,18 @@ extern SDLNotificationName const SDLDidReceiveWaypointNotification; @interface SDLNotificationConstants : NSObject +/** + All of the possible SDL RPC Response notification names + + @return The names + */ + (NSArray<SDLNotificationName> *)allResponseNames; + +/** + All of the possible SDL Button event notification names + + @return The names + */ + (NSArray<SDLNotificationName> *)allButtonEventNotifications; @end diff --git a/SmartDeviceLink/SDLOnInteriorVehicleData.h b/SmartDeviceLink/SDLOnInteriorVehicleData.h index 3c53687bf..e54ad91bf 100644 --- a/SmartDeviceLink/SDLOnInteriorVehicleData.h +++ b/SmartDeviceLink/SDLOnInteriorVehicleData.h @@ -14,6 +14,9 @@ NS_ASSUME_NONNULL_BEGIN */ @interface SDLOnInteriorVehicleData : SDLRPCNotification +/** + The subscribed module data that changed + */ @property (strong, nonatomic) SDLModuleData *moduleData; @end diff --git a/SmartDeviceLink/SDLRPCNotification.h b/SmartDeviceLink/SDLRPCNotification.h index cb5044d6c..269fdc7a6 100644 --- a/SmartDeviceLink/SDLRPCNotification.h +++ b/SmartDeviceLink/SDLRPCNotification.h @@ -6,6 +6,9 @@ NS_ASSUME_NONNULL_BEGIN +/** + An RPC sent from the head unit to the app about some data change, such as a button was pressed + */ @interface SDLRPCNotification : SDLRPCMessage @end diff --git a/SmartDeviceLink/SDLRPCNotificationNotification.h b/SmartDeviceLink/SDLRPCNotificationNotification.h index 6b0060a9d..8e0d9a616 100644 --- a/SmartDeviceLink/SDLRPCNotificationNotification.h +++ b/SmartDeviceLink/SDLRPCNotificationNotification.h @@ -13,10 +13,24 @@ NS_ASSUME_NONNULL_BEGIN +/** + An NSNotification object that makes retrieving internal SDLRPCNotification data easier + */ @interface SDLRPCNotificationNotification : NSNotification +/** + The notification within the userinfo dictionary + */ @property (copy, nonatomic, readonly) __kindof SDLRPCNotification *notification; +/** + Create an NSNotification object caontaining an SDLRPCNotification + + @param name The NSNotification name + @param object The NSNotification object + @param notification The SDLRPCNotification payload + @return The NSNotification + */ - (instancetype)initWithName:(NSString *)name object:(nullable id)object rpcNotification:(__kindof SDLRPCNotification *)notification; /** diff --git a/SmartDeviceLink/SDLRPCResponseNotification.h b/SmartDeviceLink/SDLRPCResponseNotification.h index 42647897e..c6c7cdf3a 100644 --- a/SmartDeviceLink/SDLRPCResponseNotification.h +++ b/SmartDeviceLink/SDLRPCResponseNotification.h @@ -13,10 +13,24 @@ NS_ASSUME_NONNULL_BEGIN +/** + An NSNotification object that makes retrieving internal SDLRPCResponse data easier + */ @interface SDLRPCResponseNotification : NSNotification +/** + The response within the userinfo dictionary + */ @property (copy, nonatomic, readonly) __kindof SDLRPCResponse *response; +/** + Create an NSNotification object caontaining an SDLRPCResponse + + @param name The NSNotification name + @param object The NSNotification object + @param response The SDLRPCResponse payload + @return The NSNotification + */ - (instancetype)initWithName:(NSString *)name object:(nullable id)object rpcResponse:(__kindof SDLRPCResponse *)response; /** diff --git a/SmartDeviceLink/SDLScreenManager.h b/SmartDeviceLink/SDLScreenManager.h index c3dc1e020..c058a710d 100644 --- a/SmartDeviceLink/SDLScreenManager.h +++ b/SmartDeviceLink/SDLScreenManager.h @@ -30,29 +30,96 @@ typedef void(^SDLScreenManagerUpdateCompletionHandler)(NSError *__nullable error @interface SDLScreenManager : NSObject +/** + The top text field within a template layout + */ @property (copy, nonatomic, nullable) NSString *textField1; + +/** + The second text field within a template layout + */ @property (copy, nonatomic, nullable) NSString *textField2; + +/** + The third text field within a template layout + */ @property (copy, nonatomic, nullable) NSString *textField3; + +/** + The fourth text field within a template layout + */ @property (copy, nonatomic, nullable) NSString *textField4; + +/** + The media text field available within the media layout. Often less emphasized than textField(1-4) + */ @property (copy, nonatomic, nullable) NSString *mediaTrackTextField; + +/** + The primary graphic within a template layout + */ @property (strong, nonatomic, nullable) SDLArtwork *primaryGraphic; + +/** + A secondary graphic used in some template layouts + */ @property (strong, nonatomic, nullable) SDLArtwork *secondaryGraphic; +/** + What alignment textField(1-4) should use + */ @property (copy, nonatomic) SDLTextAlignment textAlignment; + +/** + The type of data textField1 describes + */ @property (copy, nonatomic, nullable) SDLMetadataType textField1Type; + +/** + The type of data textField2 describes + */ @property (copy, nonatomic, nullable) SDLMetadataType textField2Type; + +/** + The type of data textField3 describes + */ @property (copy, nonatomic, nullable) SDLMetadataType textField3Type; + +/** + The type of data textField4 describes + */ @property (copy, nonatomic, nullable) SDLMetadataType textField4Type; +/** + The current list of soft buttons within a template layout. Set this array to change the displayed soft buttons. + */ @property (copy, nonatomic) NSArray<SDLSoftButtonObject *> *softButtonObjects; +/** + The current list of menu cells displayed in the app's menu. + */ @property (copy, nonatomic) NSArray<SDLMenuCell *> *menu; + +/** + The current list of voice commands available for the user to speak and be recognized by the IVI's voice recognition engine. + */ @property (copy, nonatomic) NSArray<SDLVoiceCommand *> *voiceCommands; +/** + Initialize a screen manager + + @warning For internal use + + @param connectionManager The connection manager used to send RPCs + @param fileManager The file manager used to upload files + @return The screen manager + */ - (instancetype)initWithConnectionManager:(id<SDLConnectionManagerType>)connectionManager fileManager:(SDLFileManager *)fileManager; /** - * Stops the manager. This method is used internally. + Stops the manager. + + @warning For internal use */ - (void)stop; @@ -80,6 +147,12 @@ typedef void(^SDLScreenManagerUpdateCompletionHandler)(NSError *__nullable error */ - (void)endUpdatesWithCompletionHandler:(nullable SDLScreenManagerUpdateCompletionHandler)handler; +/** + Find a current soft button object with a specific name + + @param name The name of the soft button object to find + @return The soft button object or nil if there isn't one with that name + */ - (nullable SDLSoftButtonObject *)softButtonObjectNamed:(NSString *)name; @end diff --git a/SmartDeviceLink/SDLSecurityType.h b/SmartDeviceLink/SDLSecurityType.h index c459665f8..202149e79 100644 --- a/SmartDeviceLink/SDLSecurityType.h +++ b/SmartDeviceLink/SDLSecurityType.h @@ -10,18 +10,63 @@ NS_ASSUME_NONNULL_BEGIN +/** + A protocol used by SDL Security libraries. + + @warning Used internally + */ @protocol SDLSecurityType <NSObject> +/** + The app id of the app + */ @property (copy, nonatomic) NSString *appId; +/** + Initialize the SDL security library with the app's id and a completion handler + + @param appId The app's id + @param completionHandler A handler for when the security library is initialized + */ - (void)initializeWithAppId:(NSString *)appId completionHandler:(void (^)(NSError *_Nullable error))completionHandler; + +/** + Stop the security library + */ - (void)stop; +/** + Run the SSL/TLS handshake + + @param data The client data for the handshake + @param error A returnable error + @return The server handshake data + */ - (nullable NSData *)runHandshakeWithClientData:(NSData *)data error:(NSError **)error; +/** + Encrypt data using SSL/TLS + + @param data The data to encrypt + @param error A returnable error + @return The encrypted data + */ - (nullable NSData *)encryptData:(NSData *)data withError:(NSError **)error; + +/** + Decrypt data using SSL/TLS + + @param data The data to decrypt + @param error A returnable error + @return The decrypted data + */ - (nullable NSData *)decryptData:(NSData *)data withError:(NSError **)error; +/** + The vehicle makes this security library covers + + @return The makes + */ + (NSSet<NSString *> *)availableMakes; @end diff --git a/SmartDeviceLink/SDLSetDisplayLayoutResponse.h b/SmartDeviceLink/SDLSetDisplayLayoutResponse.h index edaee6343..69987222d 100644 --- a/SmartDeviceLink/SDLSetDisplayLayoutResponse.h +++ b/SmartDeviceLink/SDLSetDisplayLayoutResponse.h @@ -18,9 +18,24 @@ NS_ASSUME_NONNULL_BEGIN */ @interface SDLSetDisplayLayoutResponse : SDLRPCResponse +/** + The display capabilities of the new template layout + */ @property (nullable, strong, nonatomic) SDLDisplayCapabilities *displayCapabilities; + +/** + The button capabilities of the new template layout + */ @property (nullable, strong, nonatomic) NSArray<SDLButtonCapabilities *> *buttonCapabilities; + +/** + The soft button capabilities of the new template layout + */ @property (nullable, strong, nonatomic) NSArray<SDLSoftButtonCapabilities *> *softButtonCapabilities; + +/** + The preset bank capabilities of the new template layout + */ @property (nullable, strong, nonatomic) SDLPresetBankCapabilities *presetBankCapabilities; @end diff --git a/SmartDeviceLink/SDLSetGlobalProperties.h b/SmartDeviceLink/SDLSetGlobalProperties.h index 2336e8258..7b3370d9b 100644 --- a/SmartDeviceLink/SDLSetGlobalProperties.h +++ b/SmartDeviceLink/SDLSetGlobalProperties.h @@ -8,87 +8,100 @@ @class SDLTTSChunk; @class SDLVRHelpItem; -/** - * Sets value(s) for the specified global property(ies) - * <p> - * Function Group: Base <p> - * <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> - * </p> - * - * Since SmartDeviceLink 1.0 - * See SDLResetGlobalProperties - */ - NS_ASSUME_NONNULL_BEGIN +/** + Sets global property values + + Since SmartDeviceLink 1.0 + + See SDLResetGlobalProperties + */ @interface SDLSetGlobalProperties : SDLRPCRequest +/** + Initialize SetGlobalProperties with help text and timeout text + + @param helpText A string that will be turned into TTS chunks for the help prompt + @param timeoutText A string that will be turned into TTS chunks for the timeout prompt + @return The SetGlobalProperties RPC + */ - (instancetype)initWithHelpText:(nullable NSString *)helpText timeoutText:(nullable NSString *)timeoutText; +/** + Initialize SetGlobalProperties with help text, timeout text, help title, and help items + + @param helpText A string that will be turned into TTS chunks for the help prompt + @param timeoutText A string that will be turned into TTS chunks for the timeout prompt + @param vrHelpTitle The title of the help interface prompt + @param vrHelp The items of the help interface prompt + @return The SetGlobalProperties RPC + */ - (instancetype)initWithHelpText:(nullable NSString *)helpText timeoutText:(nullable NSString *)timeoutText vrHelpTitle:(nullable NSString *)vrHelpTitle vrHelp:(nullable NSArray<SDLVRHelpItem *> *)vrHelp; +/** + Initialize SetGlobalProperties with all possible items + + @param helpText A string that will be turned into TTS chunks for the help prompt + @param timeoutText A string that will be turned into TTS chunks for the timeout prompt + @param vrHelpTitle The title of the help interface prompt + @param vrHelp The items of the help interface prompt + @param menuTitle The title of the menu button + @param menuIcon The icon on the menu button + @param keyboardProperties The properties of a keyboard prompt + @return The SetGlobalProperties RPC + */ - (instancetype)initWithHelpText:(nullable NSString *)helpText timeoutText:(nullable NSString *)timeoutText vrHelpTitle:(nullable NSString *)vrHelpTitle vrHelp:(nullable NSArray<SDLVRHelpItem *> *)vrHelp menuTitle:(nullable NSString *)menuTitle menuIcon:(nullable SDLImage *)menuIcon keyboardProperties:(nullable SDLKeyboardProperties *)keyboardProperties; /** - * Sets a Vector<TTSChunk> for Help Prompt that Array of one or more - * TTSChunk elements specifying the help prompt used in an interaction - * started by PTT - * @discussion helpPrompt - * a Vector<TTSChunk> of one or more TTSChunk elements - * <p> - * <b>Notes: </b> - * <ul> - * <li>Array must have at least one element</li> - * <li>Only optional it timeoutPrompt has been specified</li> - * </ul> + Help prompt for when the user asks for help with an interface prompt + + Optional */ @property (strong, nonatomic, nullable) NSArray<SDLTTSChunk *> *helpPrompt; + /** - * A Vector<TTSChunk> for Timeout Prompt representing Array of one or - * more TTSChunk elements specifying the help prompt used in an interaction - * started by PTT - * + Help prompt for when an interface prompt times out + + Optional, Array, at least 1 item */ @property (strong, nonatomic, nullable) NSArray<SDLTTSChunk *> *timeoutPrompt; + /** - * Sets a voice recognition Help Title - * - * @discussion A String value representing a voice recognition Help Title - * <p> - * <b>Notes: </b><br/> - * <ul> - * <li>If omitted on supported displays, the default SDL help - * title will be used</li> - * <li>If omitted and one or more vrHelp items are provided, the - * request will be rejected.</li> - * <li>String Maxlength = 500</li> - * </ul> - * @since SmartDeviceLink 2.0 + Sets a voice recognition Help Title + + Optional */ @property (strong, nonatomic, nullable) NSString *vrHelpTitle; + /** - * Sets the items listed in the VR help screen used in an interaction - * started by PTT - * - * @discussion A Vector value representing items listed in the VR help screen - * used in an interaction started by PTT - * <p> - * <b>Notes: </b><br/> - * <ul> - * <li>If omitted on supported displays, the default SmartDeviceLink VR - * help / What Can I Say? screen will be used</li> - * <li>If the list of VR Help Items contains nonsequential - * positions (e.g. [1,2,4]), the RPC will be rejected</li> - * <li>If omitted and a vrHelpTitle is provided, the request - * will be rejected</li> - * <li>Array Minsize: = 1</li> - * <li>Array Maxsize = 100</li> - * </ul> - * @since SmartDeviceLink 2.0 + Sets the items listed in the VR help screen used in an interaction started by Push to Talk + + @since SmartDeviceLink 2.0 + + Optional */ @property (strong, nonatomic, nullable) NSArray<SDLVRHelpItem *> *vrHelp; + +/** + Text for the menu button label + + Optional + */ @property (strong, nonatomic, nullable) NSString *menuTitle; + +/** + Icon for the menu button + + Optional + */ @property (strong, nonatomic, nullable) SDLImage *menuIcon; + +/** + On-screen keyboard (perform interaction) configuration + + Optional + */ @property (strong, nonatomic, nullable) SDLKeyboardProperties *keyboardProperties; @end diff --git a/SmartDeviceLink/SDLSoftButtonObject.h b/SmartDeviceLink/SDLSoftButtonObject.h index 706c31d17..fe641a56e 100644 --- a/SmartDeviceLink/SDLSoftButtonObject.h +++ b/SmartDeviceLink/SDLSoftButtonObject.h @@ -17,6 +17,9 @@ NS_ASSUME_NONNULL_BEGIN +/** + A soft button wrapper object that is capable of storing and switching between states + */ @interface SDLSoftButtonObject : NSObject /** @@ -70,6 +73,9 @@ NS_ASSUME_NONNULL_BEGIN */ - (BOOL)transitionToStateNamed:(NSString *)stateName NS_SWIFT_NAME(transition(toState:)); +/** + Transition the soft button to the next state of the array set when in the `states` property + */ - (void)transitionToNextState; /** diff --git a/SmartDeviceLink/SDLStreamingMediaConfiguration.h b/SmartDeviceLink/SDLStreamingMediaConfiguration.h index 98db9258d..3e4f91849 100644 --- a/SmartDeviceLink/SDLStreamingMediaConfiguration.h +++ b/SmartDeviceLink/SDLStreamingMediaConfiguration.h @@ -16,6 +16,13 @@ NS_ASSUME_NONNULL_BEGIN +/** + The type of rendering that CarWindow will perform. Depending on your app, you may need to try different ones for best performance + + - SDLCarWindowRenderingTypeLayer: Instead of rendering your UIViewController's view, this will render the layer using `renderInContext` + - SDLCarWindowRenderingTypeViewAfterScreenUpdates: Renders your UIViewController's view using `drawViewHierarchyInRect:bounds afterScreenUpdates:YES` + - SDLCarWindowRenderingTypeViewBeforeScreenUpdates: Renders your UIViewController's view using `drawViewHierarchyInRect:bounds afterScreenUpdates:NO` + */ typedef NS_ENUM(NSUInteger, SDLCarWindowRenderingType) { SDLCarWindowRenderingTypeLayer, SDLCarWindowRenderingTypeViewAfterScreenUpdates, diff --git a/SmartDeviceLink/SDLStreamingMediaManagerConstants.h b/SmartDeviceLink/SDLStreamingMediaManagerConstants.h index 0e6cbe88c..f3a7398b8 100644 --- a/SmartDeviceLink/SDLStreamingMediaManagerConstants.h +++ b/SmartDeviceLink/SDLStreamingMediaManagerConstants.h @@ -10,6 +10,13 @@ NS_ASSUME_NONNULL_BEGIN +/** + A flag determining how video and audio streaming should be encrypted + + - SDLStreamingEncryptionFlagNone: It should not be encrypted at all + - SDLStreamingEncryptionFlagAuthenticateOnly: It should use SSL/TLS only to authenticate + - SDLStreamingEncryptionFlagAuthenticateAndEncrypt: All data on these services should be encrypted using SSL/TLS + */ typedef NS_ENUM(NSInteger, SDLStreamingEncryptionFlag) { SDLStreamingEncryptionFlagNone, SDLStreamingEncryptionFlagAuthenticateOnly, diff --git a/SmartDeviceLink/SDLSubscribeVehicleData.h b/SmartDeviceLink/SDLSubscribeVehicleData.h index 34cca021d..4e874d2ab 100644 --- a/SmartDeviceLink/SDLSubscribeVehicleData.h +++ b/SmartDeviceLink/SDLSubscribeVehicleData.h @@ -24,6 +24,35 @@ NS_ASSUME_NONNULL_BEGIN @interface SDLSubscribeVehicleData : SDLRPCRequest +/** + Initialize a subscribe RPC with various possible to describe to + + @param accelerationPedalPosition Subcribe to accelerationPedalPosition + @param airbagStatus Subcribe to airbagStatus + @param beltStatus Subcribe to beltStatus + @param bodyInformation Subcribe to bodyInformation + @param clusterModeStatus Subcribe to clusterModeStatus + @param deviceStatus Subcribe to deviceStatus + @param driverBraking Subcribe to driverBraking + @param eCallInfo Subcribe to eCallInfo + @param emergencyEvent Subcribe to v + @param engineTorque Subcribe to engineTorque + @param externalTemperature Subcribe to externalTemperature + @param fuelLevel Subcribe to fuelLevel + @param fuelLevelState Subcribe to fuelLevelState + @param gps Subcribe to gps + @param headLampStatus Subcribe to headLampStatus + @param instantFuelConsumption Subcribe to instantFuelConsumption + @param myKey Subcribe to myKey + @param odometer Subcribe to odometer + @param prndl Subcribe to prndl + @param rpm Subcribe to rpm + @param speed Subcribe to speed + @param steeringWheelAngle Subcribe to steeringWheelAngle + @param tirePressure Subcribe to tirePressure + @param wiperStatus Subcribe to wiperStatus + @return The RPC + */ - (instancetype)initWithAccelerationPedalPosition:(BOOL)accelerationPedalPosition airbagStatus:(BOOL)airbagStatus beltStatus:(BOOL)beltStatus bodyInformation:(BOOL)bodyInformation clusterModeStatus:(BOOL)clusterModeStatus deviceStatus:(BOOL)deviceStatus driverBraking:(BOOL)driverBraking eCallInfo:(BOOL)eCallInfo emergencyEvent:(BOOL)emergencyEvent engineTorque:(BOOL)engineTorque externalTemperature:(BOOL)externalTemperature fuelLevel:(BOOL)fuelLevel fuelLevelState:(BOOL)fuelLevelState gps:(BOOL)gps headLampStatus:(BOOL)headLampStatus instantFuelConsumption:(BOOL)instantFuelConsumption myKey:(BOOL)myKey odometer:(BOOL)odometer prndl:(BOOL)prndl rpm:(BOOL)rpm speed:(BOOL)speed steeringWheelAngle:(BOOL)steeringWheelAngle tirePressure:(BOOL)tirePressure wiperStatus:(BOOL)wiperStatus; /** @@ -122,10 +151,30 @@ NS_ASSUME_NONNULL_BEGIN * subscribed. */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *steeringWheelAngle; + +/** + Subscribe to eCallInfo + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *eCallInfo; + +/** + Subscribe to airbagStatus + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *airbagStatus; + +/** + Subscribe to emergencyEvent + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *emergencyEvent; + +/** + Subscribe to clusterModeStatus + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *clusterModeStatus; + +/** + Subscribe to myKey + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *myKey; @end diff --git a/SmartDeviceLink/SDLSyncPData.h b/SmartDeviceLink/SDLSyncPData.h index e35a62fab..c19fae453 100644 --- a/SmartDeviceLink/SDLSyncPData.h +++ b/SmartDeviceLink/SDLSyncPData.h @@ -4,14 +4,13 @@ #import "SDLRPCRequest.h" +NS_ASSUME_NONNULL_BEGIN + /* * Allows binary data in the form of SyncP packets to be sent to the SYNC module. Binary data is in binary part of hybrid msg. * * *** DEPRECATED *** */ - -NS_ASSUME_NONNULL_BEGIN - @interface SDLSyncPData : SDLRPCRequest @end diff --git a/SmartDeviceLink/SDLTTSChunk.h b/SmartDeviceLink/SDLTTSChunk.h index 602dcdbd2..4c27ead53 100644 --- a/SmartDeviceLink/SDLTTSChunk.h +++ b/SmartDeviceLink/SDLTTSChunk.h @@ -18,16 +18,52 @@ NS_ASSUME_NONNULL_BEGIN */ @interface SDLTTSChunk : SDLRPCStruct +/** + Initialize with text and a type + + @param text The string to be spoken + @param type The type of text the string is + @return The RPC + */ - (instancetype)initWithText:(NSString *)text type:(SDLSpeechCapabilities)type; +/** + Create TTS using text + + @param string The text chunk + @return The RPC + */ + (NSArray<SDLTTSChunk *> *)textChunksFromString:(NSString *)string; +/** + Create TTS using SAPI + + @param string The SAPI chunk + @return The RPC + */ + (NSArray<SDLTTSChunk *> *)sapiChunksFromString:(NSString *)string; +/** + Create TTS using LH Plus + + @param string The LH Plus chunk + @return The RPC + */ + (NSArray<SDLTTSChunk *> *)lhPlusChunksFromString:(NSString *)string; +/** + Create TTS using prerecorded chunks + + @param string The prerecorded chunk + @return The RPC + */ + (NSArray<SDLTTSChunk *> *)prerecordedChunksFromString:(NSString *)string; +/** + Create TTS using silence + + @return The RPC + */ + (NSArray<SDLTTSChunk *> *)silenceChunks; diff --git a/SmartDeviceLink/SDLUnsubscribeVehicleData.h b/SmartDeviceLink/SDLUnsubscribeVehicleData.h index a305afdc1..5ba4d627f 100644 --- a/SmartDeviceLink/SDLUnsubscribeVehicleData.h +++ b/SmartDeviceLink/SDLUnsubscribeVehicleData.h @@ -112,11 +112,35 @@ NS_ASSUME_NONNULL_BEGIN * A boolean value. If true, unsubscribes accPedalPosition data */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *accPedalPosition; + +/** + If true, unsubscribes from steeringWheelAngle + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *steeringWheelAngle; + +/** + If true, unsubscribes from eCallInfo + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *eCallInfo; + +/** + If true, unsubscribes from airbagStatus + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *airbagStatus; + +/** + If true, unsubscribes from emergencyEvent + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *emergencyEvent; + +/** + If true, unsubscribes from clusterModeStatus + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *clusterModeStatus; + +/** + If true, unsubscribes from myKey + */ @property (strong, nonatomic, nullable) NSNumber<SDLBool> *myKey; @end diff --git a/SmartDeviceLink/SDLUnsubscribeWayPoints.h b/SmartDeviceLink/SDLUnsubscribeWayPoints.h index 5edce6bf5..4b67ac277 100644 --- a/SmartDeviceLink/SDLUnsubscribeWayPoints.h +++ b/SmartDeviceLink/SDLUnsubscribeWayPoints.h @@ -5,6 +5,9 @@ NS_ASSUME_NONNULL_BEGIN +/** + Request to unsubscribe from navigation WayPoints and Destination + */ @interface SDLUnsubscribeWayPoints : SDLRPCRequest @end |