Capabilities Builder - Appium

Accepts App URL returned after uploading an app on the BrowserStack servers or custom_id defined by you to upload an app. Upload the App using REST API.

Set the automation engine to use

String array of uploaded app ids.

Note: Maximum 3 app ids allowed. This capability has to be used along with app capability.

Set the username for authentication.

Allows the user to specify a name for a logical group of builds.

Allows the user to specify a name for a logical group of tests.

Allows the user to specify an identifier for the test run.

Required if you are testing against internal/local servers.

Set this capability if you want to install apps in the middle of the test session.

Required if you want to generate screenshots at various steps in your test.

Required if you want to capture device logs for your test.

Required if you want to capture network logs for your test.

Specify a list of certificate pinned hosts that should bypass BrowserStack MITM proxy while capturing network logs.

List of certificate pinned hosts (Array) or regular expression value matching a list of hosts (String). Check documentation for examples.

Use this capability if you wish to capture network logs only for specific hosts. Traffic for all other remaining hosts will bypass BrowserStack MITM proxy and won’t be captured in network logs.

List of hosts (Array) or regular expression value matching a list of hosts (String). Check documentation for examples

Use this capability to avoid invalid certificate errors while using self-signed certificate to test your app.

Required if you want to capture raw appium logs for your test.

Required if you want to enable video recording during your test.

Required if you want to login to your google account on the devices in order to test the functionalities like Google Pay or Google In-app purchase.

Required if you want to test previously uploaded apps under same custom_id. Acceptable values are '-1', '-2' or so on. This will pick the latest-1 or latest-2 etc. version of your uploaded builds to install on your target device.

Note: 'browserstack.app_version' capability can be used only if you use custom_id or shareable_id in the 'app' capability of your test. If you use app_url in the 'app' capability, Appium will install the app corresponding to the app_url ignoring the browserstack.app_version capability.

Required if you want to simulate the location of the device to a particular GPS location.

Required if you want to test how your app behaves in specific countries.

Required if you want to simulate different network conditions from the list of existing network profiles.

Required if you want to simulate the custom network condition

Set this capability to false if you want to test features like, Push Notifications. Use this capability along with your Enterprise signed app in the app capability. Using this capability will disable resigning of your Enterprise signed 'app' so that you can test features like, push notifications on BrowserStack devices.

Required if you want to configure tests to run on a custom time zone.

Required if you want to disable animations on the device.

Required if you want to use your uploaded images or videos in the test. Upload your custom media on BrowserStack servers using REST API. Use the hashed url returned as a result of the upload in this capability.

BrowerStack triggers BROWSERSTACK_IDLE_TIMEOUT error when a session is left idle for more than 90 seconds. This happens as BrowserStack by default waits for the timeout duration for additional steps or commands to run, if we do not receive any command during that time, the session is stopped, changing the session status to TIMEOUT on the dashboard.

"browserstack.maskCommands": "setValues,getValues"

Specifies a particular mobile device for the test environment.

Use this capability to set the Appium version in your test scripts.

OS you want to test.

Use this capability to specify the OS version of the device.

Set the screen orientation of mobile device.

Required if you want to set the language of the app under test.
Note: This capability will only affect the application under test and not the device.

Required if you want to set locale for iOS and Android.