Add API Level 57/136857/1 accepted/tizen_4.0_unified accepted/tizen_unified tizen_4.0 accepted/tizen/4.0/unified/20170816.020147 accepted/tizen/4.0/unified/20170828.223532 accepted/tizen/unified/20170706.193344 submit/tizen/20170705.070929 submit/tizen_4.0/20170811.094300 submit/tizen_4.0/20170814.115522 submit/tizen_4.0/20170828.100003 submit/tizen_4.0_unified/20170814.115522
authorpr.jung <pr.jung@samsung.com>
Mon, 3 Jul 2017 07:57:45 +0000 (16:57 +0900)
committerpr.jung <pr.jung@samsung.com>
Mon, 3 Jul 2017 07:58:29 +0000 (16:58 +0900)
Change-Id: Ia685aa39e4e92baed33d0ae9b4030439255b3bd9
Signed-off-by: pr.jung <pr.jung@samsung.com>
Tizen.System/Device/Battery.cs
Tizen.System/Device/DeviceEventArgs.cs
Tizen.System/Device/Display.cs
Tizen.System/Device/Haptic.cs
Tizen.System/Device/IR.cs
Tizen.System/Device/Led.cs
Tizen.System/Device/Power.cs

index ebfb592..e622284 100755 (executable)
@@ -21,6 +21,7 @@ namespace Tizen.System
     /// <summary>
     /// Enumeration for the Battery level.
     /// </summary>
+    /// <since_tizen> 3 </since_tizen>
     public enum BatteryLevelStatus
     {
         /// <summary>
@@ -29,6 +30,7 @@ namespace Tizen.System
         /// because the device starts a shutdown process soon
         /// after entering this level.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         Empty = 0,
         /// <summary>
         /// The battery charge is at a critical state.
@@ -36,18 +38,22 @@ namespace Tizen.System
         /// because they are not guaranteed to work correctly
         /// at this battery status.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         Critical,
         /// <summary>
         /// The battery has little charge left.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         Low,
         /// <summary>
         /// The battery status is not to be careful.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         High,
         /// <summary>
         /// The battery status is full.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         Full
     }
 
@@ -70,6 +76,7 @@ namespace Tizen.System
         /// <summary>
         /// Gets the battery charge percentage.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <value>It returns an integer value from 0 to 100 that indicates remaining
         /// battery charge as a percentage of the maximum level.</value>
         public static int Percent
@@ -88,6 +95,7 @@ namespace Tizen.System
         /// <summary>
         /// Gets the current Battery level.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public static BatteryLevelStatus Level
         {
             get
@@ -104,6 +112,7 @@ namespace Tizen.System
         /// <summary>
         /// Gets the current charging state.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public static bool IsCharging
         {
             get
@@ -122,6 +131,7 @@ namespace Tizen.System
         /// <summary>
         /// CapacityChanged is triggered when the battery charge percentage is changed
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="sender"></param>
         /// <param name="e">A BatteryCapacityChangedEventArgs object that contains changed battery capacity (Percent)</param>
         /// <code>
@@ -167,6 +177,7 @@ namespace Tizen.System
         /// <summary>
         /// LevelChanged is triggered when the battery level is changed
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="sender"></param>
         /// <param name="e">A BatteryLevelChangedEventArgs object that contains changed battery level </param>
         /// <code>
@@ -212,6 +223,7 @@ namespace Tizen.System
         /// ChargingStatusChanged is triggered when the Battery charging status is changed.
         /// This event is triggered when Charger is connected/Disconnected.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="sender"></param>
         /// <param name="e">A BatteryChargingStateChangedEventArgs object that contains changed battery charging state</param>
         /// <code>
index 4b49039..829e8de 100644 (file)
@@ -28,6 +28,7 @@ namespace Tizen.System
         /// The current capacity of the battery.
         /// Capacity is an integer value from 0 to 100, that indicates remaining battery charge as a percentage of the maximum level.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public int Percent { get; internal set; }
     }
 
@@ -40,6 +41,7 @@ namespace Tizen.System
         /// <summary>
         /// Level indicates the Current battery level status which is of type BatteryLevelStatus.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public BatteryLevelStatus Level { get; internal set; }
     }
 
