This page contains all the capabilities, client commands, and tools that are supported with Appium Server (OSS).
SeeTest Client Commands
Command | Link to docs for Grid | Supported OS | Comments |
---|---|---|---|
installApp | Install | iOS Android | Install the application with given package name/bundle id: driver.installApp("cloud:com.experitest.ExperiBank/.LoginActivity") Install the application with given unique name: driver.installApp("cloud:unqiueName=app_unique_name") Install the application with given release version or build version or both: driver.installApp("cloud:com.experitest.ExperiBank/.LoginActivity:releaseVersion=1.0") driver.installApp("cloud:com.experitest.ExperiBank/.LoginActivity:buildVersion=1234") driver.installApp("cloud:com.experitest.ExperiBank/.LoginActivity:releaseVersion=1.0:buildVersion=1234")
|
Android | keepData: If true, this upgrades the existing application installed without losing its data. driver.installApp("cloud:com.experitest.ExperiBank/.LoginActivity:keepData=true") | ||
report | SeeTest Client - Report | iOS | Adds a step to the generated report. //adds a passed step with message step should be passed driver.executeScript("seetest:client.report(\"step should be passed\",\"true\")"); //adds a failed step with the message step should be failed driver.executeScript("seetest:client.report(\"step should be failed\",\"false\")"); |
launchWithOptions | Launch with Options | iOS | |
setAuthenticationReply | SeeTest Client - SetAuthenticationReply(Reply, Delay) - TouchID | iOS Android | driver.executeScript("seetest:client.setAuthenticationReply(\"Success\",10000)"); |
simulateCapture | SeeTest Client - SimulateCapture | iOS Android | Works only with a URL, not local files. driver.executeScript("seetest:client.simulateCapture(\"<url to file>\")"); |
PerformanceTransactionForApplication | iOS Android | driver.executeScript("seetest:client.startPerformanceTransactionForApllication(\"<app bundle>\",\"<NV profile>\")"); | |
sendKeysWithBT | SendKeysWithBT | iOS Android | driver.executeScript("seetest:client.sendKeysWithBT", "" + Keys.CONTROL+ Keys.ALT + "I"); |
HybridClearCache | SeeTest Client - HybridClearCache | iOS Android | driver.executeScript("seetest:client.hybridClearCache()"); |
startStepGroup since 22.7 | SeeTest Client - StartStepsGroup | iOS Android | driver.executeScript("seetest:client.startStepsGroup", groupName); |
stopStepGroup since 22.7 | SeeTest Client - StopStepsGroup | iOS Android | driver.executeScript("seetest:client.stopStepsGroup"); |
setNetworkConnection since 22.11 | SeeTest Client - setNetworkConnection | Android | driver.executeScript("seetest:client.setNetworkConnection", "<MODE>", true); |
getNetworkConnection since 23.4 | SeeTest Client - getNetworkConnection | Android | driver.executeScript("seetest:client.getNetworkConnection", "<MODE>"); |
addTestProperty since 23.1 | SeeTest Client - addTestProperty | iOS Android | driver.executeScript("seetest:client.addTestProperty", propertyName, propertyValue); |
setLocationPlaybackFile since 23.3 | SeeTest Client - setLocation | iOS Android | Changes the device location according to a series of location points provided by the Csv file in order to mimic the behavior of a location movement. driver.executeScript("seetest:client.setLocationPlaybackFile", "cloud:LocationCsvFile", delay, "LocationProvider"); |
waitForSetLocationEnd since 23.3 | SeeTest Client - setLocation | iOS Android | Specifies the waiting time for setLocationPlaybackFile. driver.executeScript("seetest:client.waitForSetLocationEnd", timeInMilliSec); |
Capabilities
Capability | Link to docs for Grid | Supported OS | Comments |
---|---|---|---|
uniqueName | Application Setup | iOS/Android | User can install and launch an App with a unique name. |
reportDisable (report.disable) | Automated Test Reports | iOS/Android | Use this capability in order to choose if a report would be generated. |
installOnlyForUpdate | Application Setup | iOS/Android | Re-installs app only if an older version already installed on the device. |
buildVersion / releaseVersion / appVersion | Application Setup | iOS/Android | Installs and launches the app by build version/release version |
instrumentApp | Application Setup | iOS/Android | Instrument the application. This is needed for extra capabilities (simulateCapture for example). |
DeviceQuery | Device Setup | iOS/Android | Instead of using "udid" capability User can run queries for cloud devices. |
appiumVersion | Currently supported versions: 1.17.0-p0, 1.17.1-p0, 1.17.1-p1, 1.18.0-p0, 1.18.1-p0, 1.18.2, 1.18.3, 1.19.0, 1.19.1, 1.20.0, 1.20.1, 1.20.2, 1.21.0, 1.22.0, 1.22.1, 1.22.2, 1.22.3 | iOS/Android | Choose the Appium Server version to be used for the execution. |
releaseDevice | Device Setup | iOS/Android | Gives the capability to not release a device after performing driver.quit(); Default: true In case the device is already reserved or uses future reservations when the test starts then releaseDevice capability will not have any effect and the device will not be released. |
dontGoHomeOnQuit | iOS/Android | The device remains in the last left state even after ending the test. Default: false For iOS: In case of starting a new session, launch the app with noReset=true (from appium version 1.22.0 and above) to continue from the same state. | |
commandScreenshot | iOS/Android | In Video Report, takes a screenshot also before and after every action. Default: false |
Code Examples
Replace <server> with the appropriate URL.
- Public Continuous Testing Cloud - https://cloud.seetest.io/wd/hub/.
- Dedicated Continuous Testing Cloud environment - Your own domain. For example: https://company.experitest.com/wd/hub/
- On-premises Continuous Testing Cloud environment - Your designated URL. For example: https://company.com/wd/hub