Artifacts/bin/Tizen.System.Information.xml

   1 <?xml version="1.0"?>
   2 <doc>
   3     <assembly>
   4         <name>Tizen.System.Information</name>
   5     </assembly>
   6     <members>
   7         <member name="T:Tizen.System.CpuUsage">
   8             <summary>
   9             The structure for CPU usage.
  10             </summary>
  11         </member>
  12         <member name="P:Tizen.System.CpuUsage.User">
  13             <summary>
  14             Running time of un-niced user processes (Percent).
  15             </summary>
  16         </member>
  17         <member name="P:Tizen.System.CpuUsage.System">
  18             <summary>
  19             Running time of kernel processes (Percent).
  20             </summary>
  21         </member>
  22         <member name="P:Tizen.System.CpuUsage.Nice">
  23             <summary>
  24             Running time of niced user processes (Percent).
  25             </summary>
  26         </member>
  27         <member name="P:Tizen.System.CpuUsage.IoWait">
  28             <summary>
  29             Time waiting for I/O completion (Percent).
  30             </summary>
  31         </member>
  32         <member name="T:Tizen.System.ProcessCpuUsage">
  33             <summary>
  34             The structure for CPU usage per process.
  35             </summary>
  36         </member>
  37         <member name="P:Tizen.System.ProcessCpuUsage.UTime">
  38             <summary>
  39             The amount of time this process has been scheduled in user mode (clock ticks).
  40             </summary>
  41         </member>
  42         <member name="P:Tizen.System.ProcessCpuUsage.STime">
  43             <summary>
  44             The amount of time this process has been scheduled in kernel mode (clock ticks).
  45             </summary>
  46         </member>
  47         <member name="T:Tizen.System.RuntimeInformationKey">
  48             <summary>
  49             Enumeration for the runtime information key.
  50             </summary>
  51         </member>
  52         <member name="F:Tizen.System.RuntimeInformationKey.Bluetooth">
  53             <summary>
  54             Indicates whether Bluetooth is enabled.
  55             </summary>
  56         </member>
  57         <member name="F:Tizen.System.RuntimeInformationKey.WifiHotspot">
  58             <summary>
  59             Indicates whether Wi-Fi hotspot is enabled.
  60             <see cref="T:Tizen.System.WifiStatus"/>
  61             </summary>
  62         </member>
  63         <member name="F:Tizen.System.RuntimeInformationKey.BluetoothTethering">
  64             <summary>
  65             Indicates whether Bluetooth tethering is enabled.
  66             </summary>
  67         </member>
  68         <member name="F:Tizen.System.RuntimeInformationKey.UsbTethering">
  69             <summary>
  70             Indicates whether USB tethering is enabled.
  71             </summary>
  72         </member>
  73         <member name="F:Tizen.System.RuntimeInformationKey.PacketData">
  74             <summary>
  75             Indicates whether packet data through 3G network is enabled.
  76             </summary>
  77         </member>
  78         <member name="F:Tizen.System.RuntimeInformationKey.DataRoaming">
  79             <summary>
  80             Indicates whether data roaming is enabled.
  81             </summary>
  82         </member>
  83         <member name="F:Tizen.System.RuntimeInformationKey.Vibration">
  84             <summary>
  85             Indicates whether vibration is enabled.
  86             </summary>
  87         </member>
  88         <member name="F:Tizen.System.RuntimeInformationKey.AudioJack">
  89             <summary>
  90             Indicates whether audio jack is connected.
  91             </summary>
  92         </member>
  93         <member name="F:Tizen.System.RuntimeInformationKey.Gps">
  94             <summary>
  95             Indicates the current status of GPS.
  96             <see cref="T:Tizen.System.GpsStatus"/>
  97             </summary>
  98         </member>
  99         <member name="F:Tizen.System.RuntimeInformationKey.BatteryIsCharging">
 100             <summary>
 101             Indicates whether the battery is currently charging.
 102             </summary>
 103         </member>
 104         <member name="F:Tizen.System.RuntimeInformationKey.TvOut">
 105             <summary>
 106             Indicates whether TV out is connected.
 107             </summary>
 108         </member>
 109         <member name="F:Tizen.System.RuntimeInformationKey.AudioJackConnector">
 110             <summary>
 111             Indicates change in the audio jack connector type.
 112             <see cref="T:Tizen.System.AudioJackConnectionType"/>
 113             </summary>
 114         </member>
 115         <member name="F:Tizen.System.RuntimeInformationKey.Charger">
 116             <summary>
 117             Indicates whether the charger is connected.
 118             </summary>
 119         </member>
 120         <member name="F:Tizen.System.RuntimeInformationKey.AutoRotation">
 121             <summary>
 122             Indicates whether auto rotation is enabled.
 123             </summary>
 124         </member>
 125         <member name="T:Tizen.System.WifiStatus">
 126             <summary>
 127             Enumeration for the Wi-Fi status.
 128             </summary>
 129         </member>
 130         <member name="F:Tizen.System.WifiStatus.Disabled">
 131             <summary>
 132             The Wi-Fi is disabled.
 133             </summary>
 134         </member>
 135         <member name="F:Tizen.System.WifiStatus.Unconnected">
 136             <summary>
 137             The Wi-Fi is enabled and the network connection is not established.
 138             </summary>
 139         </member>
 140         <member name="F:Tizen.System.WifiStatus.Connected">
 141             <summary>
 142             The network connection is established in a Wi-Fi network.
 143             </summary>
 144         </member>
 145         <member name="T:Tizen.System.GpsStatus">
 146             <summary>
 147             Enumeration for the GPS status.
 148             </summary>
 149         </member>
 150         <member name="F:Tizen.System.GpsStatus.Disabled">
 151             <summary>
 152             The GPS is disabled.
 153             </summary>
 154         </member>
 155         <member name="F:Tizen.System.GpsStatus.Searching">
 156             <summary>
 157             The GPS is searching for satellites.
 158             </summary>
 159         </member>
 160         <member name="F:Tizen.System.GpsStatus.Connected">
 161             <summary>
 162             The GPS connection is established.
 163             </summary>
 164         </member>
 165         <member name="T:Tizen.System.AudioJackConnectionType">
 166             <summary>
 167             Enumeration for the type of audio jack connected.
 168             </summary>
 169         </member>
 170         <member name="F:Tizen.System.AudioJackConnectionType.Unconnected">
 171             <summary>
 172             The audio jack is not connected.
 173             </summary>
 174         </member>
 175         <member name="F:Tizen.System.AudioJackConnectionType.ThreeWireConnected">
 176             <summary>
 177             The 3-conductor wire is connected.
 178             </summary>
 179         </member>
 180         <member name="F:Tizen.System.AudioJackConnectionType.FourWireConnected">
 181             <summary>
 182             The 4-conductor wire is connected.
 183             </summary>
 184         </member>
 185         <member name="T:Tizen.System.SystemMemoryInformation">
 186             <summary>
 187             Memory information.
 188             </summary>
 189         </member>
 190         <member name="P:Tizen.System.SystemMemoryInformation.Total">
 191             <summary>
 192             Total memory (KiB).
 193             </summary>
 194         </member>
 195         <member name="P:Tizen.System.SystemMemoryInformation.Used">
 196             <summary>
 197             Used memory (KiB).
 198             </summary>
 199         </member>
 200         <member name="P:Tizen.System.SystemMemoryInformation.Free">
 201             <summary>
 202             Free memory (KiB).
 203             </summary>
 204         </member>
 205         <member name="P:Tizen.System.SystemMemoryInformation.Cache">
 206             <summary>
 207             Cache memory (KiB).
 208             </summary>
 209         </member>
 210         <member name="P:Tizen.System.SystemMemoryInformation.Swap">
 211             <summary>
 212             Swap memory (KiB).
 213             </summary>
 214         </member>
 215         <member name="T:Tizen.System.ProcessMemoryInformation">
 216             <summary>
 217             Memory information per process.
 218             </summary>
 219         </member>
 220         <member name="P:Tizen.System.ProcessMemoryInformation.Vsz">
 221             <summary>
 222             Virtual memory size (KiB).
 223             </summary>
 224         </member>
 225         <member name="P:Tizen.System.ProcessMemoryInformation.Rss">
 226             <summary>
 227             Resident set size (KiB).
 228             </summary>
 229         </member>
 230         <member name="P:Tizen.System.ProcessMemoryInformation.Pss">
 231             <summary>
 232             Proportional set size (KiB).
 233             </summary>
 234         </member>
 235         <member name="P:Tizen.System.ProcessMemoryInformation.SharedClean">
 236             <summary>
 237             Not modified and mapped by other processes (KiB).
 238             </summary>
 239         </member>
 240         <member name="P:Tizen.System.ProcessMemoryInformation.SharedDirty">
 241             <summary>
 242             Modified and mapped by other processes (KiB).
 243             </summary>
 244         </member>
 245         <member name="P:Tizen.System.ProcessMemoryInformation.PrivateClean">
 246             <summary>
 247             Not modified and available only to that process (KiB).
 248             </summary>
 249         </member>
 250         <member name="P:Tizen.System.ProcessMemoryInformation.PrivateDirty">
 251             <summary>
 252             Modified and available only to that process (KiB).
 253             </summary>
 254         </member>
 255         <member name="T:Tizen.System.RuntimeInformation">
 256             <summary>
 257             The RuntimeInformation provides functions to obtain the runtime information of various system preferences.
 258             </summary>
 259         </member>
 260         <member name="M:Tizen.System.RuntimeInformation.Is``1(Tizen.System.RuntimeInformationKey)">
 261             <summary>
 262             Validates the data type of the status represented by the runtime key.
 263             Note that this is a generic method.
 264             </summary>
 265             <since_tizen> 3 </since_tizen>
 266             <typeparam name="T">The generic type to validate.</typeparam>
 267             <param name="key">The runtime information key for which the status type is validated.</param>
 268             <returns>True if the data type matches.</returns>
 269             <exception cref="T:System.ArgumentException">Thrown when the <paramref name="key"/> is invalid.</exception>
 270         </member>
 271         <member name="M:Tizen.System.RuntimeInformation.GetStatus``1(Tizen.System.RuntimeInformationKey)">
 272             <summary>
 273             Gets the status of runtime key.
 274             Note that this is a generic method.
 275             </summary>
 276             <since_tizen> 3 </since_tizen>
 277             <typeparam name="T">The generic type to return.</typeparam>
 278             <param name="key">The runtime information key for which the current should be read.</param>
 279             <returns>The current status of the given key.</returns>.
 280             <exception cref="T:System.ArgumentException">Thrown when the <paramref name="key"/> is invalid.</exception>
 281             <exception cref="T:System.IO.IOException">Thrown when I/O error occurs while reading from the system.</exception>
 282             <exception cref="T:System.NotSupportedException">Thrown when the feature related <paramref name="key"/> is not supported.</exception>
 283         </member>
 284         <member name="M:Tizen.System.RuntimeInformation.GetSystemMemoryInformation">
 285             <summary>
 286             Gets the system memory information.
 287             </summary>
 288             <since_tizen> 3 </since_tizen>
 289             <returns>The system memory information structure.</returns>
 290             <exception cref="T:System.IO.IOException">Thrown when I/O error occurs while reading from the system.</exception>
 291         </member>
 292         <member name="M:Tizen.System.RuntimeInformation.GetProcessMemoryInformation(System.Collections.Generic.IEnumerable{System.Int32})">
 293             <summary>
 294             Gets the memory information per process.
 295             </summary>
 296             <since_tizen> 3 </since_tizen>
 297             <param name="pid">List of unique process ids.</param>
 298             <returns>List of memory information per process.</returns>
 299             <privilege>http://tizen.org/privilege/systemmonitor</privilege>
 300             <exception cref="T:System.ArgumentException">Thrown when the <paramref name="pid"/> is empty.</exception>
 301             <exception cref="T:System.IO.IOException">Thrown when an I/O error occurs while reading from the system or requesting to the resource management daemon.</exception>
 302             <exception cref="T:System.OutOfMemoryException">Thrown when the memory is not enough to allocate.</exception>
 303             <exception cref="T:System.UnauthorizedAccessException">Thrown when the caller does not have privilege to use this method.</exception>
 304         </member>
 305         <member name="M:Tizen.System.RuntimeInformation.GetCpuUsage">
 306             <summary>
 307             Gets the system CPU usage time.
 308             </summary>
 309             <since_tizen> 3 </since_tizen>
 310             <returns>The system CPU usage time structure.</returns>
 311             <exception cref="T:System.IO.IOException">Thrown when an I/O error occurs while reading from the system.</exception>
 312         </member>
 313         <member name="M:Tizen.System.RuntimeInformation.GetProcessCpuUsage(System.Collections.Generic.IEnumerable{System.Int32})">
 314             <summary>
 315             Gets the CPU usage time per process.
 316             </summary>
 317             <since_tizen> 3 </since_tizen>
 318             <param name="pid">List of unique process ids.</param>
 319             <returns>List of CPU usage information per process.</returns>
 320             <privilege>http://tizen.org/privilege/systemmonitor</privilege>
 321             <exception cref="T:System.ArgumentException">Thrown when the <paramref name="pid"/> is empty.</exception>
 322             <exception cref="T:System.IO.IOException">Thrown when an I/O error occurs while reading from the system or requesting to the resource management daemon.</exception>
 323             <exception cref="T:System.OutOfMemoryException">Thrown when the memory is not enough to allocate.</exception>
 324             <exception cref="T:System.UnauthorizedAccessException">Thrown when the caller does not have privilege to use this method.</exception>
 325         </member>
 326         <member name="P:Tizen.System.RuntimeInformation.ProcessorCount">
 327             <summary>
 328             Gets the number of processors.
 329             </summary>
 330             <value>The number of processors.</value>
 331             <exception cref="T:System.IO.IOException">Thrown when an I/O error occurs while reading from system.</exception>
 332         </member>
 333         <member name="M:Tizen.System.RuntimeInformation.GetProcessorCurrentFrequency(System.Int32)">
 334             <summary>
 335             Gets the current frequency of the processor.
 336             </summary>
 337             <since_tizen> 3 </since_tizen>
 338             <param name="coreId">The index (from 0) of the CPU core that you want to know the frequency of.</param>
 339             <returns>The current frequency(MHz) of processor.</returns>
 340             <exception cref="T:System.ArgumentException">Thrown when the <paramref name="coreid"/> is invalid.</exception>
 341             <exception cref="T:System.IO.IOException">Thrown when an I/O error occurs while reading from system.</exception>
 342             <exception cref="T:System.NotSupportedException">Thrown when this system does not store the current CPU frequency.</exception>
 343         </member>
 344         <member name="M:Tizen.System.RuntimeInformation.GetProcessorMaxFrequency(System.Int32)">
 345             <summary>
 346             Gets the max frequency of the processor.
 347             </summary>
 348             <since_tizen> 3 </since_tizen>
 349             <param name="coreId">The index (from 0) of CPU core that you want to know the frequency of.</param>
 350             <returns>The max frequency(MHz) of processor.</returns>
 351             <exception cref="T:System.ArgumentException">Thrown when the <paramref name="coreid"/> is invalid.</exception>
 352             <exception cref="T:System.IO.IOException">Thrown when an I/O error occurs while reading from system.</exception>
 353             <exception cref="T:System.NotSupportedException">Thrown when this system does not store the max CPU frequency.</exception>
 354         </member>
 355         <member name="E:Tizen.System.RuntimeInformation.BluetoothEnabled">
 356             <summary>
 357             (event) BluetoothEnabled is raised when the system preference for Bluetooth is changed.
 358             </summary>
 359         </member>
 360         <member name="E:Tizen.System.RuntimeInformation.WifiHotspotEnabled">
 361             <summary>
 362             (event) WifiHotspotEnabled is raised when the system preference for Wi-Fi is changed.
 363             </summary>
 364         </member>
 365         <member name="E:Tizen.System.RuntimeInformation.BluetoothTetheringEnabled">
 366             <summary>
 367             (event) BluetoothTetheringEnabled is raised when the system preference for bluetooth tethering is changed.
 368             </summary>
 369         </member>
 370         <member name="E:Tizen.System.RuntimeInformation.UsbTetheringEnabled">
 371             <summary>
 372             (event) UsbTetheringEnabled is raised when the system preference for USB tethering is changed.
 373             </summary>
 374         </member>
 375         <member name="E:Tizen.System.RuntimeInformation.PacketDataEnabled">
 376             <summary>
 377             (event) PacketDataEnabled is raised when the system preference for package data through 3G network is changed.
 378             </summary>
 379         </member>
 380         <member name="E:Tizen.System.RuntimeInformation.DataRoamingEnabled">
 381             <summary>
 382             (event) DataRoamingEnabled is raised when the system preference for data roaming is changed.
 383             </summary>
 384         </member>
 385         <member name="E:Tizen.System.RuntimeInformation.VibrationEnabled">
 386             <summary>
 387             (event) VibrationEnabled is raised when the system preference for vibration is changed.
 388             </summary>
 389         </member>
 390         <member name="E:Tizen.System.RuntimeInformation.AudioJackConnected">
 391             <summary>
 392             (event) AudioJackConnected is raised when the audio jack is connected/disconnected.
 393             </summary>
 394         </member>
 395         <member name="E:Tizen.System.RuntimeInformation.GpsStatusChanged">
 396             <summary>
 397             (event) GpsStatusChanged is raised when the status of GPS is changed.
 398             </summary>
 399         </member>
 400         <member name="E:Tizen.System.RuntimeInformation.BatteryIsCharging">
 401             <summary>
 402             (event) BatteryIsCharging is raised when the battery is currently charging.
 403             </summary>
 404         </member>
 405         <member name="E:Tizen.System.RuntimeInformation.TvOutConnected">
 406             <summary>
 407             (event) TvOutConnected is raised when TV out is connected/disconnected.
 408             </summary>
 409         </member>
 410         <member name="E:Tizen.System.RuntimeInformation.AudioJackConnectorChanged">
 411             <summary>
 412             (event) AudioJackConnectorChanged is raised when the audio jack connection changes.
 413             </summary>
 414         </member>
 415         <member name="E:Tizen.System.RuntimeInformation.ChargerConnected">
 416             <summary>
 417             (event) ChargerConnected is raised when the charger is connected/disconnected.
 418             </summary>
 419         </member>
 420         <member name="E:Tizen.System.RuntimeInformation.AutoRotationEnabled">
 421             <summary>
 422             (event) AutoRotationEnabled is raised when the system preference for auto rotation is changed.
 423             </summary>
 424         </member>
 425         <member name="T:Tizen.System.RuntimeKeyStatusChangedEventArgs">
 426             <summary>
 427             RuntimeInfoChangedEventArgs is an extended EventArgs class. This class contains event arguments for runtime event listeners.
 428             </summary>
 429         </member>
 430         <member name="P:Tizen.System.RuntimeKeyStatusChangedEventArgs.Key">
 431             <summary>
 432             The key indicating the runtime system preference which was changed.
 433             </summary>
 434         </member>
 435         <member name="T:Tizen.System.SystemInfo">
 436             <summary>
 437             System Information class. This class has methods which can be used to obtain device information.
 438             </summary>
 439         </member>
 440         <member name="M:Tizen.System.SystemInfo.Is``1(System.String)">
 441             <summary>
 442             Checks if the type of value for the given feature is T.
 443             </summary>
 444             <since_tizen> 3 </since_tizen>
 445             <typeparam name="T">Type of value for the feature key.</typeparam>
 446             <param name="key">The name of the feature.</param>
 447             <returns>True if type of value for the given feature is T, otherwise false.</returns>
 448         </member>
 449         <member name="M:Tizen.System.SystemInfo.IsValidKey(System.String)">
 450             <summary>
 451             Checks if the given key is a valid feature.
 452             </summary>
 453             <since_tizen> 3 </since_tizen>
 454             <param name="key">The name of the feature.</param>
 455             <returns>True if the key is valid, otherwise false.</returns>
 456         </member>
 457         <member name="M:Tizen.System.SystemInfo.TryGetValue``1(System.String,``0@)">
 458             <summary>
 459             Gets the value of the feature.
 460             </summary>
 461             <since_tizen> 3 </since_tizen>
 462             <typeparam name="T">Type of key value.</typeparam>
 463             <param name="key">The name of the feature.</param>
 464             <param name="value">The value of the given feature.</param>
 465             <returns>Returns true on success, otherwise false.</returns>
 466         </member>
 467         <member name="M:Tizen.System.SystemInfo.TryGetValue(System.String,System.Boolean@)">
 468             <summary>
 469             Gets the bool value of the feature.
 470             </summary>
 471             <since_tizen> 3 </since_tizen>
 472             <param name="key">The name of the feature.</param>
 473             <param name="value">The value of the given feature.</param>
 474             <returns>Returns true on success, otherwise false.</returns>
 475         </member>
 476         <member name="M:Tizen.System.SystemInfo.TryGetValue(System.String,System.Int32@)">
 477             <summary>
 478             Gets the int value of the feature.
 479             </summary>
 480             <since_tizen> 3 </since_tizen>
 481             <param name="key">The name of the feature.</param>
 482             <param name="value">The value of the given feature.</param>
 483             <returns>Returns true on success, otherwise false.</returns>
 484         </member>
 485         <member name="M:Tizen.System.SystemInfo.TryGetValue(System.String,System.Double@)">
 486             <summary>
 487             Gets the double value of the feature.
 488             </summary>
 489             <since_tizen> 3 </since_tizen>
 490             <param name="key">The name of the feature.</param>
 491             <param name="value">The value of the given feature.</param>
 492             <returns>Returns true on success, otherwise false.</returns>
 493         </member>
 494         <member name="M:Tizen.System.SystemInfo.TryGetValue(System.String,System.String@)">
 495             <summary>
 496             Gets the string value of the feature.
 497             </summary>
 498             <since_tizen> 3 </since_tizen>
 499             <param name="key">The name of the feature.</param>
 500             <param name="value">The value of the given feature.</param>
 501             <returns>Returns true on success, otherwise false.</returns>
 502         </member>
 503     </members>
 504 </doc>