SDL_Android/SmartDeviceLinkProxyAndroid/src/com/smartdevicelink/proxy/rpc/enums/InteractionMode.java

   1 package com.smartdevicelink.proxy.rpc.enums;\r
   2 \r
   3 /**\r
   4  * For application-initiated interactions (<i>{@linkplain com.smartdevicelink.proxy.rpc.PerformInteraction}</i>), this specifies\r
   5  * the mode by which the user is prompted and by which the user's selection is\r
   6  * indicated\r
   7  * \r
   8  * @since SmartDeviceLink 1.0\r
   9  */\r
  10 public enum InteractionMode {\r
  11         /**\r
  12          * This mode causes the interaction to occur only on the display, meaning\r
  13          * the choices are presented and selected only via the display. Selections\r
  14          * are viewed with the SEEKRIGHT, SEEKLEFT, TUNEUP, TUNEDOWN buttons. User's\r
  15          * selection is indicated with the OK button\r
  16          */\r
  17         MANUAL_ONLY,\r
  18         /**\r
  19          * This mode causes the interaction to occur only through TTS and VR. The\r
  20          * user is prompted via TTS to select a choice by saying one of the choice's\r
  21          * synonyms\r
  22          */\r
  23         VR_ONLY,\r
  24         /**\r
  25          * This mode is a combination of MANUAL_ONLY and VR_ONLY, meaning the user\r
  26          * is prompted both visually and audibly. The user can make a selection\r
  27          * either using the mode described in MANUAL_ONLY or using the mode\r
  28          * described in VR_ONLY. If the user views selections as described in\r
  29          * MANUAL_ONLY mode, the interaction becomes strictly, and irreversibly, a\r
  30          * MANUAL_ONLY interaction (i.e. the VR session is cancelled, although the\r
  31          * interaction itself is still in progress). If the user interacts with the\r
  32          * VR session in any way (e.g. speaks a phrase, even if it is not a\r
  33          * recognized choice), the interaction becomes strictly, and irreversibly, a\r
  34          * VR_ONLY interaction (i.e. the MANUAL_ONLY mode forms of interaction will\r
  35          * no longer be honored)\r
  36          * <P>\r
  37          * The TriggerSource parameter of the\r
  38          * {@linkplain com.smartdevicelink.proxy.rpc.PerformInteraction} response will\r
  39          * indicate which interaction mode the user finally chose to attempt the\r
  40          * selection (even if the interaction did not end with a selection being\r
  41          * made)\r
  42          */\r
  43         BOTH;\r
  44 \r
  45         /**\r
  46          * Returns InteractionMode (MANUAL_ONLY, VR_ONLY or BOTH)\r
  47          * @param value a String\r
  48          * @return InteractionMode -MANUAL_ONLY, VR_ONLY or BOTH\r
  49          */\r
  50 \r
  51     public static InteractionMode valueForString(String value) {\r
  52         return valueOf(value);\r
  53     }\r
  54 }\r