Supported Appium capabilities

Specifies thePerfectorepository path to anIPA (for iOS) or an APK, APKS, or AAB file (for Android). For virtual devices, this is a ZIP file (for iOS) or an APK or APKS file (for Android).

Incompatible with browserName.

Specifies which Appium version to use when initializing a device. You may also switch between versions during test execution.

Version numbers are only valid if they are installed on the HSS (such as 1.18.3 or 1.20.2).

If you work with an Appium 2-compliant client, you also need to provide the automationVersion capability. In this case, automationVersion overrides the appiumVersion.

To use this capability, include the following in your tests:

capabilities.setCapability("enableAppiumBehavior", true); // Mandatory
capabilities.setCapability("appiumVersion", appiumVersion);

where the second parameter is of type Java.String object.

capabilities.setCapability("appiumVersion", "latest"); // In order to use the latest appium version installed on the hss

capabilities.setCapability("appiumVersion", "1.18.3"); // Uses a specific appium version, even when older than the default

{noformat}driver.quit();{noformat}

Specifies whether to have Appium install and launch the app automatically.

Specifies the automation engine to use - determines the UIElement Class names identified by the automation engine.

This capability is optional. If not set and the device is running a non-iOS OS, the Appium infrastructure will be used. For iOS devices, refer to this article to determine the infrastructure used.

Use XCUITest if automating iOS 10 or later native applications.

Use PerfectoMobile for the Perfecto object tree (uses generic UIElement classes). Not relevant for virtual devices.

Appium Java client 8 uses a direct connection to the Appium server and therefore cannot work with the following capability: ("automationName", "PerfectoMobile");

With Java client 8 or later, you must add the prefixperfecto: to any non-Appium desired capability.

Specifies the name of the mobile web browser to automate.

Controls the Appium architecture used. See also useAppiumForWeb.

For details, see Benefits of using the new architecture and Prerequisites.

Resets the app state by uninstalling the app. This will also remove the app after the session is complete.

Specifies that the app state should not be reset before this session.

Starts the device in a certain orientation.

When set totrue, instruments the iOS or Android application before it is installed.

To work with hybrid applications, install the iOS/Android application as instrumented.

Selects whether to use the basic behavior of Appium in cases where Perfecto offers alternative behavior (may be expanded in the future with different behaviors):

YES – An element is considered visible if that element's frame is inside the screen frame and the element is hittable.
NO - Default behavior (Perfecto) – An element is considered visible if that element's frame is inside the screen frame.

When re-installing an application, specifies whether all data associated with the application should be deleted and the application will start with a clean slate. When set tofalse, data is not deleted and the updated application continues in the context of the existing data.

Sets the geolocation (the physical location of the device) used for testing the application. This is helpful when your app provides different services or content based on a user's location in the world.

Sets the script report and report folder names.

Specifies whether to generate screenshots for the report only for error conditions. This capability takes priority over thetakesScreenshot capability.

Takes screenshots to display in the report. Relevant only if screenshotOnError is false.

Sets the flow for using objects in Safari/Chrome to match Appium's precise flow. Works in tandem with the enableAppiumBehavior capability.

For details, see Benefits of using the new architecture and Prerequisites.

Specifies the activity name for the Android activity you want to launch from your package. This often needs to be preceded by a . (for example .MainActivity instead ofMainActivity)

Specifies the Java package of the Android app you want to run

Specifies the activity name for the Android activity you want to wait for

Specifies the Java package of the Android app you want to wait for

Specifies the intent action that will be used to start an activity

Specifies the intent category that will be used to start an activity

Specifies the flags that will be used to start activity

Specifies additional intent arguments that will be used to start an activity.

Bundle ID of the app under test. Useful for starting an app on a real device or for using other caps which require the bundle ID during test startup

Arguments to pass to the AUT using instruments

Sets the iOS device language for the duration of the script