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

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