io.appium.java_client.remote

Interface AndroidMobileCapabilityType

All Superinterfaces:

org.openqa.selenium.remote.CapabilityType

public interface AndroidMobileCapabilityType
extends org.openqa.selenium.remote.CapabilityType

The list of Android-specific capabilities.
Read:
https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/caps.md#android-only

Nested Class Summary

Nested classes/interfaces inherited from interface org.openqa.selenium.remote.CapabilityType

org.openqa.selenium.remote.CapabilityType.ForSeleniumServer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADB_PORT Port used to connect to the ADB server (default 5037).
static java.lang.String	ANDROID_COVERAGE Fully qualified instrumentation class.
static java.lang.String	ANDROID_DEVICE_READY_TIMEOUT Timeout in seconds used to wait for a device to become ready after booting.
static java.lang.String	ANDROID_DEVICE_SOCKET Devtools socket name.
static java.lang.String	ANDROID_INSTALL_TIMEOUT Timeout in milliseconds used to wait for an apk to install to the device.
static java.lang.String	ANDROID_NATURAL_ORIENTATION Allow for correct handling of orientation on landscape-oriented devices.
static java.lang.String	ANDROID_SCREENSHOT_PATH The name of the directory on the device in which the screenshot will be put.
static java.lang.String	APP_ACTIVITY Activity name for the Android activity you want to launch from your package.
static java.lang.String	APP_PACKAGE Java package of the Android app you want to run.
static java.lang.String	APP_WAIT_ACTIVITY Activity name/names, comma separated, for the Android activity you want to wait for.
static java.lang.String	APP_WAIT_DURATION Timeout in milliseconds used to wait for the appWaitActivity to launch (default 20000).
static java.lang.String	APP_WAIT_PACKAGE Java package of the Android app you want to wait for.
static java.lang.String	AUTO_GRANT_PERMISSIONS Have Appium automatically determine which permissions your app requires and grant them to the app on install.
static java.lang.String	AUTO_WEBVIEW_TIMEOUT Amount of time to wait for Webview context to become active, in ms.
static java.lang.String	AVD Name of avd to launch.
static java.lang.String	AVD_ARGS Additional emulator arguments used when launching an avd.
static java.lang.String	AVD_LAUNCH_TIMEOUT How long to wait in milliseconds for an avd to launch and connect to ADB (default 120000).
static java.lang.String	AVD_READY_TIMEOUT How long to wait in milliseconds for an avd to finish its boot animations (default 120000).
static java.lang.String	CHROME_OPTIONS Allows passing chromeOptions capability for ChromeDriver.
static java.lang.String	CHROMEDRIVER_EXECUTABLE The absolute local path to webdriver executable (if Chromium embedder provides its own webdriver, it should be used instead of original chromedriver bundled with Appium).
static java.lang.String	DEVICE_READY_TIMEOUT Timeout in seconds while waiting for device to become ready.
static java.lang.String	DISABLE_ANDROID_WATCHERS Disables android watchers that watch for application not responding and application crash, this will reduce cpu usage on android device/emulator.
static java.lang.String	DONT_STOP_APP_ON_RESET Doesn't stop the process of the app under test, before starting the app using adb.
static java.lang.String	ENABLE_PERFORMANCE_LOGGING Deprecated. move to MobileCapabilityType.ENABLE_PERFORMANCE_LOGGING
static java.lang.String	IGNORE_UNIMPORTANT_VIEWS Calls the setCompressedLayoutHierarchy() uiautomator function.
static java.lang.String	INTENT_ACTION Intent action which will be used to start activity (default android.intent.action.MAIN).
static java.lang.String	INTENT_CATEGORY Intent category which will be used to start activity (default android.intent.category.LAUNCHER).
static java.lang.String	INTENT_FLAGS Flags that will be used to start activity (default 0x10200000).
static java.lang.String	KEY_ALIAS Alias for key.
static java.lang.String	KEY_PASSWORD Password for key.
static java.lang.String	KEYSTORE_PASSWORD Password for custom keystore.
static java.lang.String	KEYSTORE_PATH Path to custom keystore, default ~/.android/debug.keystore.
static java.lang.String	NATIVE_WEB_SCREENSHOT In a web context, use native (adb) method for taking a screenshot, rather than proxying to ChromeDriver, default false.
static java.lang.String	NO_SIGN Skip checking and signing of app with debug keys, will work only with UiAutomator and not with selendroid, default false.
static java.lang.String	OPTIONAL_INTENT_ARGUMENTS Additional intent arguments that will be used to start activity.
static java.lang.String	RECREATE_CHROME_DRIVER_SESSIONS Kill ChromeDriver session when moving to a non-ChromeDriver webview.
static java.lang.String	RESET_KEYBOARD Reset keyboard to its original state, after running Unicode tests with unicodeKeyboard capability.
static java.lang.String	SYSTEM_PORT systemPort used to connect to appium-uiautomator2-server or appium-espresso-driver.
static java.lang.String	UNICODE_KEYBOARD Enable Unicode input, default false.
static java.lang.String	USE_KEYSTORE Use a custom keystore to sign apks, default false.