@@ -52,6 +54,7 @@ namespace Tizen.System
         /// <summary>
         /// The charging state of the battery. Charging is of type boolean which indicates true/false based on currrent charging status.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public bool IsCharging { get; internal set; }
     }
 
@@ -64,6 +67,7 @@ namespace Tizen.System
         /// <summary>
         /// State indicates the current display state of the device which is an enum of type DisplayState.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public DisplayState State { get; internal set; }
     }
 
@@ -76,6 +80,7 @@ namespace Tizen.System
         /// <summary>
         /// Brightness indicates the current brightness level of the display as an integer.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public int Brightness { get; internal set; }
     }
 }
index 654d8be..4588001 100644 (file)
@@ -22,19 +22,23 @@ namespace Tizen.System
     /// Enumeration for the available Display states.
     /// An application cannot put the device into the power off state or the suspend state.
     /// </summary>
+    /// <since_tizen> 3 </since_tizen>
     public enum DisplayState
     {
         /// <summary>
         /// Normal state
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         Normal = 0,
         /// <summary>
         /// Screen dim state
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         Dim,
         /// <summary>
         /// Screen off state
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         Off
     }
 
@@ -67,6 +71,7 @@ namespace Tizen.System
         /// <summary>
         /// The number of available display devices.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public static int NumberOfDisplays
         {
             get
@@ -84,6 +89,7 @@ namespace Tizen.System
         /// Get all the avaialble Displays.
         /// The Display at index zero is always assigned to the main display.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public static IReadOnlyList<Display> Displays
         {
             get
@@ -108,6 +114,7 @@ namespace Tizen.System
         /// <summary>
         /// The maximum brightness value that can be set for the specific Display.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <code>
         ///     Display display = Display.Displays[0];
         ///     Console.WriteLine("Display MaxBrightness is: {0}", display.MaxBrightness);
@@ -132,6 +139,7 @@ namespace Tizen.System
         /// <remarks>
         /// Brightness value should be less than are equal to MaxBrightness value.
         /// </remarks>
+        /// <since_tizen> 3 </since_tizen>
         /// <exception cref="ArgumentException"> When the invalid parameter value is set.</exception>
         /// <exception cref = "UnauthorizedAccessException"> If the privilege is not set.</exception>
         /// <code>
@@ -163,6 +171,7 @@ namespace Tizen.System
         /// <summary>
         /// The current device display state.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public static DisplayState State
         {
             get
@@ -181,6 +190,7 @@ namespace Tizen.System
         /// <summary>
         /// StateChanged is raised when the state of the display is changed
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="sender"></param>
         /// <param name="e">An DisplayStateChangedEventArgs object that contains the changed state</param>
         /// <code>
index 74dd266..b451f33 100644 (file)
@@ -62,6 +62,7 @@ namespace Tizen.System
         /// <summary>
         /// Get the number of avaialble vibrators.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public static int NumberOfVibrators
         {
             get
@@ -78,6 +79,7 @@ namespace Tizen.System
         /// <summary>
         /// Get all the avaialble vibrators.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public static IReadOnlyList<Vibrator> Vibrators
         {
             get
@@ -106,6 +108,7 @@ namespace Tizen.System
         /// Vibrates during the specified time with a constant intensity.
         /// This function can be used to start monotonous vibration for the specified time.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="duration">The play duration in milliseconds </param>
         /// <param name="feedback">The amount of the intensity variation (0 ~ 100) </param>
         /// <exception cref="ArgumentException"> When the invalid parameter value is set.</exception>
@@ -146,6 +149,7 @@ namespace Tizen.System
         /// Stops all vibration effects which are being played.
         /// This function can be used to stop all effects started by Vibrate().
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <exception cref="ArgumentException"> In case of invalid vibrator instance is used.</exception>
         /// <exception cref = "UnauthorizedAccessException"> If the privilege is not set.</exception>
         /// <exception cref = "InvalidOperationException"> In case of any system error.</exception>
@@ -175,6 +179,7 @@ namespace Tizen.System
         /// Dispose API for closing the internal resources.
         /// This function can be used to stop all effects started by Vibrate().
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public void Dispose()
         {
             Dispose(true);
index b3848fb..c2631bf 100644 (file)
@@ -35,6 +35,7 @@ namespace Tizen.System
         /// <summary>
         /// Gets the information whether IR module is available.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         public static bool IsAvailable
         {
             get
@@ -52,6 +53,7 @@ namespace Tizen.System
         /// <summary>
         /// Transmits IR command.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="carrierFreequency">
         /// Carrier frequency to transmit IR command (Hertz).
         /// </param>
index e67db45..fbf2fa1 100644 (file)
@@ -42,6 +42,7 @@ namespace Tizen.System
     {
         /// <summary>
         /// Gets the max brightness value of a LED that is located next to the camera.
+        /// <since_tizen> 3 </since_tizen>
         /// <exception cref="ArgumentException"> When the invalid parameter value is set.</exception>
         /// <exception cref = "UnauthorizedAccessException"> If the privilege is not set.</exception>
         /// <exception cref = "NotSupportedException"> In case of device does not support this behavior.</exception>
@@ -68,6 +69,7 @@ namespace Tizen.System
         /// <remarks>The brightness value range of LED is 0 to Tizen.System.Led.MaxBrightness value.
         /// Changing the brightness value will invoke the registered EventHandler for led BrightnessChanged (If any).
         /// </remarks>
+        /// <since_tizen> 3 </since_tizen>
         /// <exception cref="ArgumentException"> When the invalid parameter value is set.</exception>
         /// <exception cref = "UnauthorizedAccessException"> If the privilege is not set.</exception>
         /// <exception cref = "NotSupportedException"> In case of device does not support this behavior.</exception>
@@ -102,6 +104,7 @@ namespace Tizen.System
         /// <summary>
         /// Plays the LED that is located to the front of a device.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="on">Turn on time in milliseconds </param>
         /// <param name="off">Turn off time in milliseconds </param>
         /// <param name="color">
@@ -134,6 +137,7 @@ namespace Tizen.System
         /// <summary>
         /// Stops the LED that is located to the front of a device.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <exception cref = "UnauthorizedAccessException"> If the privilege is not set.</exception>
         /// <exception cref = "InvalidOperationException"> In case of any system error.</exception>
         /// <exception cref = "NotSupportedException"> In case of device does not support this behavior.</exception>
@@ -163,6 +167,7 @@ namespace Tizen.System
         /// <summary>
         /// StateChanged is raised when the LED state is changed
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="sender">The source of the event.</param>
         /// <param name="e">An LedBrightnessChangedEventArgs object that contains the changed brightness.</param>
         public static event EventHandler<LedBrightnessChangedEventArgs> BrightnessChanged
index 1d4ca9b..50c7dcc 100644 (file)
@@ -37,6 +37,7 @@ namespace Tizen.System
         /// <remarks>
         /// If the process dies, then every lock will be removed.
         /// </remarks>
+        /// <since_tizen> 3 </since_tizen>
         /// <param name="timeout">
         /// The positive number in milliseconds or 0 for permanent lock
         /// So you must release the permanent lock of power state with ReleaseCpuLock() if timeout_ms is zero.
@@ -59,6 +60,7 @@ namespace Tizen.System
         /// <summary>
         /// Releases the CPU lock state.
         /// </summary>
+        /// <since_tizen> 3 </since_tizen>
         /// <exception cref = "UnauthorizedAccessException"> If the privilege is not set.</exception>
         /// <exception cref = "InvalidOperationException"> In case of any system error.</exception>
         /// <code>