binaries/frameworks/Tizen.System.xml

   1 <?xml version="1.0"?>
   2 <doc>
   3     <assembly>
   4         <name>Tizen.System</name>
   5     </assembly>
   6     <members>
   7         <member name="T:Tizen.System.BatteryLevelStatus">
   8             <summary>
   9             Enumeration for the battery levels.
  10             </summary>
  11             <since_tizen> 3 </since_tizen>
  12         </member>
  13         <member name="F:Tizen.System.BatteryLevelStatus.Empty">
  14             <summary>
  15             The battery goes empty.
  16             Prepare for the safe termination of the application,
  17             because the device starts a shutdown process soon
  18             after entering this level.
  19             </summary>
  20             <since_tizen> 3 </since_tizen>
  21         </member>
  22         <member name="F:Tizen.System.BatteryLevelStatus.Critical">
  23             <summary>
  24             The battery charge is at a critical state.
  25             You may have to stop using the multimedia features,
  26             because they are not guaranteed to work correctly
  27             with this battery status.
  28             </summary>
  29             <since_tizen> 3 </since_tizen>
  30         </member>
  31         <member name="F:Tizen.System.BatteryLevelStatus.Low">
  32             <summary>
  33             The battery has little charge left.
  34             </summary>
  35             <since_tizen> 3 </since_tizen>
  36         </member>
  37         <member name="F:Tizen.System.BatteryLevelStatus.High">
  38             <summary>
  39             The battery status is not to be careful.
  40             </summary>
  41             <since_tizen> 3 </since_tizen>
  42         </member>
  43         <member name="F:Tizen.System.BatteryLevelStatus.Full">
  44             <summary>
  45             The battery status is full.
  46             </summary>
  47             <since_tizen> 3 </since_tizen>
  48         </member>
  49         <member name="T:Tizen.System.Battery">
  50             <summary>
  51             The Battery class provides the properties and events for the device battery.
  52             </summary>
  53             <remarks>
  54             The Battery API provides the way to get the current battery capacity value (Percent),
  55             the battery state, and the charging state. It also provides the events for an application
  56             to receive the battery status change events from the device.
  57             To receive the battery event, the application should register with the respective EventHandler.
  58             </remarks>
  59             <code>
  60                 Console.WriteLine("battery Charging state is: {0}", Tizen.System.Battery.IsCharging);
  61                 Console.WriteLine("battery Percent is: {0}", Tizen.System.Battery.Percent);
  62             </code>
  63         </member>
  64         <member name="P:Tizen.System.Battery.Percent">
  65             <summary>
  66             Gets the battery charge percentage.
  67             </summary>
  68             <since_tizen> 3 </since_tizen>
  69             <value>It returns an integer value from 0 to 100 that indicates the remaining
  70             battery charge as a percentage of the maximum level.</value>
  71         </member>
  72         <member name="P:Tizen.System.Battery.Level">
  73             <summary>
  74             Gets the current battery level.
  75             </summary>
  76             <since_tizen> 3 </since_tizen>
  77         </member>
  78         <member name="P:Tizen.System.Battery.IsCharging">
  79             <summary>
  80             Gets the current charging state.
  81             </summary>
  82             <since_tizen> 3 </since_tizen>
  83         </member>
  84         <!-- Badly formed XML comment ignored for member "E:Tizen.System.Battery.PercentChanged" -->
  85         <!-- Badly formed XML comment ignored for member "E:Tizen.System.Battery.LevelChanged" -->
  86         <!-- Badly formed XML comment ignored for member "E:Tizen.System.Battery.ChargingStateChanged" -->
  87         <member name="T:Tizen.System.BatteryPercentChangedEventArgs">
  88             <summary>
  89             BatteryPercentChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryPercentChanged event from the battery class.
  90             </summary>
  91         </member>
  92         <member name="P:Tizen.System.BatteryPercentChangedEventArgs.Percent">
  93             <summary>
  94             The current capacity of the battery.
  95             Capacity is an integer value from 0 to 100 that indicates the remaining battery charge as a percentage of the maximum level.
  96             </summary>
  97             <since_tizen> 3 </since_tizen>
  98         </member>
  99         <member name="T:Tizen.System.BatteryLevelChangedEventArgs">
 100             <summary>
 101             BatteryLevelChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryLevelChanged event from the battery class.
 102             </summary>
 103         </member>
 104         <member name="P:Tizen.System.BatteryLevelChangedEventArgs.Level">
 105             <summary>
 106              The level indicates the current battery level status which is a type of the BatteryLevelStatus.
 107             </summary>
 108             <since_tizen> 3 </since_tizen>
 109         </member>
 110         <member name="T:Tizen.System.BatteryChargingStateChangedEventArgs">
 111             <summary>
 112             BatteryChargingStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the BatteryChargingStateChanged event from the battery class.
 113             </summary>
 114         </member>
 115         <member name="P:Tizen.System.BatteryChargingStateChangedEventArgs.IsCharging">
 116             <summary>
 117             The charging state of the battery. Charging is a type of a boolean which indicates true/false based on the current charging status.
 118             </summary>
 119             <since_tizen> 3 </since_tizen>
 120         </member>
 121         <member name="T:Tizen.System.DisplayStateChangedEventArgs">
 122             <summary>
 123             DisplayStateChangedEventArgs is an extended EventArgs class. This class contains event arguments for the DisplayStateChanged event from the display class.
 124             </summary>
 125         </member>
 126         <member name="P:Tizen.System.DisplayStateChangedEventArgs.State">
 127             <summary>
 128             The state indicates the current display state of the device which is an enumeration of the type DisplayState.
 129             </summary>
 130             <since_tizen> 3 </since_tizen>
 131         </member>
 132         <member name="T:Tizen.System.LedBrightnessChangedEventArgs">
 133             <summary>
 134             LedBrightnessChangedEventArgs is an extended EventArgs class. This class contains event arguments for the LedBrightnessChanged event from the LED class.
 135             </summary>
 136         </member>
 137         <member name="P:Tizen.System.LedBrightnessChangedEventArgs.Brightness">
 138             <summary>
 139             Brightness indicates the current brightness level of the display as an integer.
 140             </summary>
 141             <since_tizen> 3 </since_tizen>
 142         </member>
 143         <member name="T:Tizen.System.DisplayState">
 144             <summary>
 145             Enumeration for the available display states.
 146             An application cannot put the device into the power off state or the suspend state.
 147             </summary>
 148             <since_tizen> 3 </since_tizen>
 149         </member>
 150         <member name="F:Tizen.System.DisplayState.Normal">
 151             <summary>
 152             Normal state.
 153             </summary>
 154             <since_tizen> 3 </since_tizen>
 155         </member>
 156         <member name="F:Tizen.System.DisplayState.Dim">
 157             <summary>
 158             Screen dim state.
 159             </summary>
 160             <since_tizen> 3 </since_tizen>
 161         </member>
 162         <member name="F:Tizen.System.DisplayState.Off">
 163             <summary>
 164             Screen off state.
 165             </summary>
 166             <since_tizen> 3 </since_tizen>
 167         </member>
 168         <member name="T:Tizen.System.Display">
 169             <summary>
 170             The Display class provides the properties and events to control the display status and brightness.
 171             </summary>
 172             <remarks>
 173             The Display API provides the way to get the current display brightness value,
 174             the display state, and the total number of available displays.
 175             It also provides the events for an application to receive the display state change events from the device.
 176             To receive the display event, the application should register with an associated EventHandler.
 177             </remarks>
 178             <privilege>
 179             http://tizen.org/privilege/display
 180             </privilege>
 181             <code>
 182                 Console.WriteLine("Display current state is: {0}", Tizen.System.Display.State);
 183                 Console.WriteLine("Total number of Displays are: {0}", Tizen.System.Display.NumberOfDisplays);
 184             </code>
 185         </member>
 186         <member name="P:Tizen.System.Display.NumberOfDisplays">
 187             <summary>
 188             The number of available display devices.
 189             </summary>
 190             <since_tizen> 3 </since_tizen>
 191         </member>
 192         <member name="P:Tizen.System.Display.Displays">
 193             <summary>
 194             Gets all the available displays.
 195             The display at the index zero is always assigned to the main display.
 196             </summary>
 197             <since_tizen> 3 </since_tizen>
 198         </member>
 199         <member name="P:Tizen.System.Display.MaxBrightness">
 200             <summary>
 201             The maximum brightness value that can be set for the specific display.
 202             </summary>
 203             <since_tizen> 3 </since_tizen>
 204             <code>
 205                 Display display = Display.Displays[0];
 206                 Console.WriteLine("Display MaxBrightness is: {0}", display.MaxBrightness);
 207             </code>
 208         </member>
 209         <member name="P:Tizen.System.Display.Brightness">
 210             <summary>
 211             The brightness value of the display.
 212             </summary>
 213             <remarks>
 214             The brightness value should be less than or equal to the MaxBrightness value.
 215             </remarks>
 216             <since_tizen> 3 </since_tizen>
 217             <exception cref="T:System.ArgumentException">When an invalid parameter value is set.</exception>
 218             <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
 219             <code>
 220                 Display display = Display.Displays[0];
 221                 Console.WriteLine("Display current Brightness is: {0}", display.Brightness);
 222             </code>
 223         </member>
 224         <member name="P:Tizen.System.Display.State">
 225             <summary>
 226             The current device display state.
 227             </summary>
 228             <since_tizen> 3 </since_tizen>
 229         </member>
 230         <!-- Badly formed XML comment ignored for member "E:Tizen.System.Display.StateChanged" -->
 231         <member name="T:Tizen.System.Vibrator">
 232             <summary>
 233             The Vibrator class provides the properties and methods to control a vibrator.
 234             </summary>
 235             <remarks>
 236             The Vibrator API provides the way to access the vibrators in the device.
 237             It allows the management of the device's vibrator parameters, such as the vibration count and level.
 238             It provides the methods to vibrate and stop the vibration.
 239             </remarks>
 240             <privilege>
 241             http://tizen.org/privilege/haptic
 242             </privilege>
 243             <code>
 244                 Console.WriteLine("Total number of Vibrators are: {0}", Tizen.System.Vibrator.NumberOfVibrators);
 245             </code>
 246         </member>
 247         <member name="P:Tizen.System.Vibrator.NumberOfVibrators">
 248             <summary>
 249             Gets the number of the available vibrators.
 250             </summary>
 251             <since_tizen> 3 </since_tizen>
 252         </member>
 253         <member name="P:Tizen.System.Vibrator.Vibrators">
 254             <summary>
 255             Gets all the available vibrators.
 256             </summary>
 257             <since_tizen> 3 </since_tizen>
 258         </member>
 259         <member name="M:Tizen.System.Vibrator.Vibrate(System.Int32,System.Int32)">
 260             <summary>
 261             Vibrates during the specified time with a constant intensity.
 262             This function can be used to start monotonous vibration for the specified time.
 263             </summary>
 264             <since_tizen> 3 </since_tizen>
 265             <param name="duration">The play duration in milliseconds.</param>
 266             <param name="feedback">The amount of the intensity variation (0 ~ 100).</param>
 267             <exception cref="T:System.ArgumentException"> When an invalid parameter value is set.</exception>
 268             <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
 269             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
 270             <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>
 271             <code>
 272                 Vibrator vibrator = Vibrator.Vibrators[0];
 273                 try
 274                 {
 275                     vibrator.Vibrate(2000, 70);
 276                 }
 277                 Catch(Exception e)
 278                 {
 279                 }
 280             </code>
 281         </member>
 282         <member name="M:Tizen.System.Vibrator.Stop">
 283             <summary>
 284             Stops all the vibration effects which are being played.
 285             This function can be used to stop all the effects started by Vibrate().
 286             </summary>
 287             <since_tizen> 3 </since_tizen>
 288             <exception cref="T:System.ArgumentException"> In case an invalid vibrator instance is used.</exception>
 289             <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
 290             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
 291             <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>
 292             <code>
 293                 Vibrator vibrator = Vibrator.Vibrators[0];
 294                 try
 295                 {
 296                     vibrator.Stop();
 297                 }
 298                 Catch(Exception e)
 299                 {
 300                 }
 301             </code>
 302         </member>
 303         <member name="M:Tizen.System.Vibrator.Dispose">
 304             <summary>
 305             Dispose API for closing the internal resources.
 306             This function can be used to stop all the effects started by Vibrate().
 307             </summary>
 308             <since_tizen> 3 </since_tizen>
 309         </member>
 310         <member name="T:Tizen.System.IR">
 311             <summary>
 312             The IR API provides the functions to control the IR transmitter.
 313             The IR API provides the way to get the information if IR is available and then transmit the IR command.
 314             </summary>
 315             <privilege>
 316             http://tizen.org/privilege/use_ir
 317             </privilege>
 318             <code>
 319                 Console.WriteLine("IR availability for this device is: {0}", IR.IsAvailable);
 320             </code>
 321         </member>
 322         <member name="P:Tizen.System.IR.IsAvailable">
 323             <summary>
 324             Gets the information whether the IR module is available.
 325             </summary>
 326             <since_tizen> 3 </since_tizen>
 327         </member>
 328         <!-- Badly formed XML comment ignored for member "M:Tizen.System.IR.Transmit(System.Int32,System.Collections.Generic.IList{System.Int32})" -->
 329         <member name="T:Tizen.System.Led">
 330             <summary>
 331             The LED class provides the properties and methods to control the attached LED device.
 332             </summary>
 333             <remarks>
 334             The LED API provides the way to control the attached LED device, such as the camera flash and service LED. It supports to turn on the camera flash and set the pattern to the service LED which is located at the front of the device.
 335             Related features:
 336                http://tizen.org/feature/led
 337                http://tizen.org/feature/camera.back.flash
 338             It is recommended to design the feature related codes in your application for reliability.
 339             You can check if a device supports the related features for this API by using system information, thereby controlling the procedure of your application.
 340             </remarks>
 341             <privilege>
 342              http://tizen.org/privilege/led
 343             </privilege>
 344             <code>
 345                 Console.WriteLine("Led MaxBrightness is: {0}", Tizen.System.Led.MaxBrightness);
 346                 Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness);
 347             </code>
 348         </member>
 349         <member name="P:Tizen.System.Led.MaxBrightness">
 350             <summary>
 351             Gets the maximum brightness value of the LED that is located next to the camera.
 352             <since_tizen> 3 </since_tizen>
 353             <exception cref="T:System.ArgumentException">When an invalid parameter value is set.</exception>
 354             <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
 355             <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>
 356             </summary>
 357         </member>
 358         <member name="P:Tizen.System.Led.Brightness">
 359             <summary>
 360             Gets the brightness value of the LED that is located next to the camera.
 361             </summary>
 362             <remarks>The brightness value range of the LED is 0 to Tizen.System.Led.MaxBrightness value.
 363             Changing the brightness value will invoke the registered EventHandler for the LED BrightnessChanged (if any).
 364             </remarks>
 365             <since_tizen> 3 </since_tizen>
 366             <exception cref="T:System.ArgumentException"> When an invalid parameter value is set.</exception>
 367             <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
 368             <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>
 369             <code>
 370                 Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness);
 371                 Tizen.System.Led.Brightness = 50;
 372                 Console.WriteLine("Led current Brightness is: {0}", Tizen.System.Led.Brightness);
 373             </code>
 374         </member>
 375         <member name="M:Tizen.System.Led.Play(System.Int32,System.Int32,Tizen.Common.Color)">
 376             <summary>
 377             Plays the LED that is located at the front of the device.
 378             </summary>
 379             <since_tizen> 3 </since_tizen>
 380             <param name="on">Turn on time in milliseconds.</param>
 381             <param name="off">Turn off time in milliseconds.</param>
 382             <param name="color">
 383             The Color value
 384             The first byte means opaque and the other 3 bytes are the RGB values.
 385             </param>
 386             <exception cref="T:System.ArgumentException">When an invalid parameter value is set.</exception>
 387             <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
 388             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
 389             <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>
 390             <code>
 391                 try
 392                 {
 393                     Led.Play(500, 200, Color.FromRgba(255, 255, 255, 1));
 394                 }
 395                 Catch(Exception e)
 396                 {
 397                 }
 398             </code>
 399         </member>
 400         <member name="M:Tizen.System.Led.Stop">
 401             <summary>
 402             Stops the LED that is located at the front of the device.
 403             </summary>
 404             <since_tizen> 3 </since_tizen>
 405             <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
 406             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
 407             <exception cref="T:System.NotSupportedException">In case the device does not support this behavior.</exception>
 408             <code>
 409                 try
 410                 {
 411                     Led.Play(500, 200, Color.FromRgba(255, 255, 255, 1));
 412                     //wait for a while and stop...
 413                     Led.Stop();
 414                 }
 415                 Catch(Exception e)
 416                 {
 417                 }
 418             </code>
 419         </member>
 420         <member name="E:Tizen.System.Led.BrightnessChanged">
 421             <summary>
 422             StateChanged is raised when the LED state is changed.
 423             </summary>
 424             <since_tizen> 3 </since_tizen>
 425             <param name="sender">The source of the event.</param>
 426             <param name="e">LedBrightnessChangedEventArgs is an object that contains the changed brightness.</param>
 427         </member>
 428         <member name="T:Tizen.System.Power">
 429             <summary>
 430             The Power class provides methods to control the power service.
 431             </summary>
 432             <remarks>
 433             The Power API provides the way to control the power service.
 434             It can be made to hold the specific state to avoid the CPU state internally.
 435             </remarks>
 436             <privilege>
 437             http://tizen.org/privilege/display
 438             </privilege>
 439         </member>
 440         <member name="M:Tizen.System.Power.RequestCpuLock(System.Int32)">
 441             <summary>
 442             Locks the CPU for a specified time.
 443             After the given timeout (in milliseconds), unlock the given lock state automatically.
 444             </summary>
 445             <remarks>
 446             If the process dies, then every lock will be removed.
 447             </remarks>
 448             <since_tizen> 3 </since_tizen>
 449             <param name="timeout">
 450             The positive number in milliseconds or 0 for the permanent lock.
 451             So you must release the permanent lock of the power state with ReleaseCpuLock() if timeout_ms is zero.
 452             </param>
 453             <exception cref="T:System.ArgumentException">When an invalid parameter value is set.</exception>
 454             <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
 455             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
 456             <code>
 457             Tizen.System.Power.RequestCpuLock(2000);
 458             </code>
 459         </member>
 460         <member name="M:Tizen.System.Power.ReleaseCpuLock">
 461             <summary>
 462             Releases the CPU lock state.
 463             </summary>
 464             <since_tizen> 3 </since_tizen>
 465             <exception cref="T:System.UnauthorizedAccessException">If the privilege is not set.</exception>
 466             <exception cref="T:System.InvalidOperationException">In case of any system error.</exception>
 467             <code>
 468             Tizen.System.Power.ReleaseCpuLock();
 469             </code>
 470         </member>
 471     </members>
 472 </doc>