-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>Tizen.System.Feedback</name>
- </assembly>
- <members>
- <member name="T:Tizen.System.Constants">
- <summary>
- The class for constants.
- </summary>
- </member>
- <member name="T:Tizen.System.Feedback">
- <summary>
- The Feedback API provides functions to control haptic and sound.
- The Feedback API provides the way to play and stop feedback, and get the information whether a specific pattern is supported.
- Below is the supported pattern string:
- Tap
- SoftInputPanel
- Key0
- Key1
- Key2
- Key3
- Key4
- Key5
- Key6
- Key7
- Key8
- Key9
- KeyStar
- KeySharp
- KeyBack
- Hold
- HardwareKeyPressed
- HardwareKeyHold
- Message
- Email
- WakeUp
- Schedule
- Timer
- General
- PowerOn
- PowerOff
- ChargerConnected
- ChargingError
- FullyCharged
- LowBattery
- Lock
- UnLock
- VibrationModeAbled
- SilentModeDisabled
- BluetoothDeviceConnected
- BluetoothDeviceDisconnected
- ListReorder
- ListSlider
- VolumeKeyPressed
- </summary>
- <privilege>
- For controlling the haptic device:
- http://tizen.org/privilege/haptic
- For controlling the sound, privilege is not needed.
- </privilege>
- <code>
- Feedback feedback = new Feedback();
- bool res = feedback.IsSupportedPattern(FeedbackType.Vibration, "Tap");
- </code>
- </member>
- <member name="M:Tizen.System.Feedback.IsSupportedPattern(Tizen.System.FeedbackType,System.String)">
- <summary>
- Gets the supported information about a specific type and pattern.
- </summary>
- <remarks>
- Now, IsSupportedPattern is not working for FeedbackType.All.
- This API is working for FeedbackType.Sound and FeedbackType.Vibration only.
- If you use FeedbackType.All for type parameter, this API will throw ArgumentException.
- To get the supported information for Vibration type, the application should have http://tizen.org/privilege/haptic privilege.
- </remarks>
- <since_tizen> 3 </since_tizen>
- <param name="type">The feedback type.</param>
- <param name="pattern">The feedback pattern string.</param>
- <returns>Information whether a pattern is supported.</returns>
- <exception cref="T:System.Exception">Thrown when failed because the feedback is not initialized.</exception>
- <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid arguament.</exception>
- <exception cref="T:System.NotSupportedException">Thrown when failed becuase the device (haptic, sound) is not supported.</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when failed because the access is not granted (No privilege).</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when failed because of a system error.</exception>
- <privilege>http://tizen.org/privilege/haptic</privilege>
- <example>
- <code>
- Feedback feedback = new Feedback();
- bool res = feedback.IsSupportedPattern(FeedbackType.Vibration, "Tap");
- </code>
- </example>
- </member>
- <member name="M:Tizen.System.Feedback.Play(Tizen.System.FeedbackType,System.String)">
- <summary>
- Plays a specific feedback pattern.
- </summary>
- <remarks>
- To play Vibration type, app should have http://tizen.org/privilege/haptic privilege.
- </remarks>
- <since_tizen> 3 </since_tizen>
- <param name="type">The feedback type.</param>
- <param name="pattern">The feedback pattern string.</param>
- <exception cref="T:System.Exception">Thrown when failed because feedback is not initialized.</exception>
- <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid arguament.</exception>
- <exception cref="T:System.NotSupportedException">Thrown when failed because the device (haptic, sound) or a specific pattern is not supported.</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when failed because the access is not granted(No privilege)</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when failed because of a system error.</exception>
- <privilege>http://tizen.org/privilege/haptic</privilege>
- <example>
- <code>
- Feedback feedback = new Feedback();
- feedback.Play(FeedbackType.All, "Tap");
- </code>
- </example>
- </member>
- <member name="M:Tizen.System.Feedback.Stop">
- <summary>
- Stops to play the feedback.
- </summary>
- <remarks>
- To stop vibration, the application should have http://tizen.org/privilege/haptic privilege.
- </remarks>
- <since_tizen> 3 </since_tizen>
- <exception cref="T:System.Exception">Thrown when failed because the feedback is not initialized.</exception>
- <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid arguament</exception>
- <exception cref="T:System.NotSupportedException">Thrown when failed because the device (haptic, sound) or a specific pattern is not supported.</exception>
- <exception cref="T:System.UnauthorizedAccessException">Thrown when failed because the access is not granted (No privilege).</exception>
- <exception cref="T:System.InvalidOperationException">Thrown when failed because of a system error.</exception>
- <privilege>http://tizen.org/privilege/haptic</privilege>
- <example>
- <code>
- Feedback Feedback1 = new Feedback();
- Feedback1.Stop();
- </code>
- </example>
- </member>
- <member name="T:Tizen.System.FeedbackPattern">
- <summary>
- String and enumeration for feedback patterns.
- </summary>
- </member>
- <member name="T:Tizen.System.FeedbackType">
- <summary>
- Enumeration for feedback device types.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.System.FeedbackType.All">
- <summary>
- Sound and vibration.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.System.FeedbackType.Sound">
- <summary>
- Sound feedback.
- </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- <member name="F:Tizen.System.FeedbackType.Vibration">
- <summary>
- Vibration feedback.
- /// </summary>
- <since_tizen> 3 </since_tizen>
- </member>
- </members>
-</doc>
+<?xml version="1.0"?>\r
+<doc>\r
+ <assembly>\r
+ <name>Tizen.System.Feedback</name>\r
+ </assembly>\r
+ <members>\r
+ <member name="T:Tizen.System.Constants">\r
+ <summary>\r
+ The class for constants.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.System.Feedback">\r
+ <summary>\r
+ The Feedback API provides functions to control haptic and sound.\r
+ The Feedback API provides the way to play and stop feedback, and get the information whether a specific pattern is supported.\r
+ Below is the supported pattern string:\r
+ Tap\r
+ SoftInputPanel\r
+ Key0\r
+ Key1\r
+ Key2\r
+ Key3\r
+ Key4\r
+ Key5\r
+ Key6\r
+ Key7\r
+ Key8\r
+ Key9\r
+ KeyStar\r
+ KeySharp\r
+ KeyBack\r
+ Hold\r
+ HardwareKeyPressed\r
+ HardwareKeyHold\r
+ Message\r
+ Email\r
+ WakeUp\r
+ Schedule\r
+ Timer\r
+ General\r
+ PowerOn\r
+ PowerOff\r
+ ChargerConnected\r
+ ChargingError\r
+ FullyCharged\r
+ LowBattery\r
+ Lock\r
+ UnLock\r
+ VibrationModeAbled\r
+ SilentModeDisabled\r
+ BluetoothDeviceConnected\r
+ BluetoothDeviceDisconnected\r
+ ListReorder\r
+ ListSlider\r
+ VolumeKeyPressed\r
+ </summary>\r
+ <privilege>\r
+ For controlling the haptic device:\r
+ http://tizen.org/privilege/haptic\r
+ For controlling the sound, privilege is not needed.\r
+ </privilege>\r
+ <code>\r
+ Feedback feedback = new Feedback();\r
+ bool res = feedback.IsSupportedPattern(FeedbackType.Vibration, "Tap");\r
+ </code>\r
+ </member>\r
+ <member name="M:Tizen.System.Feedback.IsSupportedPattern(Tizen.System.FeedbackType,System.String)">\r
+ <summary>\r
+ Gets the supported information about a specific type and pattern.\r
+ </summary>\r
+ <remarks>\r
+ Now, IsSupportedPattern is not working for FeedbackType.All.\r
+ This API is working for FeedbackType.Sound and FeedbackType.Vibration only.\r
+ If you use FeedbackType.All for type parameter, this API will throw ArgumentException.\r
+ To get the supported information for Vibration type, the application should have http://tizen.org/privilege/haptic privilege.\r
+ </remarks>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="type">The feedback type.</param>\r
+ <param name="pattern">The feedback pattern string.</param>\r
+ <returns>Information whether a pattern is supported.</returns>\r
+ <exception cref="T:System.Exception">Thrown when failed because the feedback is not initialized.</exception>\r
+ <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid arguament.</exception>\r
+ <exception cref="T:System.NotSupportedException">Thrown when failed becuase the device (haptic, sound) is not supported.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when failed because the access is not granted (No privilege).</exception>\r
+ <exception cref="T:System.InvalidOperationException">Thrown when failed because of a system error.</exception>\r
+ <privilege>http://tizen.org/privilege/haptic</privilege>\r
+ <example>\r
+ <code>\r
+ Feedback feedback = new Feedback();\r
+ bool res = feedback.IsSupportedPattern(FeedbackType.Vibration, "Tap");\r
+ </code>\r
+ </example>\r
+ </member>\r
+ <member name="M:Tizen.System.Feedback.Play(Tizen.System.FeedbackType,System.String)">\r
+ <summary>\r
+ Plays a specific feedback pattern.\r
+ </summary>\r
+ <remarks>\r
+ To play Vibration type, app should have http://tizen.org/privilege/haptic privilege.\r
+ </remarks>\r
+ <since_tizen> 3 </since_tizen>\r
+ <param name="type">The feedback type.</param>\r
+ <param name="pattern">The feedback pattern string.</param>\r
+ <exception cref="T:System.Exception">Thrown when failed because feedback is not initialized.</exception>\r
+ <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid arguament.</exception>\r
+ <exception cref="T:System.NotSupportedException">Thrown when failed because the device (haptic, sound) or a specific pattern is not supported.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when failed because the access is not granted(No privilege)</exception>\r
+ <exception cref="T:System.InvalidOperationException">Thrown when failed because of a system error.</exception>\r
+ <privilege>http://tizen.org/privilege/haptic</privilege>\r
+ <example>\r
+ <code>\r
+ Feedback feedback = new Feedback();\r
+ feedback.Play(FeedbackType.All, "Tap");\r
+ </code>\r
+ </example>\r
+ </member>\r
+ <member name="M:Tizen.System.Feedback.Stop">\r
+ <summary>\r
+ Stops to play the feedback.\r
+ </summary>\r
+ <remarks>\r
+ To stop vibration, the application should have http://tizen.org/privilege/haptic privilege.\r
+ </remarks>\r
+ <since_tizen> 3 </since_tizen>\r
+ <exception cref="T:System.Exception">Thrown when failed because the feedback is not initialized.</exception>\r
+ <exception cref="T:System.ArgumentException">Thrown when failed because of an invalid arguament</exception>\r
+ <exception cref="T:System.NotSupportedException">Thrown when failed because the device (haptic, sound) or a specific pattern is not supported.</exception>\r
+ <exception cref="T:System.UnauthorizedAccessException">Thrown when failed because the access is not granted (No privilege).</exception>\r
+ <exception cref="T:System.InvalidOperationException">Thrown when failed because of a system error.</exception>\r
+ <privilege>http://tizen.org/privilege/haptic</privilege>\r
+ <example>\r
+ <code>\r
+ Feedback Feedback1 = new Feedback();\r
+ Feedback1.Stop();\r
+ </code>\r
+ </example>\r
+ </member>\r
+ <member name="T:Tizen.System.FeedbackPattern">\r
+ <summary>\r
+ String and enumeration for feedback patterns.\r
+ </summary>\r
+ </member>\r
+ <member name="T:Tizen.System.FeedbackType">\r
+ <summary>\r
+ Enumeration for feedback device types.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.System.FeedbackType.All">\r
+ <summary>\r
+ Sound and vibration.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.System.FeedbackType.Sound">\r
+ <summary>\r
+ Sound feedback.\r
+ </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ <member name="F:Tizen.System.FeedbackType.Vibration">\r
+ <summary>\r
+ Vibration feedback.\r
+ /// </summary>\r
+ <since_tizen> 3 </since_tizen>\r
+ </member>\r
+ </members>\r
+</doc>\r
projects / platform / core / csapi / tizenfx.git / blobdiff