Fields inherited from interface org.openqa.selenium.remote.CapabilityType

ACCEPT_INSECURE_CERTS, ACCEPT_SSL_CERTS, APPLICATION_NAME, BROWSER_NAME, BROWSER_VERSION, ELEMENT_SCROLL_BEHAVIOR, ENABLE_PERSISTENT_HOVERING, ENABLE_PROFILING_CAPABILITY, HAS_NATIVE_EVENTS, HAS_TOUCHSCREEN, LOGGING_PREFS, OVERLAPPING_CHECK_DISABLED, PAGE_LOAD_STRATEGY, PAGE_LOADING_STRATEGY, PLATFORM, PLATFORM_NAME, PROXY, ROTATABLE, SUPPORTS_ALERTS, SUPPORTS_APPLICATION_CACHE, SUPPORTS_FINDING_BY_CSS, SUPPORTS_JAVASCRIPT, SUPPORTS_LOCATION_CONTEXT, SUPPORTS_NETWORK_CONNECTION, SUPPORTS_SQL_DATABASE, SUPPORTS_WEB_STORAGE, TAKES_SCREENSHOT, UNEXPECTED_ALERT_BEHAVIOUR, UNHANDLED_PROMPT_BEHAVIOUR, VERSION

Field Detail

APP_ACTIVITY

static final java.lang.String APP_ACTIVITY

Activity name for the Android activity you want to launch from your package. This often needs to be preceded by a . (e.g., .MainActivity instead of MainActivity). By default this capability is received from the package manifest (action: android.intent.action.MAIN , category: android.intent.category.LAUNCHER)

See Also:

Constant Field Values

APP_PACKAGE

static final java.lang.String APP_PACKAGE

Java package of the Android app you want to run. By default this capability is received from the package manifest (@package attribute value)

See Also:

Constant Field Values

APP_WAIT_ACTIVITY

static final java.lang.String APP_WAIT_ACTIVITY

Activity name/names, comma separated, for the Android activity you want to wait for. By default the value of this capability is the same as for appActivity. You must set it to the very first focused application activity name in case it is different from the one which is set as appActivity if your capability has appActivity and appPackage. You can also use wildcards (*).

See Also:

Constant Field Values

APP_WAIT_PACKAGE

static final java.lang.String APP_WAIT_PACKAGE

Java package of the Android app you want to wait for. By default the value of this capability is the same as for appActivity

See Also:

Constant Field Values

APP_WAIT_DURATION

static final java.lang.String APP_WAIT_DURATION

Timeout in milliseconds used to wait for the appWaitActivity to launch (default 20000).

See Also:

Constant Field Values

DEVICE_READY_TIMEOUT

static final java.lang.String DEVICE_READY_TIMEOUT

Timeout in seconds while waiting for device to become ready.

