summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLCreateInteractionChoiceSet.h
diff options
context:
space:
mode:
Diffstat (limited to 'SmartDeviceLink/SDLCreateInteractionChoiceSet.h')
-rw-r--r--SmartDeviceLink/SDLCreateInteractionChoiceSet.h49
1 files changed, 49 insertions, 0 deletions
diff --git a/SmartDeviceLink/SDLCreateInteractionChoiceSet.h b/SmartDeviceLink/SDLCreateInteractionChoiceSet.h
new file mode 100644
index 000000000..721f505d7
--- /dev/null
+++ b/SmartDeviceLink/SDLCreateInteractionChoiceSet.h
@@ -0,0 +1,49 @@
+// SDLCreateInteractionChoiceSet.h
+//
+
+
+#import "SDLRPCRequest.h"
+
+/**
+ * Creates a Choice Set which can be used in subsequent *SDLPerformInteraction* Operations.
+ *
+ * HMILevel needs to be FULL, LIMITED or BACKGROUND
+ *
+ * Before a perform interaction is sent you MUST wait for the success from the CreateInteractionChoiceSet RPC.
+ *
+ * If you do not wait the system may not recognize the first utterance from the user.
+ *
+ * @since SDL 1.0
+ *
+ * @see SDLDeleteInteractionChoiceSet SDLPerformInteraction
+ */
+@interface SDLCreateInteractionChoiceSet : SDLRPCRequest {
+}
+
+/**
+ * Constructs a new SDLCreateInteractionChoiceSet object
+ */
+- (instancetype)init;
+
+/**
+ * Constructs a new SDLCreateInteractionChoiceSet object indicated by the dictionary parameter
+ *
+ * @param dict The dictionary to use
+ */
+- (instancetype)initWithDictionary:(NSMutableDictionary *)dict;
+
+/**
+ * @abstract A unique ID that identifies the Choice Set
+ *
+ * Required, Integer, 0 - 2,000,000,000
+ */
+@property (strong) NSNumber *interactionChoiceSetID;
+
+/**
+ * @abstract Array of choices, which the user can select by menu or voice recognition
+ *
+ * Required, SDLChoice, Array size 1 - 100
+ */
+@property (strong) NSMutableArray *choiceSet;
+
+@end