SDL_Android/SmartDeviceLinkAndroidProxy - added the correct version of the proxy

[profile/ivi/smartdevicelink.git] / SDL_Android / SmartDeviceLinkProxyAndroid / src / com / smartdevicelink / proxy / rpc / enums / InteractionMode.java

diff --git a/SDL_Android/SmartDeviceLinkProxyAndroid/src/com/smartdevicelink/proxy/rpc/enums/InteractionMode.java b/SDL_Android/SmartDeviceLinkProxyAndroid/src/com/smartdevicelink/proxy/rpc/enums/InteractionMode.java
index cc898dc..30eb426 100755 (executable)
--- a/SDL_Android/SmartDeviceLinkProxyAndroid/src/com/smartdevicelink/proxy/rpc/enums/InteractionMode.java
+++ b/SDL_Android/SmartDeviceLinkProxyAndroid/src/com/smartdevicelink/proxy/rpc/enums/InteractionMode.java
@@ -1,14 +1,54 @@
-//
-// Copyright (c) 2013 Ford Motor Company
-//
-package com.smartdevicelink.proxy.rpc.enums;
-
-public enum InteractionMode {
-    MANUAL_ONLY,
-    VR_ONLY,
-    BOTH;
-
-    public static InteractionMode valueForString(String value) {
-        return valueOf(value);
-    }
-}
+package com.smartdevicelink.proxy.rpc.enums;\r
+\r
+/**\r
+ * For application-initiated interactions (<i>{@linkplain com.smartdevicelink.proxy.rpc.PerformInteraction}</i>), this specifies\r
+ * the mode by which the user is prompted and by which the user's selection is\r
+ * indicated\r
+ * \r
+ * @since SmartDeviceLink 1.0\r
+ */\r
+public enum InteractionMode {\r
+       /**\r
+        * This mode causes the interaction to occur only on the display, meaning\r
+        * the choices are presented and selected only via the display. Selections\r
+        * are viewed with the SEEKRIGHT, SEEKLEFT, TUNEUP, TUNEDOWN buttons. User's\r
+        * selection is indicated with the OK button\r
+        */\r
+       MANUAL_ONLY,\r
+       /**\r
+        * This mode causes the interaction to occur only through TTS and VR. The\r
+        * user is prompted via TTS to select a choice by saying one of the choice's\r
+        * synonyms\r
+        */\r
+       VR_ONLY,\r
+       /**\r
+        * This mode is a combination of MANUAL_ONLY and VR_ONLY, meaning the user\r
+        * is prompted both visually and audibly. The user can make a selection\r
+        * either using the mode described in MANUAL_ONLY or using the mode\r
+        * described in VR_ONLY. If the user views selections as described in\r
+        * MANUAL_ONLY mode, the interaction becomes strictly, and irreversibly, a\r
+        * MANUAL_ONLY interaction (i.e. the VR session is cancelled, although the\r
+        * interaction itself is still in progress). If the user interacts with the\r
+        * VR session in any way (e.g. speaks a phrase, even if it is not a\r
+        * recognized choice), the interaction becomes strictly, and irreversibly, a\r
+        * VR_ONLY interaction (i.e. the MANUAL_ONLY mode forms of interaction will\r
+        * no longer be honored)\r
+        * <P>\r
+        * The TriggerSource parameter of the\r
+        * {@linkplain com.smartdevicelink.proxy.rpc.PerformInteraction} response will\r
+        * indicate which interaction mode the user finally chose to attempt the\r
+        * selection (even if the interaction did not end with a selection being\r
+        * made)\r
+        */\r
+       BOTH;\r
+\r
+       /**\r
+        * Returns InteractionMode (MANUAL_ONLY, VR_ONLY or BOTH)\r
+        * @param value a String\r
+        * @return InteractionMode -MANUAL_ONLY, VR_ONLY or BOTH\r
+        */\r
+\r
+    public static InteractionMode valueForString(String value) {\r
+        return valueOf(value);\r
+    }\r
+}\r