X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=Artifacts%2Fbin%2Fpublic%2FTizen.System.Information.xml;h=be70f4f0d8cc00944ac7798c585a983226b90355;hb=d463133eaf15b1636d1c0dec8bc632e1e579e07c;hp=66dc2f6bc21b906b2a54236f024072440b185db7;hpb=12c9ab8b3191a614dc9006b57c1cba6e1f3b6d13;p=platform%2Fcore%2Fcsapi%2Ftizenfx.git diff --git a/Artifacts/bin/public/Tizen.System.Information.xml b/Artifacts/bin/public/Tizen.System.Information.xml index 66dc2f6..be70f4f 100644 --- a/Artifacts/bin/public/Tizen.System.Information.xml +++ b/Artifacts/bin/public/Tizen.System.Information.xml @@ -1,504 +1,537 @@ - - - - Tizen.System.Information - - - - - The structure for CPU usage. - - - - - Running time of un-niced user processes (Percent). - - - - - Running time of kernel processes (Percent). - - - - - Running time of niced user processes (Percent). - - - - - Time waiting for I/O completion (Percent). - - - - - The structure for CPU usage per process. - - - - - The amount of time this process has been scheduled in user mode (clock ticks). - - - - - The amount of time this process has been scheduled in kernel mode (clock ticks). - - - - - Enumeration for the runtime information key. - - - - - Indicates whether Bluetooth is enabled. - - - - - Indicates whether Wi-Fi hotspot is enabled. - - - - - - Indicates whether Bluetooth tethering is enabled. - - - - - Indicates whether USB tethering is enabled. - - - - - Indicates whether packet data through 3G network is enabled. - - - - - Indicates whether data roaming is enabled. - - - - - Indicates whether vibration is enabled. - - - - - Indicates whether audio jack is connected. - - - - - Indicates the current status of GPS. - - - - - - Indicates whether the battery is currently charging. - - - - - Indicates whether TV out is connected. - - - - - Indicates change in the audio jack connector type. - - - - - - Indicates whether the charger is connected. - - - - - Indicates whether auto rotation is enabled. - - - - - Enumeration for the Wi-Fi status. - - - - - The Wi-Fi is disabled. - - - - - The Wi-Fi is enabled and the network connection is not established. - - - - - The network connection is established in a Wi-Fi network. - - - - - Enumeration for the GPS status. - - - - - The GPS is disabled. - - - - - The GPS is searching for satellites. - - - - - The GPS connection is established. - - - - - Enumeration for the type of audio jack connected. - - - - - The audio jack is not connected. - - - - - The 3-conductor wire is connected. - - - - - The 4-conductor wire is connected. - - - - - Memory information. - - - - - Total memory (KiB). - - - - - Used memory (KiB). - - - - - Free memory (KiB). - - - - - Cache memory (KiB). - - - - - Swap memory (KiB). - - - - - Memory information per process. - - - - - Virtual memory size (KiB). - - - - - Resident set size (KiB). - - - - - Proportional set size (KiB). - - - - - Not modified and mapped by other processes (KiB). - - - - - Modified and mapped by other processes (KiB). - - - - - Not modified and available only to that process (KiB). - - - - - Modified and available only to that process (KiB). - - - - - The RuntimeInformation provides functions to obtain the runtime information of various system preferences. - - - - - Validates the data type of the status represented by the runtime key. - Note that this is a generic method. - - 3 - The generic type to validate. - The runtime information key for which the status type is validated. - True if the data type matches. - Thrown when the is invalid. - - - - Gets the status of runtime key. - Note that this is a generic method. - - 3 - The generic type to return. - The runtime information key for which the current should be read. - The current status of the given key.. - Thrown when the is invalid. - Thrown when I/O error occurs while reading from the system. - Thrown when the feature related is not supported. - - - - Gets the system memory information. - - 3 - The system memory information structure. - Thrown when I/O error occurs while reading from the system. - - - - Gets the memory information per process. - - 3 - List of unique process ids. - List of memory information per process. - http://tizen.org/privilege/systemmonitor - Thrown when the is empty. - Thrown when an I/O error occurs while reading from the system or requesting to the resource management daemon. - Thrown when the memory is not enough to allocate. - Thrown when the caller does not have privilege to use this method. - - - - Gets the system CPU usage time. - - 3 - The system CPU usage time structure. - Thrown when an I/O error occurs while reading from the system. - - - - Gets the CPU usage time per process. - - 3 - List of unique process ids. - List of CPU usage information per process. - http://tizen.org/privilege/systemmonitor - Thrown when the is empty. - Thrown when an I/O error occurs while reading from the system or requesting to the resource management daemon. - Thrown when the memory is not enough to allocate. - Thrown when the caller does not have privilege to use this method. - - - - Gets the number of processors. - - The number of processors. - Thrown when an I/O error occurs while reading from system. - - - - Gets the current frequency of the processor. - - 3 - The index (from 0) of the CPU core that you want to know the frequency of. - The current frequency(MHz) of processor. - Thrown when the is invalid. - Thrown when an I/O error occurs while reading from system. - Thrown when this system does not store the current CPU frequency. - - - - Gets the max frequency of the processor. - - 3 - The index (from 0) of CPU core that you want to know the frequency of. - The max frequency(MHz) of processor. - Thrown when the is invalid. - Thrown when an I/O error occurs while reading from system. - Thrown when this system does not store the max CPU frequency. - - - - (event) BluetoothEnabled is raised when the system preference for Bluetooth is changed. - - - - - (event) WifiHotspotEnabled is raised when the system preference for Wi-Fi is changed. - - - - - (event) BluetoothTetheringEnabled is raised when the system preference for bluetooth tethering is changed. - - - - - (event) UsbTetheringEnabled is raised when the system preference for USB tethering is changed. - - - - - (event) PacketDataEnabled is raised when the system preference for package data through 3G network is changed. - - - - - (event) DataRoamingEnabled is raised when the system preference for data roaming is changed. - - - - - (event) VibrationEnabled is raised when the system preference for vibration is changed. - - - - - (event) AudioJackConnected is raised when the audio jack is connected/disconnected. - - - - - (event) GpsStatusChanged is raised when the status of GPS is changed. - - - - - (event) BatteryIsCharging is raised when the battery is currently charging. - - - - - (event) TvOutConnected is raised when TV out is connected/disconnected. - - - - - (event) AudioJackConnectorChanged is raised when the audio jack connection changes. - - - - - (event) ChargerConnected is raised when the charger is connected/disconnected. - - - - - (event) AutoRotationEnabled is raised when the system preference for auto rotation is changed. - - - - - RuntimeInfoChangedEventArgs is an extended EventArgs class. This class contains event arguments for runtime event listeners. - - - - - The key indicating the runtime system preference which was changed. - - - - - System Information class. This class has methods which can be used to obtain device information. - - - - - Checks if the type of value for the given feature is T. - - 3 - Type of value for the feature key. - The name of the feature. - True if type of value for the given feature is T, otherwise false. - - - - Checks if the given key is a valid feature. - - 3 - The name of the feature. - True if the key is valid, otherwise false. - - - - Gets the value of the feature. - - 3 - Type of key value. - The name of the feature. - The value of the given feature. - Returns true on success, otherwise false. - - - - Gets the bool value of the feature. - - 3 - The name of the feature. - The value of the given feature. - Returns true on success, otherwise false. - - - - Gets the int value of the feature. - - 3 - The name of the feature. - The value of the given feature. - Returns true on success, otherwise false. - - - - Gets the double value of the feature. - - 3 - The name of the feature. - The value of the given feature. - Returns true on success, otherwise false. - - - - Gets the string value of the feature. - - 3 - The name of the feature. - The value of the given feature. - Returns true on success, otherwise false. - - - + + + + Tizen.System.Information + + + + + The Information class provides functions to obtain various system information. + + + + + Gets the value of the feature. + + 4 + The type of . + The name of the feature. + The value of the given feature. + Returns true on success, otherwise false. + + + + Registers a change event callback for given runtime feature key. + + + This function is only for runtime feature. + + 4 + The name of runtime feature which wants to register callback. + The callback function to subscribe. + Thrown when the is invalid. + Thrown when the feature related is not supported. + + + + Unregisters a change event callback for given runtime feature key. + + + This function is only for runtime feature. + + 4 + The name of runtime feature which wants to unregister callback. + The callback function to unsubscribe. + Thrown when the is invalid. + Thrown when the feature related is not supported. + + + + Indicates whether Bluetooth is enabled. + + + + + Indicates whether Wi-Fi hotspot is enabled. + + + + + Indicates whether Bluetooth tethering is enabled. + + + + + Indicates whether USB tethering is enabled. + + + + + Indicates whether packet data through 3G network is enabled. + + + + + Indicates whether data roaming is enabled. + + + + + Indicates whether vibration is enabled. + + + + + Indicates whether audio jack is connected. + + + + + Indicates the current status of GPS. + + + + + + Indicates whether the battery is currently charging. + + + + + Indicates whether TV out is connected. + + + + + Indicates change in the audio jack connector type. + + + + + + Indicates whether the charger is connected. + + + + + Indicates whether auto rotation is enabled. + + + + + Enumeration for the GPS status. + + + + + The GPS is disabled. + + + + + The GPS is searching for satellites. + + + + + The GPS connection is established. + + + + + Enumeration for the type of audio jack connected. + + + + + The audio jack is not connected. + + + + + The 3-conductor wire is connected. + + + + + The 4-conductor wire is connected. + + + + + RuntimeFeatureStatusChangedEventArgs is an extended EventArgs class. This class contains event arguments for runtime event listeners. + + + + + The key indicating the runtime system preference which was changed. + It includes the prefix "http://" though you don't use for registering callback. + + + + + Validates the data type of the status represented by the runtime key. + Note that this is a generic method. + + The generic type to validate. + The runtime information key for which the status type is validated. + True if the data type matches. + Thrown when the is invalid. + + + + Gets the status of runtime key. + Note that this is a generic method. + + The generic type to return. + The runtime information key for which the current should be read. + The value of the given feature. + Returns true on success, otherwise false. + + + + Registers a change event callback for given key. + + The runtime information key which wants to register callback. + The callback function to subscribe. + Thrown when the is invalid. + Thrown when the feature related is not supported. + + + + Unregisters a change event callback for given key. + + The runtime information key which wants to unregister callback. + The callback function to unsubscribe. + Thrown when the is invalid. + + + This function is for a TV product. It will be removed. + + + + Checks if the type of value for the given feature is T. + + Type of value for the feature key. + The name of the feature. + True if type of value for the given feature is T, otherwise false. + + + + Checks if the given key is a valid feature. + + The name of the feature. + True if the key is valid, otherwise false. + + + + Gets the value of the feature. + + Type of key value. + The name of the feature. + The value of the given feature. + Returns true on success, otherwise false. + + + + Gets the bool value of the feature. + + The name of the feature. + The value of the given feature. + Returns true on success, otherwise false. + + + + Gets the int value of the feature. + + The name of the feature. + The value of the given feature. + Returns true on success, otherwise false. + + + + Gets the double value of the feature. + + The name of the feature. + The value of the given feature. + Returns true on success, otherwise false. + + + + Gets the string value of the feature. + + The name of the feature. + The value of the given feature. + Returns true on success, otherwise false. + + + + The class for CPU usage per process. + + + + + The constructor of ProcessCpuUsage class. + + 4 + List of unique process ids. + http://tizen.org/privilege/systemmonitor + Thrown when the is empty. + Thrown when an I/O error occurs while reading from the system or requesting to the resource management daemon. + Thrown when the memory is not enough to allocate. + Thrown when the caller does not have privilege to use this method. + + + + The number of usage entries. + + 4 + + + + Gets the amount of time this process has been scheduled in user mode. + + 4 + The process id. + The amount of time has been scheduled in user mode (clock ticks). + Thrown when the is invalid. + + + + Gets the amount of time this process has been scheduled in kernel mode. + + 4 + The process id. + The amount of time has been scheduled in kernel mode (clock ticks). + Thrown when the is invalid. + + + + Update the process CPU usage to the latest. + + 4 + List of unique process ids. + http://tizen.org/privilege/systemmonitor + Thrown when the is empty. + Thrown when an I/O error occurs while reading from the system or requesting to the resource management daemon. + Thrown when the memory is not enough to allocate. + Thrown when the caller does not have privilege to use this method. + + + + The class for memory information per process. + + + + + The constructor of ProcessMemoryInformation class. + + 4 + List of unique process ids. + http://tizen.org/privilege/systemmonitor + Thrown when the is empty. + Thrown when an I/O error occurs while reading from the system or requesting to the resource management daemon. + Thrown when the memory is not enough to allocate. + Thrown when the caller does not have privilege to use this method. + + + + The number of usage entries. + + 4 + + + + Gets the virtual memory size of a process. + + 4 + The process id. + The virtual memory size is using (KiB). + Thrown when the is invalid. + + + + Gets the resident set size of a process. + + 4 + The process id. + The resident set size is using (KiB). + Thrown when the is invalid. + + + + Gets the proportional set size of a process. + + 4 + The process id. + The proportional set size is using (KiB). + Thrown when the is invalid. + + + + Gets the size not modified and mapped by other processes of a process. + + 4 + The process id. + The shared clean memory size is using (KiB). + Thrown when the is invalid. + + + + Gets the size modified and mapped by other processes of a process. + + 4 + The process id. + The shared dirty memory size is using (KiB). + Thrown when the is invalid. + + + + Gets the size not modified and available only to that process of a process. + + 4 + The process id. + The private clean memory size is using (KiB). + Thrown when the is invalid. + + + + Gets the size modified and available only to that process of a process. + + 4 + The process id. + The private dirty memory size is using (KiB). + Thrown when the is invalid. + + + + Update the process memory information to the latest. + + 4 + List of unique process ids. + http://tizen.org/privilege/systemmonitor + Thrown when the is empty. + Thrown when an I/O error occurs while reading from the system or requesting to the resource management daemon. + Thrown when the memory is not enough to allocate. + Thrown when the caller does not have privilege to use this method. + + + + The class for system CPU usage. + + + + + The constructor of SystemCpuUsage class. + + 4 + Thrown when an I/O error occurs while reading from the system. + Thrown when this system does not store the current CPU frequency. + + + + Running time of un-niced user processes (Percent). + + 4 + + + + Running time of kernel processes (Percent). + + 4 + + + + Running time of niced user processes (Percent). + + 4 + + + + Time waiting for I/O completion (Percent). + + 4 + + + + The number of processors. + + 4 + + + + Gets the current frequency of the processor. + + 4 + The index (from 0) of the CPU core that you want to know the frequency of. + The current frequency(MHz) of processor. + Thrown when the is invalid. + + + + Gets the max frequency of the processor. + + 4 + The index (from 0) of CPU core that you want to know the frequency of. + The max frequency(MHz) of processor. + Thrown when the is invalid. + + + + Update the system CPU usage to the latest. + + 4 + Thrown when an I/O error occurs while reading from the system. + Thrown when this system does not store the current CPU frequency. + + + + The class for system memory information. + + + + + The constructor of MemoryInformation class. + + 4 + Thrown when an I/O error occurs while reading from the system. + + + + Total memory (KiB). + + 4 + + + + Used memory (KiB). + + 4 + + + + Free memory (KiB). + + 4 + + + + Cache memory (KiB). + + 4 + + + + Swap memory (KiB). + + 4 + + + + Update the system memory information to the latest. + + 4 + Thrown when I/O error occurs while reading from the system. + + +