1 <?xml version="1.0"?>
\r
4 <name>Tizen.System.Information</name>
\r
7 <member name="T:Tizen.System.Information">
\r
9 The Information class provides functions to obtain various system information.
\r
12 <member name="M:Tizen.System.Information.TryGetValue``1(System.String,``0@)">
\r
14 Gets the value of the feature.
\r
16 <since_tizen> 4 </since_tizen>
\r
17 <typeparam name="T">The type of <paramref name="value"/>.</typeparam>
\r
18 <param name="key">The name of the feature.</param>
\r
19 <param name="value">The value of the given feature.</param>
\r
20 <returns>Returns true on success, otherwise false.</returns>
\r
22 <member name="M:Tizen.System.Information.SetCallback(System.String,System.EventHandler{Tizen.System.RuntimeFeatureStatusChangedEventArgs})">
\r
24 Registers a change event callback for given runtime feature key.
\r
27 This function is only for runtime feature.
\r
29 <since_tizen> 4 </since_tizen>
\r
30 <param name="key">The name of runtime feature which wants to register callback.</param>
\r
31 <param name="callback">The callback function to subscribe.</param>
\r
32 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="key"/> is invalid.</exception>
\r
33 <exception cref="T:System.NotSupportedException">Thrown when the feature related <paramref name="key"/> is not supported.</exception>
\r
35 <member name="M:Tizen.System.Information.UnsetCallback(System.String,System.EventHandler{Tizen.System.RuntimeFeatureStatusChangedEventArgs})">
\r
37 Unregisters a change event callback for given runtime feature key.
\r
40 This function is only for runtime feature.
\r
42 <since_tizen> 4 </since_tizen>
\r
43 <param name="key">The name of runtime feature which wants to unregister callback.</param>
\r
44 <param name="callback">The callback function to unsubscribe.</param>
\r
45 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="key"/> is invalid.</exception>
\r
46 <exception cref="T:System.NotSupportedException">Thrown when the feature related <paramref name="key"/> is not supported.</exception>
\r
48 <member name="F:Tizen.System.RuntimeInfoKey.Bluetooth">
\r
50 Indicates whether Bluetooth is enabled.
\r
53 <member name="F:Tizen.System.RuntimeInfoKey.WifiHotspot">
\r
55 Indicates whether Wi-Fi hotspot is enabled.
\r
58 <member name="F:Tizen.System.RuntimeInfoKey.BluetoothTethering">
\r
60 Indicates whether Bluetooth tethering is enabled.
\r
63 <member name="F:Tizen.System.RuntimeInfoKey.UsbTethering">
\r
65 Indicates whether USB tethering is enabled.
\r
68 <member name="F:Tizen.System.RuntimeInfoKey.PacketData">
\r
70 Indicates whether packet data through 3G network is enabled.
\r
73 <member name="F:Tizen.System.RuntimeInfoKey.DataRoaming">
\r
75 Indicates whether data roaming is enabled.
\r
78 <member name="F:Tizen.System.RuntimeInfoKey.Vibration">
\r
80 Indicates whether vibration is enabled.
\r
83 <member name="F:Tizen.System.RuntimeInfoKey.AudioJack">
\r
85 Indicates whether audio jack is connected.
\r
88 <member name="F:Tizen.System.RuntimeInfoKey.Gps">
\r
90 Indicates the current status of GPS.
\r
91 <see cref="T:Tizen.System.GpsStatus"/>
\r
94 <member name="F:Tizen.System.RuntimeInfoKey.BatteryIsCharging">
\r
96 Indicates whether the battery is currently charging.
\r
99 <member name="F:Tizen.System.RuntimeInfoKey.TvOut">
\r
101 Indicates whether TV out is connected.
\r
104 <member name="F:Tizen.System.RuntimeInfoKey.AudioJackConnector">
\r
106 Indicates change in the audio jack connector type.
\r
107 <see cref="T:Tizen.System.AudioJackConnectionType"/>
\r
110 <member name="F:Tizen.System.RuntimeInfoKey.Charger">
\r
112 Indicates whether the charger is connected.
\r
115 <member name="F:Tizen.System.RuntimeInfoKey.AutoRotation">
\r
117 Indicates whether auto rotation is enabled.
\r
120 <member name="T:Tizen.System.GpsStatus">
\r
122 Enumeration for the GPS status.
\r
125 <member name="F:Tizen.System.GpsStatus.Disabled">
\r
127 The GPS is disabled.
\r
130 <member name="F:Tizen.System.GpsStatus.Searching">
\r
132 The GPS is searching for satellites.
\r
135 <member name="F:Tizen.System.GpsStatus.Connected">
\r
137 The GPS connection is established.
\r
140 <member name="T:Tizen.System.AudioJackConnectionType">
\r
142 Enumeration for the type of audio jack connected.
\r
145 <member name="F:Tizen.System.AudioJackConnectionType.Unconnected">
\r
147 The audio jack is not connected.
\r
150 <member name="F:Tizen.System.AudioJackConnectionType.ThreeWireConnected">
\r
152 The 3-conductor wire is connected.
\r
155 <member name="F:Tizen.System.AudioJackConnectionType.FourWireConnected">
\r
157 The 4-conductor wire is connected.
\r
160 <member name="T:Tizen.System.RuntimeFeatureStatusChangedEventArgs">
\r
162 RuntimeFeatureStatusChangedEventArgs is an extended EventArgs class. This class contains event arguments for runtime event listeners.
\r
165 <member name="P:Tizen.System.RuntimeFeatureStatusChangedEventArgs.Key">
\r
167 The key indicating the runtime system preference which was changed.
\r
168 It includes the prefix "http://" though you don't use for registering callback.
\r
171 <member name="M:Tizen.System.RuntimeInfo.Is``1(Tizen.System.RuntimeInfoKey)">
\r
173 Validates the data type of the status represented by the runtime key.
\r
174 Note that this is a generic method.
\r
176 <typeparam name="T">The generic type to validate.</typeparam>
\r
177 <param name="key">The runtime information key for which the status type is validated.</param>
\r
178 <returns>True if the data type matches.</returns>
\r
179 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="key"/> is invalid.</exception>
\r
181 <member name="M:Tizen.System.RuntimeInfo.TryGetValue``1(Tizen.System.RuntimeInfoKey,``0@)">
\r
183 Gets the status of runtime key.
\r
184 Note that this is a generic method.
\r
186 <typeparam name="T">The generic type to return.</typeparam>
\r
187 <param name="key">The runtime information key for which the current should be read.</param>
\r
188 <param name="value">The value of the given feature.</param>
\r
189 <returns>Returns true on success, otherwise false.</returns>
\r
191 <member name="M:Tizen.System.RuntimeInfo.SetCallback(Tizen.System.RuntimeInfoKey,System.EventHandler{Tizen.System.RuntimeFeatureStatusChangedEventArgs})">
\r
193 Registers a change event callback for given key.
\r
195 <param name="key">The runtime information key which wants to register callback.</param>
\r
196 <param name="callback">The callback function to subscribe.</param>
\r
197 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="key"/> is invalid.</exception>
\r
198 <exception cref="T:System.NotSupportedException">Thrown when the feature related <paramref name="key"/> is not supported.</exception>
\r
200 <member name="M:Tizen.System.RuntimeInfo.UnsetCallback(Tizen.System.RuntimeInfoKey,System.EventHandler{Tizen.System.RuntimeFeatureStatusChangedEventArgs})">
\r
202 Unregisters a change event callback for given key.
\r
204 <param name="key">The runtime information key which wants to unregister callback.</param>
\r
205 <param name="callback">The callback function to unsubscribe.</param>
\r
206 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="key"/> is invalid.</exception>
\r
208 <member name="M:Tizen.System.TvProductHelper.ConvertKeyIfTvProduct(Tizen.System.RuntimeInfoKey)">
\r
209 This function is for a TV product. It will be removed.
\r
211 <member name="M:Tizen.System.SystemInfo.Is``1(System.String)">
\r
213 Checks if the type of value for the given feature is T.
\r
215 <typeparam name="T">Type of value for the feature key.</typeparam>
\r
216 <param name="key">The name of the feature.</param>
\r
217 <returns>True if type of value for the given feature is T, otherwise false.</returns>
\r
219 <member name="M:Tizen.System.SystemInfo.IsValidKey(System.String)">
\r
221 Checks if the given key is a valid feature.
\r
223 <param name="key">The name of the feature.</param>
\r
224 <returns>True if the key is valid, otherwise false.</returns>
\r
226 <member name="M:Tizen.System.SystemInfo.TryGetValue``1(System.String,``0@)">
\r
228 Gets the value of the feature.
\r
230 <typeparam name="T">Type of key value.</typeparam>
\r
231 <param name="key">The name of the feature.</param>
\r
232 <param name="value">The value of the given feature.</param>
\r
233 <returns>Returns true on success, otherwise false.</returns>
\r
235 <member name="M:Tizen.System.SystemInfo.TryGetValue(System.String,System.Boolean@)">
\r
237 Gets the bool value of the feature.
\r
239 <param name="key">The name of the feature.</param>
\r
240 <param name="value">The value of the given feature.</param>
\r
241 <returns>Returns true on success, otherwise false.</returns>
\r
243 <member name="M:Tizen.System.SystemInfo.TryGetValue(System.String,System.Int32@)">
\r
245 Gets the int value of the feature.
\r
247 <param name="key">The name of the feature.</param>
\r
248 <param name="value">The value of the given feature.</param>
\r
249 <returns>Returns true on success, otherwise false.</returns>
\r
251 <member name="M:Tizen.System.SystemInfo.TryGetValue(System.String,System.Double@)">
\r
253 Gets the double value of the feature.
\r
255 <param name="key">The name of the feature.</param>
\r
256 <param name="value">The value of the given feature.</param>
\r
257 <returns>Returns true on success, otherwise false.</returns>
\r
259 <member name="M:Tizen.System.SystemInfo.TryGetValue(System.String,System.String@)">
\r
261 Gets the string value of the feature.
\r
263 <param name="key">The name of the feature.</param>
\r
264 <param name="value">The value of the given feature.</param>
\r
265 <returns>Returns true on success, otherwise false.</returns>
\r
267 <member name="T:Tizen.System.ProcessCpuUsage">
\r
269 The class for CPU usage per process.
\r
272 <member name="M:Tizen.System.ProcessCpuUsage.#ctor(System.Collections.Generic.IEnumerable{System.Int32})">
\r
274 The constructor of ProcessCpuUsage class.
\r
276 <since_tizen> 4 </since_tizen>
\r
277 <param name="pid">List of unique process ids.</param>
\r
278 <privilege>http://tizen.org/privilege/systemmonitor</privilege>
\r
279 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="pid"/> is empty.</exception>
\r
280 <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>
\r
281 <exception cref="T:System.OutOfMemoryException">Thrown when the memory is not enough to allocate.</exception>
\r
282 <exception cref="T:System.UnauthorizedAccessException">Thrown when the caller does not have privilege to use this method.</exception>
\r
284 <member name="P:Tizen.System.ProcessCpuUsage.Count">
\r
286 The number of usage entries.
\r
288 <since_tizen> 4 </since_tizen>
\r
290 <member name="M:Tizen.System.ProcessCpuUsage.GetUTime(System.Int32)">
\r
292 Gets the amount of time this process has been scheduled in user mode.
\r
294 <since_tizen> 4 </since_tizen>
\r
295 <param name="pid">The process id.</param>
\r
296 <returns>The amount of time <paramref name="pid"/> has been scheduled in user mode (clock ticks).</returns>
\r
297 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="pid"/> is invalid.</exception>
\r
299 <member name="M:Tizen.System.ProcessCpuUsage.GetSTime(System.Int32)">
\r
301 Gets the amount of time this process has been scheduled in kernel mode.
\r
303 <since_tizen> 4 </since_tizen>
\r
304 <param name="pid">The process id.</param>
\r
305 <returns>The amount of time <paramref name="pid"/> has been scheduled in kernel mode (clock ticks).</returns>
\r
306 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="pid"/> is invalid.</exception>
\r
308 <member name="M:Tizen.System.ProcessCpuUsage.Update(System.Collections.Generic.IEnumerable{System.Int32})">
\r
310 Update the process CPU usage to the latest.
\r
312 <since_tizen> 4 </since_tizen>
\r
313 <param name="pid">List of unique process ids.</param>
\r
314 <privilege>http://tizen.org/privilege/systemmonitor</privilege>
\r
315 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="pid"/> is empty.</exception>
\r
316 <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>
\r
317 <exception cref="T:System.OutOfMemoryException">Thrown when the memory is not enough to allocate.</exception>
\r
318 <exception cref="T:System.UnauthorizedAccessException">Thrown when the caller does not have privilege to use this method.</exception>
\r
320 <member name="T:Tizen.System.ProcessMemoryUsage">
\r
322 The class for memory information per process.
\r
325 <member name="M:Tizen.System.ProcessMemoryUsage.#ctor(System.Collections.Generic.IEnumerable{System.Int32})">
\r
327 The constructor of ProcessMemoryInformation class.
\r
329 <since_tizen> 4 </since_tizen>
\r
330 <param name="pid">List of unique process ids.</param>
\r
331 <privilege>http://tizen.org/privilege/systemmonitor</privilege>
\r
332 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="pid"/> is empty.</exception>
\r
333 <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>
\r
334 <exception cref="T:System.OutOfMemoryException">Thrown when the memory is not enough to allocate.</exception>
\r
335 <exception cref="T:System.UnauthorizedAccessException">Thrown when the caller does not have privilege to use this method.</exception>
\r
337 <member name="P:Tizen.System.ProcessMemoryUsage.Count">
\r
339 The number of usage entries.
\r
341 <since_tizen> 4 </since_tizen>
\r
343 <member name="M:Tizen.System.ProcessMemoryUsage.GetVsz(System.Int32)">
\r
345 Gets the virtual memory size of a process.
\r
347 <since_tizen> 4 </since_tizen>
\r
348 <param name="pid">The process id.</param>
\r
349 <returns>The virtual memory size <paramref name="pid"/> is using (KiB).</returns>
\r
350 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="pid"/> is invalid.</exception>
\r
352 <member name="M:Tizen.System.ProcessMemoryUsage.GetRss(System.Int32)">
\r
354 Gets the resident set size of a process.
\r
356 <since_tizen> 4 </since_tizen>
\r
357 <param name="pid">The process id.</param>
\r
358 <returns>The resident set size <paramref name="pid"/> is using (KiB).</returns>
\r
359 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="pid"/> is invalid.</exception>
\r
361 <member name="M:Tizen.System.ProcessMemoryUsage.GetPss(System.Int32)">
\r
363 Gets the proportional set size of a process.
\r
365 <since_tizen> 4 </since_tizen>
\r
366 <param name="pid">The process id.</param>
\r
367 <returns>The proportional set size <paramref name="pid"/> is using (KiB).</returns>
\r
368 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="pid"/> is invalid.</exception>
\r
370 <member name="M:Tizen.System.ProcessMemoryUsage.GetSharedClean(System.Int32)">
\r
372 Gets the size not modified and mapped by other processes of a process.
\r
374 <since_tizen> 4 </since_tizen>
\r
375 <param name="pid">The process id.</param>
\r
376 <returns>The shared clean memory size <paramref name="pid"/> is using (KiB).</returns>
\r
377 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="pid"/> is invalid.</exception>
\r
379 <member name="M:Tizen.System.ProcessMemoryUsage.GetSharedDirty(System.Int32)">
\r
381 Gets the size modified and mapped by other processes of a process.
\r
383 <since_tizen> 4 </since_tizen>
\r
384 <param name="pid">The process id.</param>
\r
385 <returns>The shared dirty memory size <paramref name="pid"/> is using (KiB).</returns>
\r
386 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="pid"/> is invalid.</exception>
\r
388 <member name="M:Tizen.System.ProcessMemoryUsage.GetPrivateClean(System.Int32)">
\r
390 Gets the size not modified and available only to that process of a process.
\r
392 <since_tizen> 4 </since_tizen>
\r
393 <param name="pid">The process id.</param>
\r
394 <returns>The private clean memory size <paramref name="pid"/> is using (KiB).</returns>
\r
395 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="pid"/> is invalid.</exception>
\r
397 <member name="M:Tizen.System.ProcessMemoryUsage.GetPrivateDirty(System.Int32)">
\r
399 Gets the size modified and available only to that process of a process.
\r
401 <since_tizen> 4 </since_tizen>
\r
402 <param name="pid">The process id.</param>
\r
403 <returns>The private dirty memory size <paramref name="pid"/> is using (KiB).</returns>
\r
404 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="pid"/> is invalid.</exception>
\r
406 <member name="M:Tizen.System.ProcessMemoryUsage.Update(System.Collections.Generic.IEnumerable{System.Int32})">
\r
408 Update the process memory information to the latest.
\r
410 <since_tizen> 4 </since_tizen>
\r
411 <param name="pid">List of unique process ids.</param>
\r
412 <privilege>http://tizen.org/privilege/systemmonitor</privilege>
\r
413 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="pid"/> is empty.</exception>
\r
414 <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>
\r
415 <exception cref="T:System.OutOfMemoryException">Thrown when the memory is not enough to allocate.</exception>
\r
416 <exception cref="T:System.UnauthorizedAccessException">Thrown when the caller does not have privilege to use this method.</exception>
\r
418 <member name="T:Tizen.System.SystemCpuUsage">
\r
420 The class for system CPU usage.
\r
423 <member name="M:Tizen.System.SystemCpuUsage.#ctor">
\r
425 The constructor of SystemCpuUsage class.
\r
427 <since_tizen> 4 </since_tizen>
\r
428 <exception cref="T:System.IO.IOException">Thrown when an I/O error occurs while reading from the system.</exception>
\r
429 <exception cref="T:System.NotSupportedException">Thrown when this system does not store the current CPU frequency.</exception>
\r
431 <member name="P:Tizen.System.SystemCpuUsage.User">
\r
433 Running time of un-niced user processes (Percent).
\r
435 <since_tizen> 4 </since_tizen>
\r
437 <member name="P:Tizen.System.SystemCpuUsage.System">
\r
439 Running time of kernel processes (Percent).
\r
441 <since_tizen> 4 </since_tizen>
\r
443 <member name="P:Tizen.System.SystemCpuUsage.Nice">
\r
445 Running time of niced user processes (Percent).
\r
447 <since_tizen> 4 </since_tizen>
\r
449 <member name="P:Tizen.System.SystemCpuUsage.IoWait">
\r
451 Time waiting for I/O completion (Percent).
\r
453 <since_tizen> 4 </since_tizen>
\r
455 <member name="P:Tizen.System.SystemCpuUsage.ProcessorCount">
\r
457 The number of processors.
\r
459 <since_tizen> 4 </since_tizen>
\r
461 <member name="M:Tizen.System.SystemCpuUsage.GetCurrentFrequency(System.Int32)">
\r
463 Gets the current frequency of the processor.
\r
465 <since_tizen> 4 </since_tizen>
\r
466 <param name="coreId">The index (from 0) of the CPU core that you want to know the frequency of.</param>
\r
467 <returns>The current frequency(MHz) of processor.</returns>
\r
468 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="coreId"/> is invalid.</exception>
\r
470 <member name="M:Tizen.System.SystemCpuUsage.GetMaxFrequency(System.Int32)">
\r
472 Gets the max frequency of the processor.
\r
474 <since_tizen> 4 </since_tizen>
\r
475 <param name="coreId">The index (from 0) of CPU core that you want to know the frequency of.</param>
\r
476 <returns>The max frequency(MHz) of processor.</returns>
\r
477 <exception cref="T:System.ArgumentException">Thrown when the <paramref name="coreId"/> is invalid.</exception>
\r
479 <member name="M:Tizen.System.SystemCpuUsage.Update">
\r
481 Update the system CPU usage to the latest.
\r
483 <since_tizen> 4 </since_tizen>
\r
484 <exception cref="T:System.IO.IOException">Thrown when an I/O error occurs while reading from the system.</exception>
\r
485 <exception cref="T:System.NotSupportedException">Thrown when this system does not store the current CPU frequency.</exception>
\r
487 <member name="T:Tizen.System.SystemMemoryUsage">
\r
489 The class for system memory information.
\r
492 <member name="M:Tizen.System.SystemMemoryUsage.#ctor">
\r
494 The constructor of MemoryInformation class.
\r
496 <since_tizen> 4 </since_tizen>
\r
497 <exception cref="T:System.IO.IOException">Thrown when an I/O error occurs while reading from the system.</exception>
\r
499 <member name="P:Tizen.System.SystemMemoryUsage.Total">
\r
501 Total memory (KiB).
\r
503 <since_tizen> 4 </since_tizen>
\r
505 <member name="P:Tizen.System.SystemMemoryUsage.Used">
\r
509 <since_tizen> 4 </since_tizen>
\r
511 <member name="P:Tizen.System.SystemMemoryUsage.Free">
\r
515 <since_tizen> 4 </since_tizen>
\r
517 <member name="P:Tizen.System.SystemMemoryUsage.Cache">
\r
519 Cache memory (KiB).
\r
521 <since_tizen> 4 </since_tizen>
\r
523 <member name="P:Tizen.System.SystemMemoryUsage.Swap">
\r
527 <since_tizen> 4 </since_tizen>
\r
529 <member name="M:Tizen.System.SystemMemoryUsage.Update">
\r
531 Update the system memory information to the latest.
\r
533 <since_tizen> 4 </since_tizen>
\r
534 <exception cref="T:System.IO.IOException">Thrown when I/O error occurs while reading from the system.</exception>
\r