Available capabilities

These are the capabilities you can use to interact with the Kobiton API during an automation session.

Capabilities

autoWebview

The webview context to use during the test session. Only available for web testing.

  • Type: boolean

  • Required capabilities: None

  • Optional capabilities: None

Example
capabilities.setCapability("autoWebview", true); // Automatically select the webview context.

app

The app to use during the test session. If the app is not already installed on the device, the value of the second parameter will be used to download and install the app. Only available for app testing.

  • Type: string

  • Required capabilities: None

  • Optional capabilities: None

Example
capabilities.setCapability("app", "kobiton-store:000111"); // Install the app using the Kobiton app repository.
capabilities.setCapability("app", "https://kobiton.docsapp.net/apps/app_id"); // Install the app using a direct download link.

baselineSessionId

Select a baseline session to use for flexCorrect or visualValidation.

Example
capabilities.setCapability("kobiton:baselineSessionId", 0000011); // Select baseline session for flexCorrect or visualValidation by assigning a kobitonSessionId.

browserName

The web browser to use during the test session. Only available for web testing.

  • Type: string

  • Required capabilities: None

  • Optional capabilities: None

Example
capabilities.setCapability("browserName", "safari"); // Use Safari for web testing on iOS.
capabilities.setCapability("browserName", "chrome"); // Use Chrome for web testing on Android.

captureScreenshots

Screenshots will be captured after each test step automatically. They’ll be available in the session overview after the test session.

  • Type: boolean

  • Required capabilities: None

  • Optional capabilities: None

Example
capabilities.setCapability("captureScreenshots", true); // Take a screenshot after each test step.
This is not available for native and hybrid apps, as well as devices on Android 6.0 and earlier.

deviceGroup

The device group within the test session metadata.

  • Type: string

  • Required capabilities: None

  • Optional capabilities: None

Example
capabilities.setCapability("deviceGroup", "ORGANIZATION"); // Assign to the device team.

deviceName

The device name. Assign multiple platform versions using wildcards (*).

  • Type: integer

  • Required capabilities: None

  • Optional capabilities: None

Example
capabilities.setCapability("deviceName", "iPhone 11 Pro"); // Use iPhone 11 Pro as the device name.
capabilities.setCapability("deviceName", "*Pro"); // Use any device name ending with 'Pro'.
capabilities.setCapability("deviceName", "iPhone 11*"); // Use any device name starting with 'iPhone 11'.

deviceOrientation

The starting orientation for the device screen.

  • Type: integer

  • Required capabilities: None

  • Optional capabilities: None

Example
capabilities.setCapability("deviceOrientation", "portrait"); // Set the device's starting orientation to portrait.
capabilities.setCapability("deviceOrientation", "landscape"); // Set the device's starting orientation to landscape.

ensureWebviewsHavePages

Ensures that all WebView elements in the application have loaded their content.

  • Type: boolean

  • Required capabilities: None

  • Optional capabilities: visualValidation

Example
capabilities.setCapability("ensureWebviewsHavePages", true); // Set to true.

flexCorrect

When a script is run on different devices, element selection is autocorrected. For more information, see Add flexCorrect to capabilities.

Example
capabilities.setCapability("kobiton:flexCorrect", true);  // Enable flexCorrect by setting capability to true.

fullReset

Remove all apps installed during the test session. To keep the apps and only remove their app data, use noReset instead.

  • Type: boolean

  • Required capabilities: None

  • Optional capabilities: None

Example
capabilities.setCapability("fullReset", true); // Delete the app and the related data.
This is only available for private and local devices.

groupId

The group ID within the test session metadata.

  • Type: string

  • Required capabilities: None

  • Optional capabilities: None

Example
capabilities.setCapability("groupId", "0011"); // Assign to the Docs Team.

kobitonServerUrl

By default, the user’s default API key and Kobiton server URL are assigned.

  • Type: string

  • Required capabilities: None

  • Optional capabilities: None

Example
String kobitonServerUrl = "https://<name>:<id>@api.kobiton.com/wd/hub"; // Use the default API key to connect the Appium and Kobiton servers.

noReset

Remove all app data from apps installed during the test session. To remove the full app, use fullReset instead.

  • Type: boolean

  • Required capabilities: None

  • Optional capabilities: None

Example
capabilities.setCapability("noReset", false); // Delete just the app data.
This is only available for private and local devices.

sessionDescription

The description of the test session, typically between 50-72 characters, but can be set to any length.

  • Type: string

  • Required capabilities: None

  • Optional capabilities: None

Example
capabilities.setCapability("sessionDescription", "This tests the login feature with biometric authentication."); // Provide the test session description.

sessionName

The name of the test session.

  • Type: string

  • Required capabilities: None

  • Optional capabilities: None

Example
capabilities.setCapability("sessionName", "Automation test session"); // Specify the test session name.

tagName

The tag linked to the test session metadata.

  • Type: string

  • Required capabilities: None

  • Optional capabilities: None

Example
capabilities.setCapability("tagName", "TagName1"); // Assign the tagName.

udid

The device Unique Device Identifier (UDID).

  • Type: string

  • Required capabilities: None

Example
capabilities.setCapability("udid", "01234567-89ab-cdef-0123-456789abcdef"); // Use the device with this UDID.

useConfiguration

The device configuration to use during the test session. Only available for web testing.

  • Type: string

  • Required capabilities: None

  • Optional capabilities: None

Example
capabilities.setCapability("useConfiguration", "kobiton"); // Use this pre-defined configuration for the test session.

visualValidation

Validates UI output across different devices, operating systems, and form factors. For more information, see Add visualValidation to capabilities.

Example
capabilities.setCapability("ensureWebviewsHavePages", true); // Set to true.
capabilities.setCapability("kobiton:visualValidation", true);  // Set to true.