Desired Capabilities In Appium
LambdaTest provides the capabilities class needed to run your App Automation leveraging Appium Desktop.
Capabilitiesā
Note: Mandatory fields are marked with asterisk *
| KEY | VALUES | CAPABILITY DESCRIPTION |
|---|---|---|
| *user | TYPE: STRING | Your LT username. |
| *accessKey | TYPE: STRING | Your LT Access Key. |
| build | TYPE: STRING DEFAULT: Untitled build=iOS Small Run | You can group your tests like a job containing multiple tests. |
| name | TYPE: STRING DEFAULT: TestID of the Test. Incase the Name is not passed. name=iphone 6 Small Run | Name of your test. |
| project | Will remain blank in case 'project' is not passed in capability. project=Small Run | You can group your builds like a project containing multiple jobs. |
| *deviceName | TYPE: STRING iPhone 13 | Name of the device. |
| *platformName | TYPE: STRING ios | Name of the OS. |
| *platformVersion | TYPE: STRING 14 | OS version. |
| *app | TYPE: STRING app=lt://APP100201061631704657918380 | Accepts App URL returned after uploading an app on the LambdaTest servers. |
| queueTimeout | TYPE: STRING DEFAULT: 600 queueTimeout=300 | This capability can be used to modify the Queue timeout value within a range. queueTimeout Range : 300-900. |
| idleTimeout | TYPE: STRING DEFAULT: 120 idleTimeout=120 | This capability can be used to modify the timeout value. |
| visual | TYPE: BOOLEAN DEFAULT: FALSE visual=TRUE OR visual=FALSE | Command by command screenshots will be recorded at each test step. By default the flag is set as off. Note: test execution time will increase if itās set as ātrueā. |
| video | TYPE: BOOLEAN DEFAULT: TRUE video=TRUE OR video=FALSE | Video recording of the complete screen. |
| devicelog | TYPE: BOOLEAN DEFAULT: FALSE devicelog=TRUE OR devicelog=FALSE | Enable Device logs. |
| network | TYPE: BOOLEAN DEFAULT: FALSE network=TRUE OR network=FALSE | Enable Network logs. |
| deviceOrientation | TYPE: STRING deviceOrientation=portrait OR deviceOrientation=landscape | Change the screen orientation of the device. |
| tunnel | TYPE: BOOLEAN tunnel=TRUE OR tunnel=FALSE | To test local applications with LambdaTest. |
| tunnelName | TYPE: STRING tunnelName=RabbitHole | Name of the tunnel. |
| dedicatedProxy | TYPE: BOOLEAN dedicatedProxy=TRUE OR dedicatedProxy=FALSE | Dedicated Proxy. |
| autoGrantPermissions | TYPE: BOOLEAN autoGrantPermissions=TRUE OR autoGrantPermissions=FALSE | Have Appium automatically determine which permissions your app requires and grant them to the app on install. Defaults to false. If noReset is true, this capability doesn't work. |
| autoDismissAlerts | TYPE: BOOLEAN autoDismissAlerts=TRUE OR autoDismissAlerts=FALSE | [iOS Only] Appium capability to Dismiss alerts/popups on iOS Devices. |
| autoAcceptAlerts | TYPE: BOOLEAN autoAcceptAlerts=TRUE OR autoAcceptAlerts=FALSE | [iOS Only] Appium capability to Accept alerts/popups on iOS Devices. |
| newCommandTimeout | TYPE: STRING 60 | How long (in seconds) Appium will wait for a new command from the client before assuming the client quit and ending the session. |
| language | TYPE: STRING fr | Language to set for iOS (XCUITest driver only) and Android. |
| locale | TYPE: STRING fr_CA, CA | Locale to set for iOS (XCUITest driver only) and Android. fr_CA format for iOS. CA format (country name abbreviation) for Android. |
| noReset | TYPE: BOOLEAN true | Don't reset app state before this session. See here for more details. |
| automationName | TYPE: BOOLEAN DEFAULT: Appium automationName = Appium | Which automation engine to use. Note : Set as False in the App Automation Code, so can't be changed. Appium (default), or UiAutomator2, Espresso, or UiAutomator1 for Android, or XCUITest or Instruments for iOS, or YouiEngine for application built with YouiEngine. |
| eventTimings | TYPE: BOOLEAN DEFAULT: False true | Enable or disable the reporting of the timings for various Appium-internal events (e.g., the start and end of each command, etc.). To enable, use true. The timings are then reported as events property on response to querying the current session. See the event timing docs for the the structure of this response. |
| geoLocation | TYPE: STRING fr | Allows you to simulate mobile behavior from different locations by selecting IP addresses hosted in multiple countries around the world. |
| otherApps | TYPE: ARRAY OF STRINGS DEFAULT: [ ] or Empty Array "otherApps": ["lt://APP1002211081648217405891389", "lt://APP1002211081648217429465823"] | Accepts a list of App URLs returned after uploading an app on the LambdaTest servers. Conditions to be satisfied: 1. App should also be passed if āotherAppsā is passed. 2. Length of app URL array <= 3. 3. At max 3 other apps can be installed. 4. App should not be present inside 'otherApp' array. 5. No duplicated in āotherAppā array." |
| resignApp | TYPE: BOOLEAN DEFAULT: True resignApp = true | 1. By default, if this capability is not passed, your app will be re-signed. 2. You can pass "false" as a capability to prevent your apps from being re-signed. 3. This is only for iOS-specific applications and devices |
| region | TYPE: STRING region = US | 1. By default, it picks the location of the nearest data center. 2. If you would like to change the region of the Data Center manually, you can pass this capability. 3. Currently, only two regions are supported: Europe - "EU" and USA - "US" |
| waitForIdleTimeout | TYPE: BOOLEAN waitForIdleTimeout = 0 | 1. Sets the timeout for waiting for the user interface to go into an idle state before starting a UI Automator action. 2. It changes the timeout of the configuration in UIAutomator and could help to make interaction speed faster. |
Got any questions?
Please reach out at our 24x7 Chat Support or you could also mail us at [email protected].