See Also:

Constant Field Values

ANDROID_COVERAGE

static final java.lang.String ANDROID_COVERAGE

Fully qualified instrumentation class. Passed to -w in adb shell am instrument -e coverage true -w.

See Also:

Constant Field Values

ENABLE_PERFORMANCE_LOGGING

@Deprecated
static final java.lang.String ENABLE_PERFORMANCE_LOGGING

Deprecated. move to MobileCapabilityType.ENABLE_PERFORMANCE_LOGGING

(Chrome and webview only) Enable Chromedriver's performance logging (default false).

See Also:

Constant Field Values

ANDROID_DEVICE_READY_TIMEOUT

static final java.lang.String ANDROID_DEVICE_READY_TIMEOUT

Timeout in seconds used to wait for a device to become ready after booting.

See Also:

Constant Field Values

ADB_PORT

static final java.lang.String ADB_PORT

Port used to connect to the ADB server (default 5037).

See Also:

Constant Field Values

ANDROID_DEVICE_SOCKET

static final java.lang.String ANDROID_DEVICE_SOCKET

Devtools socket name. Needed only when tested app is a Chromium embedding browser. The socket is open by the browser and Chromedriver connects to it as a devtools client.

See Also:

Constant Field Values

ANDROID_INSTALL_TIMEOUT

static final java.lang.String ANDROID_INSTALL_TIMEOUT

Timeout in milliseconds used to wait for an apk to install to the device. Defaults to `90000`.

See Also:

Constant Field Values

AVD

static final java.lang.String AVD

Name of avd to launch.

See Also:

Constant Field Values

AVD_LAUNCH_TIMEOUT

static final java.lang.String AVD_LAUNCH_TIMEOUT

How long to wait in milliseconds for an avd to launch and connect to ADB (default 120000).

See Also:

Constant Field Values

AVD_READY_TIMEOUT

static final java.lang.String AVD_READY_TIMEOUT

How long to wait in milliseconds for an avd to finish its boot animations (default 120000).

See Also:

Constant Field Values

AVD_ARGS

static final java.lang.String AVD_ARGS

Additional emulator arguments used when launching an avd.

See Also:

Constant Field Values

USE_KEYSTORE

static final java.lang.String USE_KEYSTORE

Use a custom keystore to sign apks, default false.

See Also:

Constant Field Values

KEYSTORE_PATH

static final java.lang.String KEYSTORE_PATH

Path to custom keystore, default ~/.android/debug.keystore.

See Also:

Constant Field Values

KEYSTORE_PASSWORD

static final java.lang.String KEYSTORE_PASSWORD

Password for custom keystore.

See Also:

Constant Field Values

KEY_ALIAS

static final java.lang.String KEY_ALIAS

Alias for key.

See Also:

Constant Field Values

KEY_PASSWORD

static final java.lang.String KEY_PASSWORD

Password for key.

See Also:

Constant Field Values

CHROMEDRIVER_EXECUTABLE

static final java.lang.String CHROMEDRIVER_EXECUTABLE

The absolute local path to webdriver executable (if Chromium embedder provides its own webdriver, it should be used instead of original chromedriver bundled with Appium).

See Also:

Constant Field Values

AUTO_WEBVIEW_TIMEOUT

static final java.lang.String AUTO_WEBVIEW_TIMEOUT

Amount of time to wait for Webview context to become active, in ms. Defaults to 2000.

See Also:

Constant Field Values

INTENT_ACTION

static final java.lang.String INTENT_ACTION

Intent action which will be used to start activity (default android.intent.action.MAIN).

See Also:

Constant Field Values

INTENT_CATEGORY

static final java.lang.String INTENT_CATEGORY

Intent category which will be used to start activity (default android.intent.category.LAUNCHER).

See Also:

Constant Field Values

INTENT_FLAGS

static final java.lang.String INTENT_FLAGS

Flags that will be used to start activity (default 0x10200000).

See Also:

Constant Field Values

