Artifacts/bin/public/Tizen.System.Feedback.xml

   1 <?xml version="1.0"?>\r
   2 <doc>\r
   3     <assembly>\r
   4         <name>Tizen.System.Feedback</name>\r
   5     </assembly>\r
   6     <members>\r
   7         <member name="T:Tizen.System.Constants">\r
   8             <summary>\r
   9             The class for constants.\r
  10             </summary>\r
  11         </member>\r
  12         <member name="T:Tizen.System.Feedback">\r
  13             <summary>\r
  14             The Feedback API provides functions to control haptic and sound.\r
  15             The Feedback API provides the way to play and stop feedback, and get the information whether a specific pattern is supported.\r
  16             Below is the supported pattern string:\r
  17             Tap\r
  18             SoftInputPanel\r
  19             Key0\r
  20             Key1\r
  21             Key2\r
  22             Key3\r
  23             Key4\r
  24             Key5\r
  25             Key6\r
  26             Key7\r
  27             Key8\r
  28             Key9\r
  29             KeyStar\r
  30             KeySharp\r
  31             KeyBack\r
  32             Hold\r
  33             HardwareKeyPressed\r
  34             HardwareKeyHold\r
  35             Message\r
  36             Email\r
  37             WakeUp\r
  38             Schedule\r
  39             Timer\r
  40             General\r
  41             PowerOn\r
  42             PowerOff\r
  43             ChargerConnected\r
  44             ChargingError\r
  45             FullyCharged\r
  46             LowBattery\r
  47             Lock\r
  48             UnLock\r
  49             VibrationModeAbled\r
  50             SilentModeDisabled\r
  51             BluetoothDeviceConnected\r
  52             BluetoothDeviceDisconnected\r
  53             ListReorder\r
  54             ListSlider\r
  55             VolumeKeyPressed\r
  56             </summary>\r
  57             <privilege>\r
  58             For controlling the haptic device:\r
  59             http://tizen.org/privilege/haptic\r
  60             For controlling the sound, privilege is not needed.\r
  61             </privilege>\r
  62             <code>\r
  63             Feedback feedback = new Feedback();\r
  64             bool res = feedback.IsSupportedPattern(FeedbackType.Vibration, "Tap");\r
  65             </code>\r
  66         </member>\r
  67         <member name="M:Tizen.System.Feedback.IsSupportedPattern(Tizen.System.FeedbackType,System.String)">\r
  68             <summary>\r
  69             Gets the supported information about a specific type and pattern.\r
  70             </summary>\r
  71             <remarks>\r
  72             Now, IsSupportedPattern is not working for FeedbackType.All.\r
  73             This API is working for FeedbackType.Sound and FeedbackType.Vibration only.\r
  74             If you use FeedbackType.All for type parameter, this API will throw ArgumentException.\r
  75             To get the supported information for Vibration type, the application should have http://tizen.org/privilege/haptic privilege.\r
  76             </remarks>\r
  77             <since_tizen> 3 </since_tizen>\r
  78             <param name="type">The feedback type.</param>\r
  79             <param name="pattern">The feedback pattern string.</param>\r
  80             <returns>Information whether a pattern is supported.</returns>\r
  81             <exception cref="T:System.Exception">Thrown when failed because the feedback is not initialized.</exception>\r
  82             <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid arguament.</exception>\r
  83             <exception cref="T:System.NotSupportedException">Thrown when failed becuase the device (haptic, sound) is not supported.</exception>\r
  84             <exception cref="T:System.UnauthorizedAccessException">Thrown when failed because the access is not granted (No privilege).</exception>\r
  85             <exception cref="T:System.InvalidOperationException">Thrown when failed because of a system error.</exception>\r
  86             <privilege>http://tizen.org/privilege/haptic</privilege>\r
  87             <example>\r
  88             <code>\r
  89             Feedback feedback = new Feedback();\r
  90             bool res = feedback.IsSupportedPattern(FeedbackType.Vibration, "Tap");\r
  91             </code>\r
  92             </example>\r
  93         </member>\r
  94         <member name="M:Tizen.System.Feedback.Play(Tizen.System.FeedbackType,System.String)">\r
  95             <summary>\r
  96             Plays a specific feedback pattern.\r
  97             </summary>\r
  98             <remarks>\r
  99             To play Vibration type, app should have http://tizen.org/privilege/haptic privilege.\r
 100             </remarks>\r
 101             <since_tizen> 3 </since_tizen>\r
 102             <param name="type">The feedback type.</param>\r
 103             <param name="pattern">The feedback pattern string.</param>\r
 104             <exception cref="T:System.Exception">Thrown when failed because feedback is not initialized.</exception>\r
 105             <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid arguament.</exception>\r
 106             <exception cref="T:System.NotSupportedException">Thrown when failed because the device (haptic, sound) or a specific pattern is not supported.</exception>\r
 107             <exception cref="T:System.UnauthorizedAccessException">Thrown when failed because the access is not granted(No privilege)</exception>\r
 108             <exception cref="T:System.InvalidOperationException">Thrown when failed because of a system error.</exception>\r
 109             <privilege>http://tizen.org/privilege/haptic</privilege>\r
 110             <example>\r
 111             <code>\r
 112             Feedback feedback = new Feedback();\r
 113             feedback.Play(FeedbackType.All, "Tap");\r
 114             </code>\r
 115             </example>\r
 116         </member>\r
 117         <member name="M:Tizen.System.Feedback.Stop">\r
 118             <summary>\r
 119             Stops to play the feedback.\r
 120             </summary>\r
 121             <remarks>\r
 122             To stop vibration, the application should have http://tizen.org/privilege/haptic privilege.\r
 123             </remarks>\r
 124             <since_tizen> 3 </since_tizen>\r
 125             <exception cref="T:System.Exception">Thrown when failed because the feedback is not initialized.</exception>\r
 126             <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid arguament</exception>\r
 127             <exception cref="T:System.NotSupportedException">Thrown when failed because the device (haptic, sound) or a specific pattern is not supported.</exception>\r
 128             <exception cref="T:System.UnauthorizedAccessException">Thrown when failed because the access is not granted (No privilege).</exception>\r
 129             <exception cref="T:System.InvalidOperationException">Thrown when failed because of a system error.</exception>\r
 130             <privilege>http://tizen.org/privilege/haptic</privilege>\r
 131             <example>\r
 132             <code>\r
 133             Feedback Feedback1 = new Feedback();\r
 134             Feedback1.Stop();\r
 135             </code>\r
 136             </example>\r
 137         </member>\r
 138         <member name="T:Tizen.System.FeedbackPattern">\r
 139             <summary>\r
 140             String and enumeration for feedback patterns.\r
 141             </summary>\r
 142         </member>\r
 143         <member name="T:Tizen.System.FeedbackType">\r
 144             <summary>\r
 145             Enumeration for feedback device types.\r
 146             </summary>\r
 147             <since_tizen> 3 </since_tizen>\r
 148         </member>\r
 149         <member name="F:Tizen.System.FeedbackType.All">\r
 150             <summary>\r
 151             Sound and vibration.\r
 152             </summary>\r
 153             <since_tizen> 3 </since_tizen>\r
 154         </member>\r
 155         <member name="F:Tizen.System.FeedbackType.Sound">\r
 156             <summary>\r
 157             Sound feedback.\r
 158             </summary>\r
 159             <since_tizen> 3 </since_tizen>\r
 160         </member>\r
 161         <member name="F:Tizen.System.FeedbackType.Vibration">\r
 162             <summary>\r
 163             Vibration feedback.\r
 164             /// </summary>\r
 165             <since_tizen> 3 </since_tizen>\r
 166         </member>\r
 167     </members>\r
 168 </doc>\r