Web Specific Capabilities

apiKey

32-character alphanumeric string

Required

A security parameter that allows users to provide a unique authentication key or token necessary to access and interact with specific services or resources. This capability is crucial for secure access and authorization when working with external APIs, services, or protected data. The API key is available in the My Account view.

appiumVersion

String

Optional [mobiles only]

Available in BitBar Public Cloud, BitBar Private Cloud, and BitBar Enterprise, empowers you to connect to an older version of the Appium server when the need arises. This ensures compatibility and flexibility in your testing setup. Default value: 2.0.

description

String

Optional

Enables you to provide a project description. For example, My first Appium project at BitBar.

device

String

Required [mobiles only]

The distinctive identifier assigned to a device within BitBar.

Alternatively, you can employ a script to search for devices based on specific properties, such as using a Python script as an example.

When you use the device capability together with deviceGroupId capability, the deviceGroupId takes precedence over the device capability.

deviceGroupId

Integer

Optional

The capability enables you to initiate a session with a single free device randomly chosen from a specific device group. For example, by indicating 4129 as the device group ID, you can ensure that your session starts with a random free device from that specific group. When you use the deviceGroupID capability along with device or findDevice capability, it takes precedence over them.

findDevice

Boolean

Optional [mobiles only]

Determines how a system selects a device based on the provided name. When set to False, the system picks the device that matches the device name provided by the user. When set to True, the system selects the device based on lexical similarity to the user's input. For instance, if the user inputs iPhone, and there are devices named iPhone 11 and Samsung Galaxy, the system will likely choose the iPhone 11 because it's a closer match.

When you use the findDevice capability together with deviceGroupId capability, the deviceGroupId takes precedence over the findDevice capability.

frameworkId

Integer

Optional

Available in BitBar Public Cloud, BitBar Private Cloud, and BitBar Enterprise, provides users the flexibility to utilize a testing framework other than the default. This feature is particularly useful for Private Cloud users managing various projects with different framework configurations. The default value is set to the default framework ID (for example, 42), but this capability empowers users to tailor their testing setup to their specific project needs.

hookURL

URL

Optional

Defines the endpoint, for which the REST call will be executed after the test finishes.

idleTimeout

Integer

Optional

Designates the maximum duration of inactivity in seconds that a test session or automation framework will allow before automatically ending the session. This capability ensures efficient resource management by terminating idle sessions to free up resources for other tasks.

locale

String

Optional [mobiles only]

The specific device language, recognized by the Locale ID from the java.util.Locale class. It is used to configure and adapt the software to the language and regional preferences of the device's user. Default value: EN. For example, fi_FI.

multiSessionWait

Integer

Optional

Specifies the waiting duration in seconds (maximum 60) that the broker should wait for a new Appium session after the last call to driver.quit(). It provides the flexibility for users to invoke driver.quit() within their tests and initiate a new Appium test using the same broker session and device. The default value is set to 0, indicating immediate session transition if not otherwise configured.

osVersion

String

Optional [desktops only]

Defines the target device's operating system (OS) version for testing, ensuring compatibility and accuracy with the specified OS version during test execution.

project

String

Optional

The project name that will be displayed on the Web UI. If none is provided, the Cloud sets a Project X name to your run. For example, Appium iOS Project.

resolution

String

Optional [desktops only]

Specifies the screen's dimensions, usually expressed as width and height (for example, 1920x1080). It enables users to adjust tests for different display sizes and ensures consistent rendering across devices.

testName

String

Optional

Provides a user-defined name or identifier for a specific test within a testing environment. It allows testers to label and distinguish individual tests, making it easier to track and identify test results, especially in cases involving multiple tests or test suites.

testrun

String

Optional

The user-provided name for each test run within a project. If a name is not specified, the Cloud service assigns a default name. For example, Test Run 1.

testTimeout

Integer

Optional

Defines the maximum duration, in seconds, that is allowed for the complete execution of a test. This timeout is adjustable for users with an active plan or subscription and helps ensure that test execution does not exceed a specified time limit. Default value: 1800. Java: capabilities.SetCapability("bitbar:options", "{ 'testTimeout': '1800' }");

timezone

String

Optional

Enables users to define the specific time zone for a test, ensuring accurate testing under the chosen geographical time zone. This is particularly important for scenarios where time-related factors play a key role.

browserVersion

String

Optional

Specifies the browser version to run the test on. If not specified, the latest stable supported version will be used. You can also use latest, latest-1, latest-2, and so on to test the selected latest versions of the specified browser. There are also latest_beta or beta  which result in running the latest beta version of the browser if available.