/// <summary>
/// Enumeration for the Battery level.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public enum BatteryLevelStatus
{
/// <summary>
/// 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.
/// 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
}
/// <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
/// <summary>
/// Gets the current Battery level.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static BatteryLevelStatus Level
{
get
/// <summary>
/// Gets the current charging state.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static bool IsCharging
{
get
/// <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>
/// <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>
/// 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>
/// 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; }
}
/// <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; }
}
/// <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; }
}
/// <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; }
}
/// <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; }
}
}
/// 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
}
/// <summary>
/// The number of available display devices.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static int NumberOfDisplays
{
get
/// 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
/// <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);
/// <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>
/// <summary>
/// The current device display state.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static DisplayState State
{
get
/// <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>
/// <summary>
/// Get the number of avaialble vibrators.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static int NumberOfVibrators
{
get
/// <summary>
/// Get all the avaialble vibrators.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static IReadOnlyList<Vibrator> Vibrators
{
get
/// 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>
/// 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>
/// 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);
/// <summary>
/// Gets the information whether IR module is available.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
public static bool IsAvailable
{
get
/// <summary>
/// Transmits IR command.
/// </summary>
+ /// <since_tizen> 3 </since_tizen>
/// <param name="carrierFreequency">
/// Carrier frequency to transmit IR command (Hertz).
/// </param>
{
/// <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>
/// <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>
/// <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">
/// <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>
/// <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
/// <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.
/// <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>