UNPKG

appium

Version:
95 lines (63 loc) 3.05 kB
# Get Performance Data Returns the information of the system state which is supported to read as like cpu, memory, network traffic, and battery ## Example Usage ```java // Java List<List<Object>> performanceData = driver.getPerformanceData("my.app.package", "cpuinfo", 5); ``` ```python # Not supported ``` ```javascript // Not supported // Not supported ``` ```ruby # Ruby @driver.get_performance_data package_name: 'io.appium.android.apis', data_type: 'cpuinfo', data_read_timeout: 10 ``` ```php # PHP // TODO PHP sample ``` ```csharp // C# // TODO C# sample ``` ## Support ### Appium Server |Platform|Driver|Platform Versions|Appium Version|Driver Version| |--------|----------------|------|--------------|--------------| | iOS | [XCUITest](/docs/en/drivers/ios-xcuitest.md) | None | None | None | | | [UIAutomation](/docs/en/drivers/ios-uiautomation.md) | None | None | None | | Android | [UiAutomator2](/docs/en/drivers/android-uiautomator2.md) | ?+ | 1.6.0+ | All | | | [UiAutomator](/docs/en/drivers/android-uiautomator.md) | 4.2+ | All | All | | Mac | [Mac](/docs/en/drivers/mac.md) | None | None | None | | Windows | [Windows](/docs/en/drivers/windows.md) | None | None | None | ### Appium Clients |Language|Support|Documentation| |--------|-------|-------------| |[Java](https://github.com/appium/java-client/releases/latest)| All | [appium.github.io](http://appium.github.io/java-client/io/appium/java_client/android/HasSupportedPerformanceDataType.html#getSupportedPerformanceDataTypes--) | |[Python](https://github.com/appium/python-client/releases/latest)| None | | |[Javascript (WebdriverIO)](http://webdriver.io/index.html)| All | | |[Javascript (WD)](https://github.com/admc/wd/releases/latest)| All | | |[Ruby](https://github.com/appium/ruby_lib/releases/latest)| All | [www.rubydoc.info](http://www.rubydoc.info/github/appium/ruby_lib_core/Appium/Android/Device#get_performance_data-instance_method) | |[PHP](https://github.com/appium/php-client/releases/latest)| None | [github.com](https://github.com/appium/php-client/) | |[C#](https://github.com/appium/appium-dotnet-driver/releases/latest)| None | [github.com](https://github.com/appium/appium-dotnet-driver/) | ## HTTP API Specifications ### Endpoint `POST /session/:session_id/appium/getPerformanceData` ### URL Parameters |name|description| |----|-----------| |session_id|ID of the session to route the command to| ### JSON Parameters |name|type|description| |----|----|-----------| | package_name | `string` | The package name of the application | | data_type | `string` | The type of system state which wants to read. It should be one of the supported performance data types. | | data_read_timeout | `number` | The number of attempts to read (optional) | ### Response The information type of the system state which is supported to read as like cpu, memory, network traffic, and battery (`array<string>`) ## See Also * [JSONWP Specification](https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js#L325)