summaryrefslogtreecommitdiff
path: root/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h
diff options
context:
space:
mode:
Diffstat (limited to 'SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h')
-rw-r--r--SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h31
1 files changed, 30 insertions, 1 deletions
diff --git a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h
index ab1031713..cea9cc9c3 100644
--- a/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h
+++ b/SmartDeviceLink-iOS/SmartDeviceLink/SDLDeleteInteractionChoiceSet.h
@@ -1,15 +1,44 @@
// SDLDeleteInteractionChoiceSet.h
//
-// Copyright (c) 2014 Ford Motor Company. All rights reserved.
#import "SDLRPCRequest.h"
+/**
+ * Deletes an existing Choice Set identified by the parameter
+ * interactionChoiceSetID. If the specified interactionChoiceSetID is currently
+ * in use by an active <i> SDLPerformInteraction</i> this call to
+ * delete the Choice Set will fail returning an IN_USE resultCode
+ * <p>
+ * Function Group: Base
+ * <p>
+ * <b>HMILevel needs to be FULL, LIMITED or BACKGROUD</b><br/>
+ * </p>
+ *
+ * Since <b>SmartDeviceLink 1.0</b><br>
+ * see SDLCreateInteractionChoiceSet SDLPerformInteraction
+ */
@interface SDLDeleteInteractionChoiceSet : SDLRPCRequest {}
+/**
+ * Constructs a new SDLDeleteInteractionChoiceSet object
+ */
-(id) init;
+/**
+ * Constructs a new SDLDeleteInteractionChoiceSet object indicated by the
+ * NSMutableDictionary parameter
+ * <p>
+ *
+ * @param dict The NSMutableDictionary to use
+ */
-(id) initWithDictionary:(NSMutableDictionary*) dict;
+/**
+ * @abstract a unique ID that identifies the Choice Set
+ * @discussion a unique ID that identifies the Choice Set
+ * <p>
+ * <b>Notes: </b>Min Value: 0; Max Value: 2000000000
+ */
@property(strong) NSNumber* interactionChoiceSetID;
@end