summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicoleYarroch <nicole@livio.io>2018-05-24 11:02:06 -0400
committerNicoleYarroch <nicole@livio.io>2018-05-24 11:02:06 -0400
commit7e21ebd70333ebb571c99124df04b41f5a4bb2ee (patch)
tree197296dc187f56182313f9ead33a062b5189ae58
parentf312788a4553ee9558f3795cd4f14b7a0ccd3302 (diff)
downloadsdl_ios-7e21ebd70333ebb571c99124df04b41f5a4bb2ee.tar.gz
Added more documentation to the SDLRPCRequest and SDLRPCResponse files
Signed-off-by: NicoleYarroch <nicole@livio.io>
-rw-r--r--SmartDeviceLink/SDLRPCRequest.h2
-rw-r--r--SmartDeviceLink/SDLRPCResponse.h15
2 files changed, 16 insertions, 1 deletions
diff --git a/SmartDeviceLink/SDLRPCRequest.h b/SmartDeviceLink/SDLRPCRequest.h
index deb8e0e14..a25016a9b 100644
--- a/SmartDeviceLink/SDLRPCRequest.h
+++ b/SmartDeviceLink/SDLRPCRequest.h
@@ -9,7 +9,7 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLRPCRequest : SDLRPCMessage
/**
- * A unique id assigned to message sent to Core.
+ * A unique id assigned to message sent to Core. The Correlation ID is used to map a request to its response.
*/
@property (strong, nonatomic) NSNumber<SDLInt> *correlationID;
diff --git a/SmartDeviceLink/SDLRPCResponse.h b/SmartDeviceLink/SDLRPCResponse.h
index 270217e4a..bdb69893a 100644
--- a/SmartDeviceLink/SDLRPCResponse.h
+++ b/SmartDeviceLink/SDLRPCResponse.h
@@ -10,9 +10,24 @@ NS_ASSUME_NONNULL_BEGIN
@interface SDLRPCResponse : SDLRPCMessage
+/**
+ * The correlation id of the corresponding SDLRPCRequest.
+ */
@property (strong, nonatomic) NSNumber<SDLInt> *correlationID;
+
+/**
+ * Whether or not the SDLRPCRequest was successful.
+ */
@property (strong, nonatomic) NSNumber<SDLBool> *success;
+
+/**
+ * The result of the SDLRPCRequest. If the request failed, the result code contains the failure reason.
+ */
@property (strong, nonatomic) SDLResult resultCode;
+
+/**
+ * More detailed success or error message.
+ */
@property (nullable, strong, nonatomic) NSString *info;
@end