OPTIONAL_INTENT_ARGUMENTS

static final java.lang.String OPTIONAL_INTENT_ARGUMENTS

Additional intent arguments that will be used to start activity. See Intent arguments.

See Also:

Constant Field Values

DONT_STOP_APP_ON_RESET

static final java.lang.String DONT_STOP_APP_ON_RESET

Doesn't stop the process of the app under test, before starting the app using adb. If the app under test is created by another anchor app, setting this false, allows the process of the anchor app to be still alive, during the start of the test app using adb. In other words, with dontStopAppOnReset set to true, we will not include the -S flag in the adb shell am start call. With this capability omitted or set to false, we include the -S flag. Default false

See Also:

Constant Field Values

UNICODE_KEYBOARD

static final java.lang.String UNICODE_KEYBOARD

Enable Unicode input, default false.

See Also:

Constant Field Values

RESET_KEYBOARD

static final java.lang.String RESET_KEYBOARD

Reset keyboard to its original state, after running Unicode tests with unicodeKeyboard capability. Ignored if used alone. Default false

See Also:

Constant Field Values

NO_SIGN

static final java.lang.String NO_SIGN

Skip checking and signing of app with debug keys, will work only with UiAutomator and not with selendroid, default false.

See Also:

Constant Field Values

IGNORE_UNIMPORTANT_VIEWS

static final java.lang.String IGNORE_UNIMPORTANT_VIEWS

Calls the setCompressedLayoutHierarchy() uiautomator function. This capability can speed up test execution, since Accessibility commands will run faster ignoring some elements. The ignored elements will not be findable, which is why this capability has also been implemented as a toggle-able setting as well as a capability. Defaults to false.

See Also:

Constant Field Values

DISABLE_ANDROID_WATCHERS

static final java.lang.String DISABLE_ANDROID_WATCHERS

Disables android watchers that watch for application not responding and application crash, this will reduce cpu usage on android device/emulator. This capability will work only with UiAutomator and not with selendroid, default false.

See Also:

Constant Field Values

CHROME_OPTIONS

static final java.lang.String CHROME_OPTIONS

Allows passing chromeOptions capability for ChromeDriver. For more information see chromeOptions.

See Also:

Constant Field Values

RECREATE_CHROME_DRIVER_SESSIONS

static final java.lang.String RECREATE_CHROME_DRIVER_SESSIONS

Kill ChromeDriver session when moving to a non-ChromeDriver webview. Defaults to false

See Also:

Constant Field Values

NATIVE_WEB_SCREENSHOT

static final java.lang.String NATIVE_WEB_SCREENSHOT

In a web context, use native (adb) method for taking a screenshot, rather than proxying to ChromeDriver, default false.

See Also:

Constant Field Values

ANDROID_SCREENSHOT_PATH

static final java.lang.String ANDROID_SCREENSHOT_PATH

The name of the directory on the device in which the screenshot will be put. Defaults to /data/local/tmp.

See Also:

Constant Field Values

AUTO_GRANT_PERMISSIONS

static final java.lang.String AUTO_GRANT_PERMISSIONS

Have Appium automatically determine which permissions your app requires and grant them to the app on install. Defaults to false.

See Also:

Constant Field Values

ANDROID_NATURAL_ORIENTATION

static final java.lang.String ANDROID_NATURAL_ORIENTATION

Allow for correct handling of orientation on landscape-oriented devices. Set to true to basically flip the meaning of PORTRAIT and LANDSCAPE. Defaults to false.

See Also:

Constant Field Values

SYSTEM_PORT

static final java.lang.String SYSTEM_PORT

systemPort used to connect to appium-uiautomator2-server or appium-espresso-driver. The default is 8200 in general and selects one port from 8200 to 8299 for appium-uiautomator2-server, it is 8300 from 8300 to 8399 for appium-espresso-driver. When you run tests in parallel, you must adjust the port to avoid conflicts. Read Parallel Testing Setup Guide for more details.

See Also:

Constant Field Values