summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicoleYarroch <nicole@livio.io>2018-09-04 15:23:44 -0400
committerNicoleYarroch <nicole@livio.io>2018-09-04 15:23:44 -0400
commit58a2d76e9edd4ba3d580437a328dc52bb2726f28 (patch)
treef07c54d3a10103d91a6f5938d406a13b04364682
parent5af9afca913a9c470f973b7bd3a63863d491ef3a (diff)
downloadsdl_ios-58a2d76e9edd4ba3d580437a328dc52bb2726f28.tar.gz
Updated documentation for RAI class
Signed-off-by: NicoleYarroch <nicole@livio.io>
-rw-r--r--SmartDeviceLink/SDLLifecycleConfiguration.h2
-rw-r--r--SmartDeviceLink/SDLRegisterAppInterface.h6
2 files changed, 6 insertions, 2 deletions
diff --git a/SmartDeviceLink/SDLLifecycleConfiguration.h b/SmartDeviceLink/SDLLifecycleConfiguration.h
index eb6e0d165..a558c0dea 100644
--- a/SmartDeviceLink/SDLLifecycleConfiguration.h
+++ b/SmartDeviceLink/SDLLifecycleConfiguration.h
@@ -103,7 +103,7 @@ NS_ASSUME_NONNULL_BEGIN
*
* Optional
*
- * @discussion The `fullAppId` is used to authenticate apps that connect with head units that implement SDL Core v.5.0 and newer. If connecting with older head units, the `fullAppId` can be truncated to create the required `appId` needed to register the app. The `appId` is the first 10 non-dash ("-") characters of the `fullAppID` (e.g. if you have a `fullAppId` of 123e4567-e89b-12d3-a456-426655440000, the `appId` will be 123e4567e8).
+ * @discussion The `fullAppId` is used to authenticate apps that connect with head units that implement SDL Core v.5.0 and newer. If connecting with older head units, the `fullAppId` can be truncated to create the required `appId` needed to register the app. The `appId` is the first 10 non-dash ("-") characters of the `fullAppId` (e.g. if you have a `fullAppId` of 123e4567-e89b-12d3-a456-426655440000, the `appId` will be 123e4567e8).
*/
@property (copy, nonatomic, nullable, readonly) NSString *fullAppId;
diff --git a/SmartDeviceLink/SDLRegisterAppInterface.h b/SmartDeviceLink/SDLRegisterAppInterface.h
index 504451c22..4138c2810 100644
--- a/SmartDeviceLink/SDLRegisterAppInterface.h
+++ b/SmartDeviceLink/SDLRegisterAppInterface.h
@@ -219,6 +219,8 @@ NS_ASSUME_NONNULL_BEGIN
*
* Required, max length 100
*
+ * @see `fullAppID`
+ *
* @since SDL 2.0
*/
@property (strong, nonatomic) NSString *appID;
@@ -226,7 +228,9 @@ NS_ASSUME_NONNULL_BEGIN
/**
* A full UUID appID used to validate app with policy table entries.
*
- * Required
+ * Optional
+ *
+ * @discussion The `fullAppId` is used to authenticate apps that connect with head units that implement SDL Core v.5.0 and newer. If connecting with older head units, the `fullAppId` can be truncated to create the required `appId` needed to register the app. The `appId` is the first 10 non-dash ("-") characters of the `fullAppID` (e.g. if you have a `fullAppId` of 123e4567-e89b-12d3-a456-426655440000, the `appId` will be 123e4567e8).
*/
@property (nullable, strong, nonatomic) NSString *fullAppID;