public interface AndroidMobileCapabilityType
extends org.openqa.selenium.remote.CapabilityType
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ADB_EXEC_TIMEOUT
Timeout in milliseconds used to wait for adb command execution.
|
static java.lang.String |
ADB_PORT
Port used to connect to the ADB server (default 5037).
|
static java.lang.String |
ALLOW_TEST_PACKAGES
Allow to install a test package which has
android:testOnly="true" in the manifest. |
static java.lang.String |
ANDROID_COVERAGE
Fully qualified instrumentation class.
|
static java.lang.String |
ANDROID_COVERAGE_END_INTENT
A broadcast action implemented by yourself which is used to dump coverage into file system.
|
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_PATH
The name of the directory on the device in which the apk will be push before install.
|
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_LAUNCH
Initializing the app under test automatically.
|
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 |
BUILD_TOOLS_VERSION
Specify the Android build-tools version to be something different than the default, which is to use the most
recent version.
|
static java.lang.String |
CHROME_OPTIONS
Allows passing chromeOptions capability for ChromeDriver.
|
static java.lang.String |
CHROMEDRIVER_ARGS
An array of arguments to be passed to the chromedriver binary when it's run by Appium.
|
static java.lang.String |
CHROMEDRIVER_CHROME_MAPPING_FILE
The absolute path to a file which maps Chromedriver versions to the minimum Chrome that it supports.
|
static java.lang.String |
CHROMEDRIVER_DISABLE_BUILD_CHECK
Sets the chromedriver flag
--disable-build-check for Chrome webview tests. |
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 |
CHROMEDRIVER_EXECUTABLE_DIR
The absolute path to a directory to look for Chromedriver executables in, for automatic discovery of compatible
Chromedrivers.
|
static java.lang.String |
CHROMEDRIVER_PORT
Numeric port to start Chromedriver on.
|
static java.lang.String |
CHROMEDRIVER_PORTS
A list of valid ports for Appium to use for communication with Chromedrivers.
|
static java.lang.String |
CHROMEDRIVER_USE_SYSTEM_EXECUTABLE
If true, bypasses automatic Chromedriver configuration and uses the version that comes downloaded 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 |
DISABLE_WINDOW_ANIMATION
Set device animation scale zero if the value is
true . |
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.
|
static java.lang.String |
ENFORCE_APP_INSTALL
By default application installation is skipped if newer or the same version of this app is already present on
the device under test.
|
static java.lang.String |
ENSURE_WEBVIEWS_HAVE_PAGES
Whether or not Appium should augment its webview detection with page detection, guaranteeing that any
webview contexts which show up in the context list have active pages.
|
static java.lang.String |
GPS_ENABLED
Toggle gps location provider for emulators before starting the session.
|
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 |
IS_HEADLESS
Set this capability to
true to run the Emulator headless when device display is not needed to be visible. |
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 |
LOCALE_SCRIPT
Sets the locale script.
|
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 |
NETWORK_SPEED
Set the network speed emulation.
|
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 |
REMOTE_ADB_HOST
Optional remote ADB server host.
|
static java.lang.String |
REMOTE_APPS_CACHE_LIMIT
Set the maximum number of remote cached apks which are pushed to the device-under-test's
local storage.
|
static java.lang.String |
RESET_KEYBOARD
Reset keyboard to its original state, after running Unicode tests with
unicodeKeyboard capability.
|
static java.lang.String |
SKIP_DEVICE_INITIALIZATION
Skip device initialization which includes i.a.: installation and running of Settings app or setting of
permissions.
|
static java.lang.String |
SKIP_LOGCAT_CAPTURE
Skips to start capturing logcat.
|
static java.lang.String |
SKIP_UNLOCK
Skips unlock during session creation.
|
static java.lang.String |
SYSTEM_PORT
|
static java.lang.String |
UNICODE_KEYBOARD
Enable Unicode input, default false.
|
static java.lang.String |
UNINSTALL_OTHER_PACKAGES
A package, list of packages or * to uninstall package/s before installing apks for test.
|
static java.lang.String |
UNLOCK_KEY
A key pattern to unlock used by
unlockType . |
static java.lang.String |
UNLOCK_TYPE
Unlock the target device with particular lock pattern instead of just waking up the device with a helper app.
|
static java.lang.String |
USE_KEYSTORE
Use a custom keystore to sign apks, default false.
|
static java.lang.String |
WEBVIEW_DEVTOOLS_PORT
To support the `ensureWebviewsHavePages` feature, it is necessary to open a TCP port for communication with
the webview on the device under test.
|
static final java.lang.String APP_ACTIVITY
.
(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)static final java.lang.String APP_PACKAGE
static final java.lang.String APP_WAIT_ACTIVITY
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 (*
).static final java.lang.String APP_WAIT_PACKAGE
appActivity
static final java.lang.String APP_WAIT_DURATION
static final java.lang.String DEVICE_READY_TIMEOUT
static final java.lang.String ALLOW_TEST_PACKAGES
android:testOnly="true"
in the manifest.
false
by defaultstatic final java.lang.String ANDROID_COVERAGE
static final java.lang.String ANDROID_COVERAGE_END_INTENT
@Deprecated static final java.lang.String ENABLE_PERFORMANCE_LOGGING
MobileCapabilityType.ENABLE_PERFORMANCE_LOGGING
static final java.lang.String ANDROID_DEVICE_READY_TIMEOUT
static final java.lang.String ADB_PORT
static final java.lang.String ANDROID_DEVICE_SOCKET
static final java.lang.String ANDROID_INSTALL_TIMEOUT
static final java.lang.String ANDROID_INSTALL_PATH
/data/local/tmp
static final java.lang.String AVD
static final java.lang.String AVD_LAUNCH_TIMEOUT
static final java.lang.String AVD_READY_TIMEOUT
static final java.lang.String AVD_ARGS
static final java.lang.String USE_KEYSTORE
static final java.lang.String KEYSTORE_PATH
static final java.lang.String KEYSTORE_PASSWORD
static final java.lang.String KEY_ALIAS
static final java.lang.String KEY_PASSWORD
static final java.lang.String CHROMEDRIVER_EXECUTABLE
static final java.lang.String CHROMEDRIVER_ARGS
--url-base
, --port
,
--adb-port
, and --log-path
.static final java.lang.String CHROMEDRIVER_EXECUTABLE_DIR
chromedriverUseSystemExecutable
is true
static final java.lang.String CHROMEDRIVER_CHROME_MAPPING_FILE
chromedriverUseSystemExecutable
is true
static final java.lang.String CHROMEDRIVER_USE_SYSTEM_EXECUTABLE
chromedriverExecutable
is set. Defaults to false
static final java.lang.String CHROMEDRIVER_PORT
static final java.lang.String CHROMEDRIVER_PORTS
static final java.lang.String CHROMEDRIVER_DISABLE_BUILD_CHECK
--disable-build-check
for Chrome webview tests.static final java.lang.String AUTO_WEBVIEW_TIMEOUT
static final java.lang.String INTENT_ACTION
static final java.lang.String INTENT_CATEGORY
static final java.lang.String INTENT_FLAGS
static final java.lang.String OPTIONAL_INTENT_ARGUMENTS
static final java.lang.String DONT_STOP_APP_ON_RESET
static final java.lang.String UNICODE_KEYBOARD
static final java.lang.String RESET_KEYBOARD
static final java.lang.String NO_SIGN
static final java.lang.String IGNORE_UNIMPORTANT_VIEWS
static final java.lang.String DISABLE_ANDROID_WATCHERS
static final java.lang.String CHROME_OPTIONS
static final java.lang.String RECREATE_CHROME_DRIVER_SESSIONS
static final java.lang.String NATIVE_WEB_SCREENSHOT
static final java.lang.String ANDROID_SCREENSHOT_PATH
static final java.lang.String NETWORK_SPEED
full
static final java.lang.String GPS_ENABLED
static final java.lang.String IS_HEADLESS
true
to run the Emulator headless when device display is not needed to be visible.
false
is the default value. isHeadless is also support for iOS, check XCUITest-specific capabilities.static final java.lang.String ADB_EXEC_TIMEOUT
20000
static final java.lang.String LOCALE_SCRIPT
static final java.lang.String SKIP_DEVICE_INITIALIZATION
false
static final java.lang.String AUTO_GRANT_PERMISSIONS
false
. If noReset is true
, this capability doesn't
work.static final java.lang.String ANDROID_NATURAL_ORIENTATION
true
to basically flip the meaning of PORTRAIT
and LANDSCAPE
.
Defaults to false
.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.static final java.lang.String REMOTE_ADB_HOST
static final java.lang.String SKIP_UNLOCK
false
static final java.lang.String UNLOCK_TYPE
unlockKey
capability. Defaults to undefined. fingerprint
is available only for
Android 6.0+ and emulators.
Read unlock doc in
android driver.static final java.lang.String UNLOCK_KEY
unlockType
.static final java.lang.String AUTO_LAUNCH
false
. Defaults to true
static final java.lang.String SKIP_LOGCAT_CAPTURE
false
.static final java.lang.String UNINSTALL_OTHER_PACKAGES
'*'
uninstall all of thrid-party packages except for packages which is necessary for Appium to test such
as io.appium.settings
or io.appium.uiautomator2.server
since Appium already contains the logic to
manage them.static final java.lang.String DISABLE_WINDOW_ANIMATION
true
. After session is complete, Appium restores the
animation scale to it's original value. Defaults to false
static final java.lang.String BUILD_TOOLS_VERSION
static final java.lang.String ENFORCE_APP_INSTALL
true
will enforce Appium to always install the current
application build independently of the currently installed version of it. Defaults to false
.static final java.lang.String ENSURE_WEBVIEWS_HAVE_PAGES
false
.static final java.lang.String WEBVIEW_DEVTOOLS_PORT
9222
,
in case multiple sessions are running simultaneously (to avoid port clash), or in case the default port
is not appropriate for your system.static final java.lang.String REMOTE_APPS_CACHE_LIMIT
0
to disable caching. Defaults to 10
.