Skip navigation links
A B C D E F G H I J K L M N O P Q R S T U V W X Y 

A

AbstractOptionCombinedWithPosition<T extends AbstractOptionCombinedWithPosition<T>> - Class in io.appium.java_client.touch.offset
 
AbstractOptionCombinedWithPosition() - Constructor for class io.appium.java_client.touch.offset.AbstractOptionCombinedWithPosition
 
AccessibilityId(String) - Static method in class io.appium.java_client.MobileBy
About Android accessibility https://developer.android.com/intl/ru/training/accessibility/accessible-app.html About iOS accessibility https://developer.apple.com/library/ios/documentation/UIKit/Reference/ UIAccessibilityIdentification_Protocol/index.html
ACTION_DOWN - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
ACTION_MULTIPLE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
ACTION_UP - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
ActionOptions<T extends ActionOptions<T>> - Class in io.appium.java_client.touch
 
ActionOptions() - Constructor for class io.appium.java_client.touch.ActionOptions
 
ActionParameter(String) - Constructor for class io.appium.java_client.TouchAction.ActionParameter
 
ActionParameter(String, ActionOptions) - Constructor for class io.appium.java_client.TouchAction.ActionParameter
 
ActionSupplier<T extends PerformsActions<?>> - Interface in io.appium.java_client.functions
 
ACTIVATE_APP - Static variable in class io.appium.java_client.MobileCommand
 
activateApp(String) - Method in interface io.appium.java_client.InteractsWithApps
Activates the given app if it installed, but not running or if it is running in the background.
activateApp(String, BaseActivateApplicationOptions) - Method in interface io.appium.java_client.InteractsWithApps
Activates the given app if it installed, but not running or if it is running in the background.
activateEngine(String) - Method in interface org.openqa.selenium.WebDriver.ImeHandler
Make an engines that is available (appears on the list returned by getAvailableEngines) active.
activeElement() - Method in interface org.openqa.selenium.WebDriver.TargetLocator
Switches to the element that currently has focus within the document currently "switched to", or the body element if this cannot be detected.
Activity - Class in io.appium.java_client.android
This is a simple POJO class to support the StartsActivity.
Activity(String, String) - Constructor for class io.appium.java_client.android.Activity
A constructor with two mandatory parameters.
ADB_PORT - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Port used to connect to the ADB server (default 5037).
add(TouchAction) - Method in class io.appium.java_client.MultiTouchAction
Add a TouchAction to this multi-touch gesture.
addConnectionHandler(Runnable) - Method in interface io.appium.java_client.ws.CanHandleConnects
Register a new message handler.
addCookie(Cookie) - Method in interface org.openqa.selenium.WebDriver.Options
Add a specific cookie.
addDisconnectionHandler(Runnable) - Method in interface io.appium.java_client.ws.CanHandleDisconnects
Register a new web socket disconnect handler.
addErrorHandler(Consumer<Throwable>) - Method in interface io.appium.java_client.ws.CanHandleErrors
Register a new error handler.
addLogcatConnectionListener(Runnable) - Method in interface io.appium.java_client.android.ListensToLogcatMessages
Adds a new log broadcasting connection handler.
addLogcatDisconnectionListener(Runnable) - Method in interface io.appium.java_client.android.ListensToLogcatMessages
Adds a new log broadcasting disconnection handler.
addLogcatErrorsListener(Consumer<Throwable>) - Method in interface io.appium.java_client.android.ListensToLogcatMessages
Adds a new log broadcasting errors handler.
addLogcatMessagesListener(Consumer<String>) - Method in interface io.appium.java_client.android.ListensToLogcatMessages
Adds a new log messages broadcasting handler.
addMessageHandler(Consumer<T>) - Method in interface io.appium.java_client.ws.CanHandleMessages
Register a new message handler.
addOutPutStream(OutputStream) - Method in class io.appium.java_client.service.local.AppiumDriverLocalService
Adds other output stream which should accept server output data.
addOutPutStreams(List<OutputStream>) - Method in class io.appium.java_client.service.local.AppiumDriverLocalService
Adds other output streams which should accept server output data.
addSyslogConnectionListener(Runnable) - Method in interface io.appium.java_client.ios.ListensToSyslogMessages
Adds a new log broadcasting connection handler.
addSyslogDisconnectionListener(Runnable) - Method in interface io.appium.java_client.ios.ListensToSyslogMessages
Adds a new log broadcasting disconnection handler.
addSyslogErrorsListener(Consumer<Throwable>) - Method in interface io.appium.java_client.ios.ListensToSyslogMessages
Adds a new log broadcasting errors handler.
addSyslogMessagesListener(Consumer<String>) - Method in interface io.appium.java_client.ios.ListensToSyslogMessages
Adds a new log messages broadcasting handler.
afterAlertAccept(WebDriver, Alert) - Method in interface io.appium.java_client.events.api.general.AlertEventListener
This action will be performed each time after Alert.accept().
afterAlertDismiss(WebDriver, Alert) - Method in interface io.appium.java_client.events.api.general.AlertEventListener
This action will be performed each time before Alert.dismiss().
afterAlertSendKeys(WebDriver, Alert, String) - Method in interface io.appium.java_client.events.api.general.AlertEventListener
This action will be performed each time after Alert.sendKeys(String).
afterChangeValueOf(WebElement, WebDriver) - Method in interface io.appium.java_client.events.api.general.ElementEventListener
afterChangeValueOf(WebElement, WebDriver, CharSequence[]) - Method in interface io.appium.java_client.events.api.general.ElementEventListener
afterClickOn(WebElement, WebDriver) - Method in interface io.appium.java_client.events.api.general.ElementEventListener
Called after WebElement.click().
afterFindBy(By, WebElement, WebDriver) - Method in interface io.appium.java_client.events.api.general.SearchingEventListener
afterNavigateBack(WebDriver) - Method in interface io.appium.java_client.events.api.general.NavigationEventListener
Called after navigate().back().
afterNavigateForward(WebDriver) - Method in interface io.appium.java_client.events.api.general.NavigationEventListener
Called after navigate().forward().
afterNavigateRefresh(WebDriver) - Method in interface io.appium.java_client.events.api.general.NavigationEventListener
Called after navigate().refresh().
afterNavigateTo(String, WebDriver) - Method in interface io.appium.java_client.events.api.general.NavigationEventListener
Called after get(String url) respectively navigate().to(String url).
afterRotation(WebDriver, ScreenOrientation) - Method in interface io.appium.java_client.events.api.mobile.RotationEventListener
Called after Rotatable.rotate(ScreenOrientation).
afterScript(String, WebDriver) - Method in interface io.appium.java_client.events.api.general.JavaScriptEventListener
Called after RemoteWebDriver.executeScript(String, Object[]).
afterSwitchingToContext(WebDriver, String) - Method in interface io.appium.java_client.events.api.mobile.ContextEventListener
Called after ContextAware.context(String).
afterSwitchToWindow(String, WebDriver) - Method in interface io.appium.java_client.events.api.general.WindowEventListener
This action will be performed each time after WebDriver.TargetLocator.window(java.lang.String).
afterWindowChangeSize(WebDriver, WebDriver.Window, Dimension) - Method in interface io.appium.java_client.events.api.general.WindowEventListener
This action will be performed each time after WebDriver.Window#setSize(Dimension).
afterWindowIsMaximized(WebDriver, WebDriver.Window) - Method in interface io.appium.java_client.events.api.general.WindowEventListener
This action will be performed each time after WebDriver.Window#maximize().
afterWindowIsMoved(WebDriver, WebDriver.Window, Point) - Method in interface io.appium.java_client.events.api.general.WindowEventListener
This action will be performed each time after WebDriver.Window#setPosition(Point).
AIRPLANE_MODE_MASK - Static variable in class io.appium.java_client.android.connection.ConnectionState
 
alert() - Method in interface org.openqa.selenium.WebDriver.TargetLocator
Switches to the currently active modal dialog for this particular driver instance.
AlertEventListener - Interface in io.appium.java_client.events.api.general
 
alias(String, String) - Method in class io.appium.java_client.remote.AppiumW3CHttpCommandCodec
 
ALLOW_TOUCHID_ENROLL - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Enrolls simulator for touch id.
amendParameters(String, Map<String, ?>) - Method in class io.appium.java_client.remote.AppiumW3CHttpCommandCodec
 
ANDROID - Static variable in interface io.appium.java_client.remote.MobilePlatform
 
ANDROID_COVERAGE - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Fully qualified instrumentation class.
ANDROID_DEVICE_READY_TIMEOUT - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Timeout in seconds used to wait for a device to become ready after booting.
ANDROID_DEVICE_SOCKET - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Devtools socket name.
ANDROID_INSTALL_TIMEOUT - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Timeout in milliseconds used to wait for an apk to install to the device.
ANDROID_NATURAL_ORIENTATION - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Add androidNaturalOrientation capability to allow for correct handling of orientation on landscape-oriented devices.
ANDROID_SCREENSHOT_PATH - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
The name of the directory on the device in which the screenshot will be put.
ANDROID_UIAUTOMATOR2 - Static variable in interface io.appium.java_client.remote.AutomationName
 
AndroidBatteryInfo - Class in io.appium.java_client.android
 
AndroidBatteryInfo(Map<String, Object>) - Constructor for class io.appium.java_client.android.AndroidBatteryInfo
 
AndroidBatteryInfo.BatteryState - Enum in io.appium.java_client.android
 
AndroidBy - Annotation Type in io.appium.java_client.pagefactory
Used to build a complex android automator locator.
AndroidDriver<T extends WebElement> - Class in io.appium.java_client.android
Android driver implementation.
AndroidDriver(HttpCommandExecutor, Capabilities) - Constructor for class io.appium.java_client.android.AndroidDriver
Creates a new instance based on command executor and capabilities.
AndroidDriver(URL, Capabilities) - Constructor for class io.appium.java_client.android.AndroidDriver
Creates a new instance based on Appium server URL and capabilities.
AndroidDriver(URL, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.android.AndroidDriver
Creates a new instance based on Appium server URL, HTTP client factory and capabilities.
AndroidDriver(AppiumDriverLocalService, Capabilities) - Constructor for class io.appium.java_client.android.AndroidDriver
Creates a new instance based on Appium driver local service and capabilities.
AndroidDriver(AppiumDriverLocalService, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.android.AndroidDriver
Creates a new instance based on Appium driver local service, HTTP client factory and capabilities.
AndroidDriver(AppiumServiceBuilder, Capabilities) - Constructor for class io.appium.java_client.android.AndroidDriver
Creates a new instance based on Appium service builder and capabilities.
AndroidDriver(AppiumServiceBuilder, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.android.AndroidDriver
Creates a new instance based on Appium service builder, HTTP client factory and capabilities.
AndroidDriver(HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.android.AndroidDriver
Creates a new instance based on HTTP client factory and capabilities.
AndroidDriver(Capabilities) - Constructor for class io.appium.java_client.android.AndroidDriver
Creates a new instance based on capabilities.
AndroidElement - Class in io.appium.java_client.android
 
AndroidElement() - Constructor for class io.appium.java_client.android.AndroidElement
 
AndroidFindAll - Annotation Type in io.appium.java_client.pagefactory
Used to mark a field on a Page/Screen Object to indicate that lookup should use a series of AndroidBy tags It will then search for all elements that match any criteria.
AndroidFindBy - Annotation Type in io.appium.java_client.pagefactory
Used to mark a field on a Page Object to indicate an alternative mechanism for locating the element or a list of elements.
AndroidFindByAllSet - Annotation Type in io.appium.java_client.pagefactory
Defines set of chained/possible locators.
AndroidFindByChainSet - Annotation Type in io.appium.java_client.pagefactory
Defines set of chained/possible locators.
AndroidFindBys - Annotation Type in io.appium.java_client.pagefactory
Used to mark a field on a Page Object to indicate that lookup should use a series of AndroidBy tags.
AndroidFindBySet - Annotation Type in io.appium.java_client.pagefactory
Defines set of chained/possible locators.
AndroidInstallApplicationOptions - Class in io.appium.java_client.android.appmanagement
 
AndroidInstallApplicationOptions() - Constructor for class io.appium.java_client.android.appmanagement.AndroidInstallApplicationOptions
 
AndroidKey - Enum in io.appium.java_client.android.nativekey
 
AndroidKeyCode - Interface in io.appium.java_client.android
Deprecated.
Use AndroidKey instead
AndroidKeyMetastate - Interface in io.appium.java_client.android
Deprecated.
AndroidMobileCapabilityType - Interface in io.appium.java_client.remote
The list of Android-specific capabilities.
AndroidMobileCommandHelper - Class in io.appium.java_client.android
This util class helps to prepare parameters of Android-specific JSONWP commands.
AndroidMobileCommandHelper() - Constructor for class io.appium.java_client.android.AndroidMobileCommandHelper
 
AndroidRemoveApplicationOptions - Class in io.appium.java_client.android.appmanagement
 
AndroidRemoveApplicationOptions() - Constructor for class io.appium.java_client.android.appmanagement.AndroidRemoveApplicationOptions
 
AndroidServerFlag - Enum in io.appium.java_client.service.local.flags
Here is the list of Android specific server arguments.
AndroidStartScreenRecordingOptions - Class in io.appium.java_client.android
 
AndroidStartScreenRecordingOptions() - Constructor for class io.appium.java_client.android.AndroidStartScreenRecordingOptions
 
AndroidStopScreenRecordingOptions - Class in io.appium.java_client.android
 
AndroidStopScreenRecordingOptions() - Constructor for class io.appium.java_client.android.AndroidStopScreenRecordingOptions
 
AndroidTerminateApplicationOptions - Class in io.appium.java_client.android.appmanagement
 
AndroidTerminateApplicationOptions() - Constructor for class io.appium.java_client.android.appmanagement.AndroidTerminateApplicationOptions
 
AndroidTouchAction - Class in io.appium.java_client.android
 
AndroidTouchAction(PerformsTouchActions) - Constructor for class io.appium.java_client.android.AndroidTouchAction
 
AndroidUIAutomator(String) - Static method in class io.appium.java_client.MobileBy
Read http://developer.android.com/intl/ru/tools/testing-support-library/ index.html#uia-apis
andThen(Function<? super T, ? extends V>) - Method in interface io.appium.java_client.functions.AppiumFunction
 
AnnotatedElementContainer - Class in io.appium.java_client.pagefactory.bys.builder
This is the POJO for the setting/getting of an AnnotatedElement instances.
AnnotatedElementContainer() - Constructor for class io.appium.java_client.pagefactory.bys.builder.AnnotatedElementContainer
 
annotatedElementContainer - Variable in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
APP - Static variable in interface io.appium.java_client.remote.MobileCapabilityType
The absolute local path or remote http URL to an .ipa or .apk file, or a .zip containing one of these.
APP_ACTIVITY - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Activity name for the Android activity you want to launch from your package.
APP_ADDRESS - Static variable in interface io.appium.java_client.remote.YouiEngineCapabilityType
IP address of the app to execute commands against.
APP_NAME - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
The display name of the application under test.
APP_PACKAGE - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Java package of the Android app you want to run.
APP_WAIT_ACTIVITY - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Activity name for the Android activity you want to wait for.
APP_WAIT_DURATION - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Timeout in milliseconds used to wait for the appWaitActivity to launch (default 20000).
APP_WAIT_PACKAGE - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Java package of the Android app you want to wait for.
APPIUM - Static variable in interface io.appium.java_client.remote.AutomationName
 
APPIUM_PATH - Static variable in class io.appium.java_client.service.local.AppiumServiceBuilder
The environmental variable used to define the path to executable appium.js (1.4.x and lower) or main.js (1.5.x and higher).
APPIUM_VERSION - Static variable in interface io.appium.java_client.remote.MobileCapabilityType
Sauce-specific.
AppiumByBuilder - Class in io.appium.java_client.pagefactory.bys.builder
It is the basic handler of Appium-specific page object annotations About the Page Object design pattern please read these documents: - https://code.google.com/p/selenium/wiki/PageObjects - https://code.google.com/p/selenium/wiki/PageFactory
AppiumByBuilder(String, String) - Constructor for class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
AppiumCommandExecutor - Class in io.appium.java_client.remote
 
AppiumCommandExecutor(Map<String, CommandInfo>, DriverService, HttpClient.Factory) - Constructor for class io.appium.java_client.remote.AppiumCommandExecutor
 
AppiumCommandExecutor(Map<String, CommandInfo>, URL, HttpClient.Factory) - Constructor for class io.appium.java_client.remote.AppiumCommandExecutor
 
AppiumCommandExecutor(Map<String, CommandInfo>, URL) - Constructor for class io.appium.java_client.remote.AppiumCommandExecutor
 
AppiumCommandExecutor(Map<String, CommandInfo>, DriverService) - Constructor for class io.appium.java_client.remote.AppiumCommandExecutor
 
AppiumCommandInfo - Class in io.appium.java_client
 
AppiumCommandInfo(String, HttpMethod) - Constructor for class io.appium.java_client.AppiumCommandInfo
It conntains method and URL of the command.
AppiumDriver<T extends WebElement> - Class in io.appium.java_client
Default Appium driver implementation.
AppiumDriver(HttpCommandExecutor, Capabilities) - Constructor for class io.appium.java_client.AppiumDriver
Creates a new instance based on command executor and capabilities.
AppiumDriver(URL, Capabilities) - Constructor for class io.appium.java_client.AppiumDriver
 
AppiumDriver(URL, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.AppiumDriver
 
AppiumDriver(AppiumDriverLocalService, Capabilities) - Constructor for class io.appium.java_client.AppiumDriver
 
AppiumDriver(AppiumDriverLocalService, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.AppiumDriver
 
AppiumDriver(AppiumServiceBuilder, Capabilities) - Constructor for class io.appium.java_client.AppiumDriver
 
AppiumDriver(AppiumServiceBuilder, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.AppiumDriver
 
AppiumDriver(HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.AppiumDriver
 
AppiumDriver(Capabilities) - Constructor for class io.appium.java_client.AppiumDriver
 
AppiumDriverLocalService - Class in io.appium.java_client.service.local
 
AppiumElementLocatorFactory - Class in io.appium.java_client.pagefactory
 
AppiumElementLocatorFactory(SearchContext, Duration, AppiumByBuilder) - Constructor for class io.appium.java_client.pagefactory.AppiumElementLocatorFactory
Creates a new mobile element locator factory.
AppiumExecutionMethod - Class in io.appium.java_client
 
AppiumExecutionMethod(AppiumDriver<?>) - Constructor for class io.appium.java_client.AppiumExecutionMethod
 
AppiumFieldDecorator - Class in io.appium.java_client.pagefactory
Default decorator for use with PageFactory.
AppiumFieldDecorator(SearchContext, Duration) - Constructor for class io.appium.java_client.pagefactory.AppiumFieldDecorator
Creates field decorator based on SearchContext and timeout duration.
AppiumFieldDecorator(SearchContext) - Constructor for class io.appium.java_client.pagefactory.AppiumFieldDecorator
 
AppiumFluentWait<T> - Class in io.appium.java_client
 
AppiumFluentWait(T) - Constructor for class io.appium.java_client.AppiumFluentWait
The input value to pass to the evaluated conditions.
AppiumFluentWait(T, Clock, Sleeper) - Constructor for class io.appium.java_client.AppiumFluentWait
Creates wait object based on input value, clock and sleeper.
AppiumFluentWait.IterationInfo - Class in io.appium.java_client
 
AppiumFunction<F,T> - Interface in io.appium.java_client.functions
This is extended version of Function.
AppiumHttpClientFactory - Class in io.appium.java_client.remote
We must use the customized factory, because the default one inside Selenium has retryOnConnectionFailure set to false which causes unexpected connection issues, for example: https://github.com/appium/java-client/issues/927
AppiumHttpClientFactory() - Constructor for class io.appium.java_client.remote.AppiumHttpClientFactory
 
AppiumHttpClientFactory(Duration, Duration) - Constructor for class io.appium.java_client.remote.AppiumHttpClientFactory
Creates a factory instance for HttpOK client with customized Appium config.
AppiumServerHasNotBeenStartedLocallyException - Exception in io.appium.java_client.service.local
 
AppiumServerHasNotBeenStartedLocallyException(String, Throwable) - Constructor for exception io.appium.java_client.service.local.AppiumServerHasNotBeenStartedLocallyException
 
AppiumServerHasNotBeenStartedLocallyException(String) - Constructor for exception io.appium.java_client.service.local.AppiumServerHasNotBeenStartedLocallyException
 
AppiumServiceBuilder - Class in io.appium.java_client.service.local
 
AppiumServiceBuilder() - Constructor for class io.appium.java_client.service.local.AppiumServiceBuilder
 
AppiumW3CHttpCommandCodec - Class in io.appium.java_client.remote
 
AppiumW3CHttpCommandCodec() - Constructor for class io.appium.java_client.remote.AppiumW3CHttpCommandCodec
This class overrides the built-in Selenium W3C commands codec, since the latter hardcodes many commands in Javascript, which does not work with Appium.
AppiumWebDriverEventListener - Interface in io.appium.java_client.events.api.general
 
ApplicationState - Enum in io.appium.java_client.appmanagement
 
apply(Object) - Method in class io.appium.java_client.internal.JsonToMobileElementConverter
 
assertValidAnnotations() - Method in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
assertValidAnnotations() - Method in class io.appium.java_client.pagefactory.DefaultElementByBuilder
 
AuthenticatesByFinger - Interface in io.appium.java_client.android
 
AUTO_ACCEPT_ALERTS - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Accept all iOS alerts automatically if they pop up.
AUTO_DISMISS_ALERTS - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Dismiss all iOS alerts automatically if they pop up.
AUTO_GRANT_PERMISSIONS - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Have Appium automatically determine which permissions your app requires and grant them to the app on install.
AUTO_WEBVIEW - Static variable in interface io.appium.java_client.remote.MobileCapabilityType
Move directly into Webview context.
AUTO_WEBVIEW_TIMEOUT - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Amount of time to wait for Webview context to become active, in ms.
automation - Variable in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
AUTOMATION_NAME - Static variable in interface io.appium.java_client.remote.MobileCapabilityType
Which automation engine to use.
AutomationName - Interface in io.appium.java_client.remote
 
AVD - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Name of avd to launch.
AVD_ARGS - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Additional emulator arguments used when launching an avd.
AVD_LAUNCH_TIMEOUT - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
How long to wait in milliseconds for an avd to launch and connect to ADB (default 120000).
AVD_READY_TIMEOUT - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
How long to wait in milliseconds for an avd to finish its boot animations (default 120000).

B

BACK - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
BACK - Static variable in interface io.appium.java_client.windows.WindowsKeyCode
 
back() - Method in interface org.openqa.selenium.WebDriver.Navigation
Move back a single "item" in the browser's history.
BACKSPACE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
BaseActivateApplicationOptions<T extends BaseActivateApplicationOptions<T>> - Class in io.appium.java_client.appmanagement
 
BaseActivateApplicationOptions() - Constructor for class io.appium.java_client.appmanagement.BaseActivateApplicationOptions
 
BaseComparisonOptions<T extends BaseComparisonOptions<T>> - Class in io.appium.java_client.imagecomparison
 
BaseComparisonOptions() - Constructor for class io.appium.java_client.imagecomparison.BaseComparisonOptions
 
BaseInstallApplicationOptions<T extends BaseInstallApplicationOptions<T>> - Class in io.appium.java_client.appmanagement
 
BaseInstallApplicationOptions() - Constructor for class io.appium.java_client.appmanagement.BaseInstallApplicationOptions
 
BaseOptions<T extends BaseOptions<T>> - Class in io.appium.java_client.appmanagement
 
BaseOptions() - Constructor for class io.appium.java_client.appmanagement.BaseOptions
 
BaseRemoveApplicationOptions<T extends BaseRemoveApplicationOptions<T>> - Class in io.appium.java_client.appmanagement
 
BaseRemoveApplicationOptions() - Constructor for class io.appium.java_client.appmanagement.BaseRemoveApplicationOptions
 
BaseScreenRecordingOptions<T extends BaseScreenRecordingOptions<T>> - Class in io.appium.java_client.screenrecording
 
BaseScreenRecordingOptions() - Constructor for class io.appium.java_client.screenrecording.BaseScreenRecordingOptions
 
BaseStartScreenRecordingOptions<T extends BaseStartScreenRecordingOptions<T>> - Class in io.appium.java_client.screenrecording
 
BaseStartScreenRecordingOptions() - Constructor for class io.appium.java_client.screenrecording.BaseStartScreenRecordingOptions
 
BaseStopScreenRecordingOptions<T extends BaseStopScreenRecordingOptions<T>> - Class in io.appium.java_client.screenrecording
 
BaseStopScreenRecordingOptions() - Constructor for class io.appium.java_client.screenrecording.BaseStopScreenRecordingOptions
 
BaseTerminateApplicationOptions<T extends BaseTerminateApplicationOptions<T>> - Class in io.appium.java_client.appmanagement
 
BaseTerminateApplicationOptions() - Constructor for class io.appium.java_client.appmanagement.BaseTerminateApplicationOptions
 
BatteryInfo - Class in io.appium.java_client.battery
 
BatteryInfo(Map<String, Object>) - Constructor for class io.appium.java_client.battery.BatteryInfo
 
beforeAlertAccept(WebDriver, Alert) - Method in interface io.appium.java_client.events.api.general.AlertEventListener
This action will be performed each time before Alert.accept().
beforeAlertDismiss(WebDriver, Alert) - Method in interface io.appium.java_client.events.api.general.AlertEventListener
This action will be performed each time after Alert.dismiss().
beforeAlertSendKeys(WebDriver, Alert, String) - Method in interface io.appium.java_client.events.api.general.AlertEventListener
This action will be performed each time before Alert.sendKeys(String).
beforeChangeValueOf(WebElement, WebDriver) - Method in interface io.appium.java_client.events.api.general.ElementEventListener
beforeChangeValueOf(WebElement, WebDriver, CharSequence[]) - Method in interface io.appium.java_client.events.api.general.ElementEventListener
beforeClickOn(WebElement, WebDriver) - Method in interface io.appium.java_client.events.api.general.ElementEventListener
Called before WebElement.click().
beforeFindBy(By, WebElement, WebDriver) - Method in interface io.appium.java_client.events.api.general.SearchingEventListener
beforeNavigateBack(WebDriver) - Method in interface io.appium.java_client.events.api.general.NavigationEventListener
Called before navigate().back().
beforeNavigateForward(WebDriver) - Method in interface io.appium.java_client.events.api.general.NavigationEventListener
Called before navigate().forward().
beforeNavigateRefresh(WebDriver) - Method in interface io.appium.java_client.events.api.general.NavigationEventListener
Called before navigate().refresh().
beforeNavigateTo(String, WebDriver) - Method in interface io.appium.java_client.events.api.general.NavigationEventListener
Called before get(String url) respectively navigate().to(String url).
beforeRotation(WebDriver, ScreenOrientation) - Method in interface io.appium.java_client.events.api.mobile.RotationEventListener
Called before Rotatable.rotate(ScreenOrientation).
beforeScript(String, WebDriver) - Method in interface io.appium.java_client.events.api.general.JavaScriptEventListener
Called before JavascriptExecutor.executeScript(String, Object[]).
beforeSwitchingToContext(WebDriver, String) - Method in interface io.appium.java_client.events.api.mobile.ContextEventListener
Called before ContextAware.context(String).
beforeSwitchToWindow(String, WebDriver) - Method in interface io.appium.java_client.events.api.general.WindowEventListener
This action will be performed each time before WebDriver.TargetLocator.window(java.lang.String).
beforeWindowChangeSize(WebDriver, WebDriver.Window, Dimension) - Method in interface io.appium.java_client.events.api.general.WindowEventListener
This action will be performed each time before WebDriver.Window#setSize(Dimension).
beforeWindowIsMaximized(WebDriver, WebDriver.Window) - Method in interface io.appium.java_client.events.api.general.WindowEventListener
This action will be performed each time before WebDriver.Window#maximize().
beforeWindowIsMoved(WebDriver, WebDriver.Window, Point) - Method in interface io.appium.java_client.events.api.general.WindowEventListener
This action will be performed each time before WebDriver.Window#setPosition(Point).
BROWSER - Static variable in interface io.appium.java_client.remote.MobileBrowserType
 
build() - Method in class io.appium.java_client.android.AndroidStartScreenRecordingOptions
 
build() - Method in class io.appium.java_client.android.appmanagement.AndroidInstallApplicationOptions
 
build() - Method in class io.appium.java_client.android.appmanagement.AndroidRemoveApplicationOptions
 
build() - Method in class io.appium.java_client.android.appmanagement.AndroidTerminateApplicationOptions
 
build() - Method in class io.appium.java_client.android.connection.ConnectionStateBuilder
Builds connection state instance, which is ready to be passed as Appium server parameter.
build() - Method in class io.appium.java_client.android.nativekey.KeyEvent
Builds a map, which is ready to be used by the downstream API.
build() - Method in class io.appium.java_client.appmanagement.BaseOptions
Creates a map based on the provided options.
build() - Method in class io.appium.java_client.imagecomparison.BaseComparisonOptions
Builds a map, which is ready to be passed to the subordinated Appium API.
build() - Method in class io.appium.java_client.imagecomparison.FeaturesMatchingOptions
 
build() - Method in class io.appium.java_client.ios.IOSStartScreenRecordingOptions
 
build() - Method in class io.appium.java_client.ios.touch.IOSPressOptions
 
build() - Method in class io.appium.java_client.screenrecording.BaseScreenRecordingOptions
Builds a map, which is ready to be passed to the subordinated Appium API.
build() - Method in class io.appium.java_client.screenrecording.BaseStartScreenRecordingOptions
 
build() - Method in class io.appium.java_client.screenrecording.ScreenRecordingUploadOptions
Builds a map, which is ready to be passed to the subordinated Appium API.
build() - Method in class io.appium.java_client.touch.ActionOptions
Creates a map based on the provided options.
build() - Method in class io.appium.java_client.touch.LongPressOptions
 
build() - Method in class io.appium.java_client.touch.offset.AbstractOptionCombinedWithPosition
 
build() - Method in class io.appium.java_client.touch.offset.ElementOption
 
build() - Method in class io.appium.java_client.touch.offset.PointOption
 
build() - Method in class io.appium.java_client.touch.TapOptions
 
build() - Method in class io.appium.java_client.touch.WaitOptions
 
buildBy() - Method in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
Defines how to transform given object (field, class, etc) into By class used by webdriver to locate elements.
buildBy() - Method in class io.appium.java_client.pagefactory.DefaultElementByBuilder
 
buildDefaultBy() - Method in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
buildDefaultBy() - Method in class io.appium.java_client.pagefactory.DefaultElementByBuilder
 
buildDefaultBy() - Method in class io.appium.java_client.pagefactory.WidgetByBuilder
 
buildDefaultService() - Static method in class io.appium.java_client.service.local.AppiumDriverLocalService
 
buildMobileNativeBy() - Method in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
buildMobileNativeBy() - Method in class io.appium.java_client.pagefactory.DefaultElementByBuilder
 
buildMobileNativeBy() - Method in class io.appium.java_client.pagefactory.WidgetByBuilder
 
buildService(AppiumServiceBuilder) - Static method in class io.appium.java_client.service.local.AppiumDriverLocalService
 
BUNDLE_ID - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Bundle ID of the app under test.
ByAccessibilityId(String) - Constructor for class io.appium.java_client.MobileBy.ByAccessibilityId
 
ByAll - Class in io.appium.java_client.pagefactory.bys.builder
 
ByAll(By[]) - Constructor for class io.appium.java_client.pagefactory.bys.builder.ByAll
Finds all elements that matches any of the locators in sequence.
ByAndroidUIAutomator(String) - Constructor for class io.appium.java_client.MobileBy.ByAndroidUIAutomator
 
ByChained - Class in io.appium.java_client.pagefactory.bys.builder
 
ByChained(By[]) - Constructor for class io.appium.java_client.pagefactory.bys.builder.ByChained
Finds elements that matches each of the locators in sequence.
ByIosClassChain(String) - Constructor for class io.appium.java_client.MobileBy.ByIosClassChain
 
ByIosNsPredicate(String) - Constructor for class io.appium.java_client.MobileBy.ByIosNsPredicate
 
ByIosUIAutomation(String) - Constructor for class io.appium.java_client.MobileBy.ByIosUIAutomation
 
ByWindowsAutomation(String) - Constructor for class io.appium.java_client.MobileBy.ByWindowsAutomation
 

C

CacheableElementLocatorFactory - Interface in io.appium.java_client.pagefactory.locator
 
CacheableLocator - Interface in io.appium.java_client.pagefactory.locator
 
CALENDAR_FORMAT - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
(Sim-only) Calendar format to set for the iOS Simulator.
CAMERA_FOCUS - Static variable in interface io.appium.java_client.windows.WindowsKeyCode
 
CAMERA_LENS - Static variable in interface io.appium.java_client.windows.WindowsKeyCode
 
CAMERA_SHUTTER - Static variable in interface io.appium.java_client.windows.WindowsKeyCode
 
cancel() - Method in class io.appium.java_client.TouchAction
Cancel this action, if it was partially completed by the performsTouchActions.
CanHandleConnects - Interface in io.appium.java_client.ws
 
CanHandleDisconnects - Interface in io.appium.java_client.ws
 
CanHandleErrors - Interface in io.appium.java_client.ws
 
CanHandleMessages<T> - Interface in io.appium.java_client.ws
 
CanRecordScreen - Interface in io.appium.java_client.screenrecording
 
CHROME - Static variable in interface io.appium.java_client.remote.MobileBrowserType
 
CHROME_OPTIONS - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Allows passing chromeOptions capability for ChromeDriver.
CHROMEDRIVER_EXECUTABLE - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
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).
CHROMIUM - Static variable in interface io.appium.java_client.remote.MobileBrowserType
 
cleanupIdleClients() - Method in class io.appium.java_client.remote.AppiumHttpClientFactory
 
clear() - Method in interface org.openqa.selenium.WebElement
If this element is a text entry element, this will clear the value.
CLEAR_SYSTEM_FILES - Static variable in interface io.appium.java_client.remote.MobileCapabilityType
The desired capability which specifies whether to delete any generated files at the end of a session (see iOS and Android entries for particulars).
clearActions() - Method in class io.appium.java_client.MultiTouchAction
Clears all the existing touch actions and resets the instance to the initial state.
clearOutPutStreams() - Method in class io.appium.java_client.service.local.AppiumDriverLocalService
Remove all existing server output streams.
clearParameters() - Method in class io.appium.java_client.TouchAction
Clears all the existing action parameters and resets the instance to the initial state.
click() - Method in interface org.openqa.selenium.WebElement
Click this element.
ClipboardContentType - Enum in io.appium.java_client.clipboard
 
close() - Method in class io.appium.java_client.remote.NewAppiumSessionPayload
 
close() - Method in interface org.openqa.selenium.WebDriver
Close the current window, quitting the browser if it's the last window currently open.
CLOSE_APP - Static variable in class io.appium.java_client.MobileCommand
 
closeApp() - Method in interface io.appium.java_client.InteractsWithApps
Close the app which was provided in the capabilities at session creation and quits the session.
COMMAND_TIMEOUTS - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Custom timeout(s) in milliseconds for WDA backend commands execution.
CommandExecutionHelper - Class in io.appium.java_client
 
CommandExecutionHelper() - Constructor for class io.appium.java_client.CommandExecutionHelper
 
commandRepository - Static variable in class io.appium.java_client.MobileCommand
 
COMPARE_IMAGES - Static variable in class io.appium.java_client.MobileCommand
 
compareImagesCommand(ComparisonMode, byte[], byte[], BaseComparisonOptions) - Static method in class io.appium.java_client.MobileCommand
Forms a Map of parameters for images comparison.
ComparesImages - Interface in io.appium.java_client
 
ComparisonMode - Enum in io.appium.java_client.imagecomparison
 
ComparisonResult - Class in io.appium.java_client.imagecomparison
 
ComparisonResult(Map<String, Object>) - Constructor for class io.appium.java_client.imagecomparison.ComparisonResult
 
compose(Function<? super V, ? extends F>) - Method in interface io.appium.java_client.functions.AppiumFunction
 
connect(URI) - Method in class io.appium.java_client.ws.StringWebSocketClient
Connects web socket client.
CONNECT_HARDWARE_KEYBOARD - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Set this option to true in order to enable hardware keyboard in Simulator.
ConnectionState - Class in io.appium.java_client.android.connection
 
ConnectionState(long) - Constructor for class io.appium.java_client.android.connection.ConnectionState
 
ConnectionStateBuilder - Class in io.appium.java_client.android.connection
 
ConnectionStateBuilder() - Constructor for class io.appium.java_client.android.connection.ConnectionStateBuilder
Initializes connection state builder with the default value (all off).
ConnectionStateBuilder(long) - Constructor for class io.appium.java_client.android.connection.ConnectionStateBuilder
Initializes connection state builder with the the predefined bit mask.
ConnectionStateBuilder(ConnectionState) - Constructor for class io.appium.java_client.android.connection.ConnectionStateBuilder
Initializes connection state builder with the the predefined bit mask.
ContentMappedBy - Class in io.appium.java_client.pagefactory.bys
 
ContentMappedBy(Map<ContentType, By>) - Constructor for class io.appium.java_client.pagefactory.bys.ContentMappedBy
 
ContentType - Enum in io.appium.java_client.pagefactory.bys
 
context(String) - Method in class io.appium.java_client.AppiumDriver
 
ContextEventListener - Interface in io.appium.java_client.events.api.mobile
 
coordinates - Variable in class io.appium.java_client.touch.offset.PointOption
 
COUNT - Static variable in interface io.appium.java_client.windows.WindowsKeyCode
 
COUNT_MIN - Static variable in interface io.appium.java_client.windows.WindowsKeyCode
 
create(Capabilities) - Static method in class io.appium.java_client.remote.NewAppiumSessionPayload
Creates instance of NewAppiumSessionPayload.
createArgs() - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
 
createBy(Annotation[], HowToUseSelectors) - Static method in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
createClient(URL) - Method in class io.appium.java_client.remote.AppiumHttpClientFactory
 
createDriverService(File, int, ImmutableList<String>, ImmutableMap<String, String>) - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
 
createLocator(Field) - Method in class io.appium.java_client.pagefactory.AppiumElementLocatorFactory
 
createLocator(AnnotatedElement) - Method in class io.appium.java_client.pagefactory.AppiumElementLocatorFactory
 
createLocator(Field) - Method in interface io.appium.java_client.pagefactory.locator.CacheableElementLocatorFactory
 
createLocator(AnnotatedElement) - Method in interface io.appium.java_client.pagefactory.locator.CacheableElementLocatorFactory
 
CURRENT_ACTIVITY - Static variable in class io.appium.java_client.MobileCommand
 
currentActivity() - Method in interface io.appium.java_client.android.StartsActivity
Get the current activity being run on the mobile device.
currentActivityCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the getting of the current activity.
currentPackageCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the getting of the current package.
CUSTOM_SSL_CERT - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Capability to pre-authorize a specific SSL cert in the iOS trust store.

D

DATA_MASK - Static variable in class io.appium.java_client.android.connection.ConnectionState
 
deactivate() - Method in interface org.openqa.selenium.WebDriver.ImeHandler
De-activate IME input (turns off the currently activated engine).
decorate(ClassLoader, Field) - Method in class io.appium.java_client.pagefactory.AppiumFieldDecorator
Decorated page object field.
DEFAULT_ANNOTATION_METHOD_ARGUMENTS - Static variable in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
DEFAULT_APPIUM_PORT - Static variable in class io.appium.java_client.service.local.AppiumServiceBuilder
 
DEFAULT_LOCAL_IP_ADDRESS - Static variable in class io.appium.java_client.service.local.AppiumServiceBuilder
 
DEFAULT_WAITING_TIMEOUT - Static variable in class io.appium.java_client.pagefactory.AppiumFieldDecorator
 
defaultContent() - Method in interface org.openqa.selenium.WebDriver.TargetLocator
Selects either the first frame on the page, or the main document when a page contains iframes.
DefaultElementByBuilder - Class in io.appium.java_client.pagefactory
 
DefaultElementByBuilder(String, String) - Constructor for class io.appium.java_client.pagefactory.DefaultElementByBuilder
 
DEL - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
deleteAllCookies() - Method in interface org.openqa.selenium.WebDriver.Options
Delete all the cookies for the current domain.
deleteC(String) - Static method in class io.appium.java_client.MobileCommand
This methods forms DELETE commands.
deleteCookie(Cookie) - Method in interface org.openqa.selenium.WebDriver.Options
Delete a cookie from the browser's "cookie jar".
deleteCookieNamed(String) - Method in interface org.openqa.selenium.WebDriver.Options
Delete the named cookie from the current domain.
DEVICE_NAME - Static variable in interface io.appium.java_client.remote.MobileCapabilityType
The kind of mobile device or emulator to use.
DEVICE_READY_TIMEOUT - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Timeout in seconds while waiting for device to become ready.
DISABLE_ANDROID_WATCHERS - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Disables android watchers that watch for application not responding and application crash, this will reduce cpu usage on android device/emulator.
DONT_STOP_APP_ON_RESET - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Doesn't stop the process of the app under test, before starting the app using adb.
doubleTap(PointOption) - Method in class io.appium.java_client.ios.IOSTouchAction
Double taps using coordinates.
driver - Variable in class io.appium.java_client.internal.JsonToMobileElementConverter
 
driver - Variable in class io.appium.java_client.pagefactory.interceptors.InterceptorOfASingleElement
 
DriverMobileCommand - Interface in io.appium.java_client
An empty interface defining constants for the standard commands defined in the Mobile JSON wire protocol.
duration - Variable in class io.appium.java_client.touch.LongPressOptions
 
duration - Variable in class io.appium.java_client.touch.WaitOptions
 
DurationBuilder() - Constructor for class io.appium.java_client.pagefactory.WithTimeout.DurationBuilder
 

E

element(WebElement, int, int) - Static method in class io.appium.java_client.touch.offset.ElementOption
This method creates a build instance of the ElementOption.
element(WebElement) - Static method in class io.appium.java_client.touch.offset.ElementOption
This method creates a build instance of the ElementOption.
ElementEventListener - Interface in io.appium.java_client.events.api.general
 
ElementMap - Enum in io.appium.java_client.internal
 
ElementOption - Class in io.appium.java_client.touch.offset
 
ElementOption() - Constructor for class io.appium.java_client.touch.offset.ElementOption
 
ENABLE_PERFORMANCE_LOGGING - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
(Chrome and webview only) Enable Chromedriver's performance logging (default false).
enableBugReport() - Method in class io.appium.java_client.android.AndroidStartScreenRecordingOptions
Makes the recorder to display an additional information on the video overlay, such as a timestamp, that is helpful in videos captured to illustrate bugs.
enableForcedRestart() - Method in class io.appium.java_client.screenrecording.BaseStartScreenRecordingOptions
Whether to ignore the result of previous capture and start a new recording immediately.
END_TEST_COVERAGE - Static variable in class io.appium.java_client.MobileCommand
 
endTestCoverage(String, String) - Method in class io.appium.java_client.android.AndroidDriver
Get test-coverage data.
endTestCoverageCommand(String, String) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the ending of the test coverage.
ENTER - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
ErrorCodesMobile - Class in io.appium.java_client
Defines common error codes for the mobile JSON wire protocol.
ErrorCodesMobile() - Constructor for class io.appium.java_client.ErrorCodesMobile
 
ESPRESSO - Static variable in interface io.appium.java_client.remote.AutomationName
 
EVENT_TIMINGS - Static variable in interface io.appium.java_client.remote.MobileCapabilityType
Enable or disable the reporting of the timings for various Appium-internal events (e.g., the start and end of each command, etc.).
EventFiringObjectFactory - Class in io.appium.java_client.events
 
EventFiringObjectFactory() - Constructor for class io.appium.java_client.events.EventFiringObjectFactory
 
EventFiringWebDriverFactory - Class in io.appium.java_client.events
 
EventFiringWebDriverFactory() - Constructor for class io.appium.java_client.events.EventFiringWebDriverFactory
 
execute(String, Map<String, ?>) - Method in class io.appium.java_client.AppiumExecutionMethod
This method executes a command supported by Appium JSONWP.
execute(ExecutesMethod, Map.Entry<String, Map<String, ?>>) - Static method in class io.appium.java_client.CommandExecutionHelper
 
execute(ExecutesMethod, String) - Static method in class io.appium.java_client.CommandExecutionHelper
 
execute(String, Map<String, ?>) - Method in interface io.appium.java_client.ExecutesMethod
Executes JSONWP command and returns a response.
execute(String) - Method in interface io.appium.java_client.ExecutesMethod
Executes JSONWP command and returns a response.
execute(Command) - Method in class io.appium.java_client.remote.AppiumCommandExecutor
 
ExecutesMethod - Interface in io.appium.java_client
 
ExpectedCondition<T> - Interface in io.appium.java_client.functions
This is extended version of ExpectedCondition.

F

FeatureDetector - Enum in io.appium.java_client.imagecomparison
 
FeaturesMatchingOptions - Class in io.appium.java_client.imagecomparison
 
FeaturesMatchingOptions() - Constructor for class io.appium.java_client.imagecomparison.FeaturesMatchingOptions
 
FeaturesMatchingResult - Class in io.appium.java_client.imagecomparison
 
FeaturesMatchingResult(Map<String, Object>) - Constructor for class io.appium.java_client.imagecomparison.FeaturesMatchingResult
 
fileDetector - Variable in class io.appium.java_client.MobileElement
 
finalize() - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
 
findDefaultExecutable() - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
 
findElement(String, String) - Method in interface io.appium.java_client.FindsByFluentSelector
Method performs the searching for a single element by some selector defined by string and value of the given selector.
findElement(SearchContext) - Method in class io.appium.java_client.MobileBy.ByAccessibilityId
findElement(SearchContext) - Method in class io.appium.java_client.MobileBy.ByAndroidUIAutomator
findElement(SearchContext) - Method in class io.appium.java_client.MobileBy.ByIosClassChain
findElement(SearchContext) - Method in class io.appium.java_client.MobileBy.ByIosNsPredicate
findElement(SearchContext) - Method in class io.appium.java_client.MobileBy.ByIosUIAutomation
findElement(SearchContext) - Method in class io.appium.java_client.MobileBy.ByWindowsAutomation
findElement(SearchContext) - Method in class io.appium.java_client.MobileBy
 
findElement(By) - Method in interface io.appium.java_client.MobileDriver
 
findElement(SearchContext) - Method in class io.appium.java_client.pagefactory.bys.builder.ByAll
 
findElement(SearchContext) - Method in class io.appium.java_client.pagefactory.bys.builder.ByChained
 
findElement(SearchContext) - Method in class io.appium.java_client.pagefactory.bys.ContentMappedBy
 
findElement(By) - Method in class io.appium.java_client.pagefactory.Widget
 
findElement(By) - Method in interface org.openqa.selenium.SearchContext
Find the first WebElement using the given method.
findElement(By) - Method in interface org.openqa.selenium.WebDriver
Find the first WebElement using the given method.
findElement(By) - Method in interface org.openqa.selenium.WebElement
Find the first WebElement using the given method.
findElementByAccessibilityId(String) - Method in interface io.appium.java_client.FindsByAccessibilityId
Method performs the searching for a single element by accessibility ID selector and value of the given selector.
findElementByAndroidUIAutomator(String) - Method in interface io.appium.java_client.FindsByAndroidUIAutomator
Method performs the searching for a single element by Android UIAutomator selector and value of the given selector.
findElementByClassName(String) - Method in interface io.appium.java_client.MobileDriver
 
findElementByClassName(String) - Method in interface org.openqa.selenium.internal.FindsByClassName
 
findElementByCssSelector(String) - Method in interface io.appium.java_client.MobileDriver
 
findElementByCssSelector(String) - Method in interface org.openqa.selenium.internal.FindsByCssSelector
 
findElementById(String) - Method in interface io.appium.java_client.MobileDriver
 
findElementById(String) - Method in interface org.openqa.selenium.internal.FindsById
 
findElementByIosClassChain(String) - Method in interface io.appium.java_client.FindsByIosClassChain
 
findElementByIosNsPredicate(String) - Method in interface io.appium.java_client.FindsByIosNSPredicate
 
findElementByIosUIAutomation(String) - Method in interface io.appium.java_client.FindsByIosUIAutomation
Method performs the searching for a single element by iOS UIAutomation selector and value of the given selector.
findElementByLinkText(String) - Method in interface io.appium.java_client.MobileDriver
 
findElementByLinkText(String) - Method in interface org.openqa.selenium.internal.FindsByLinkText
 
findElementByName(String) - Method in interface io.appium.java_client.MobileDriver
 
findElementByName(String) - Method in interface org.openqa.selenium.internal.FindsByName
 
findElementByPartialLinkText(String) - Method in interface io.appium.java_client.MobileDriver
 
findElementByPartialLinkText(String) - Method in interface org.openqa.selenium.internal.FindsByLinkText
 
findElementByTagName(String) - Method in interface io.appium.java_client.MobileDriver
 
findElementByTagName(String) - Method in interface org.openqa.selenium.internal.FindsByTagName
 
findElementByWindowsUIAutomation(String) - Method in interface io.appium.java_client.FindsByWindowsAutomation
Finds the first of elements that match the Windows UIAutomation selector supplied.
findElementByXPath(String) - Method in interface io.appium.java_client.MobileDriver
 
findElementByXPath(String) - Method in interface org.openqa.selenium.internal.FindsByXPath
 
findElements(By) - Method in class io.appium.java_client.AppiumDriver
 
findElements(String, String) - Method in class io.appium.java_client.AppiumDriver
 
findElements(String, String) - Method in interface io.appium.java_client.FindsByFluentSelector
Method performs the searching for a list of elements by some selector defined by string and value of the given selector.
findElements(SearchContext) - Method in class io.appium.java_client.MobileBy.ByAccessibilityId
findElements(SearchContext) - Method in class io.appium.java_client.MobileBy.ByAndroidUIAutomator
findElements(SearchContext) - Method in class io.appium.java_client.MobileBy.ByIosClassChain
findElements(SearchContext) - Method in class io.appium.java_client.MobileBy.ByIosNsPredicate
findElements(SearchContext) - Method in class io.appium.java_client.MobileBy.ByIosUIAutomation
findElements(SearchContext) - Method in class io.appium.java_client.MobileBy.ByWindowsAutomation
findElements(SearchContext) - Method in class io.appium.java_client.MobileBy
 
findElements(By) - Method in interface io.appium.java_client.MobileDriver
 
findElements(By) - Method in class io.appium.java_client.MobileElement
 
findElements(String, String) - Method in class io.appium.java_client.MobileElement
 
findElements(SearchContext) - Method in class io.appium.java_client.pagefactory.bys.ContentMappedBy
 
findElements(By) - Method in class io.appium.java_client.pagefactory.Widget
 
findElements(By) - Method in interface org.openqa.selenium.SearchContext
Find all elements within the current context using the given mechanism.
findElements(By) - Method in interface org.openqa.selenium.WebDriver
Find all elements within the current page using the given mechanism.
findElements(By) - Method in interface org.openqa.selenium.WebElement
Find all elements within the current context using the given mechanism.
findElementsByAccessibilityId(String) - Method in class io.appium.java_client.AppiumDriver
 
findElementsByAccessibilityId(String) - Method in interface io.appium.java_client.FindsByAccessibilityId
Method performs the searching for a list of elements by accessibility ID selector and value of the given selector.
findElementsByAccessibilityId(String) - Method in class io.appium.java_client.MobileElement
 
findElementsByAndroidUIAutomator(String) - Method in interface io.appium.java_client.FindsByAndroidUIAutomator
Method performs the searching for a list of elements by Android UIAutomator selector and value of the given selector.
findElementsByClassName(String) - Method in class io.appium.java_client.AppiumDriver
 
findElementsByClassName(String) - Method in interface io.appium.java_client.MobileDriver
 
findElementsByClassName(String) - Method in class io.appium.java_client.MobileElement
 
findElementsByClassName(String) - Method in interface org.openqa.selenium.internal.FindsByClassName
 
findElementsByCssSelector(String) - Method in class io.appium.java_client.AppiumDriver
 
findElementsByCssSelector(String) - Method in interface io.appium.java_client.MobileDriver
 
findElementsByCssSelector(String) - Method in class io.appium.java_client.MobileElement
 
findElementsByCssSelector(String) - Method in interface org.openqa.selenium.internal.FindsByCssSelector
 
findElementsById(String) - Method in class io.appium.java_client.AppiumDriver
 
findElementsById(String) - Method in interface io.appium.java_client.MobileDriver
 
findElementsById(String) - Method in class io.appium.java_client.MobileElement
 
findElementsById(String) - Method in interface org.openqa.selenium.internal.FindsById
 
findElementsByIosClassChain(String) - Method in interface io.appium.java_client.FindsByIosClassChain
 
findElementsByIosNsPredicate(String) - Method in interface io.appium.java_client.FindsByIosNSPredicate
 
findElementsByIosUIAutomation(String) - Method in interface io.appium.java_client.FindsByIosUIAutomation
Method performs the searching for a list of elements by iOS UIAutomation selector and value of the given selector.
findElementsByLinkText(String) - Method in class io.appium.java_client.AppiumDriver
 
findElementsByLinkText(String) - Method in interface io.appium.java_client.MobileDriver
 
findElementsByLinkText(String) - Method in class io.appium.java_client.MobileElement
 
findElementsByLinkText(String) - Method in interface org.openqa.selenium.internal.FindsByLinkText
 
findElementsByName(String) - Method in class io.appium.java_client.AppiumDriver
 
findElementsByName(String) - Method in interface io.appium.java_client.MobileDriver
 
findElementsByName(String) - Method in class io.appium.java_client.MobileElement
 
findElementsByName(String) - Method in interface org.openqa.selenium.internal.FindsByName
 
findElementsByPartialLinkText(String) - Method in class io.appium.java_client.AppiumDriver
 
findElementsByPartialLinkText(String) - Method in interface io.appium.java_client.MobileDriver
 
findElementsByPartialLinkText(String) - Method in class io.appium.java_client.MobileElement
 
findElementsByPartialLinkText(String) - Method in interface org.openqa.selenium.internal.FindsByLinkText
 
findElementsByTagName(String) - Method in class io.appium.java_client.AppiumDriver
 
findElementsByTagName(String) - Method in interface io.appium.java_client.MobileDriver
 
findElementsByTagName(String) - Method in class io.appium.java_client.MobileElement
 
findElementsByTagName(String) - Method in interface org.openqa.selenium.internal.FindsByTagName
 
findElementsByWindowsUIAutomation(String) - Method in interface io.appium.java_client.FindsByWindowsAutomation
Finds a list of elements that match the Windows UIAutomation selector supplied.
findElementsByXPath(String) - Method in class io.appium.java_client.AppiumDriver
 
findElementsByXPath(String) - Method in interface io.appium.java_client.MobileDriver
 
findElementsByXPath(String) - Method in class io.appium.java_client.MobileElement
 
findElementsByXPath(String) - Method in interface org.openqa.selenium.internal.FindsByXPath
 
findImageOccurrence(byte[], byte[]) - Method in interface io.appium.java_client.ComparesImages
Performs images matching by template to find possible occurrence of the partial image in the full image with default options.
findImageOccurrence(byte[], byte[], OccurrenceMatchingOptions) - Method in interface io.appium.java_client.ComparesImages
Performs images matching by template to find possible occurrence of the partial image in the full image.
findImageOccurrence(File, File) - Method in interface io.appium.java_client.ComparesImages
Performs images matching by template to find possible occurrence of the partial image in the full image with default options.
findImageOccurrence(File, File, OccurrenceMatchingOptions) - Method in interface io.appium.java_client.ComparesImages
Performs images matching by template to find possible occurrence of the partial image in the full image.
FindsByAccessibilityId<T extends WebElement> - Interface in io.appium.java_client
 
FindsByAndroidUIAutomator<T extends WebElement> - Interface in io.appium.java_client
 
FindsByClassName - Interface in org.openqa.selenium.internal
 
FindsByCssSelector - Interface in org.openqa.selenium.internal
 
FindsByFluentSelector<T extends WebElement> - Interface in io.appium.java_client
 
FindsById - Interface in org.openqa.selenium.internal
 
FindsByIosClassChain<T extends WebElement> - Interface in io.appium.java_client
 
FindsByIosNSPredicate<T extends WebElement> - Interface in io.appium.java_client
 
FindsByIosUIAutomation<T extends WebElement> - Interface in io.appium.java_client
 
FindsByLinkText - Interface in org.openqa.selenium.internal
 
FindsByName - Interface in org.openqa.selenium.internal
 
FindsByTagName - Interface in org.openqa.selenium.internal
 
FindsByWindowsAutomation<T extends WebElement> - Interface in io.appium.java_client
 
FindsByXPath - Interface in org.openqa.selenium.internal
 
FINGER_PRINT - Static variable in class io.appium.java_client.MobileCommand
 
fingerPrint(int) - Method in interface io.appium.java_client.android.AuthenticatesByFinger
Authenticate users by using their finger print scans on supported emulators.
fingerPrintCommand(int) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the finger print authentication invocation.
FIREFOX_OS - Static variable in interface io.appium.java_client.remote.MobilePlatform
 
FLAG_CANCELED - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
FLAG_CANCELED_LONG_PRESS - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
FLAG_EDITOR_ACTION - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
FLAG_FALLBACK - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
FLAG_FROM_SYSTEM - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
FLAG_KEEP_TOUCH_MODE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
FLAG_LONG_PRESS - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
FLAG_SOFT_KEYBOARD - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
FLAG_TRACKING - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
FLAG_VIRTUAL_HARD_KEY - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
FLAG_WOKE_HERE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
FORCE_MJSONWP - Static variable in interface io.appium.java_client.remote.MobileCapabilityType
This is the flag which forces server to switch to the mobile WSONWP.
forward() - Method in interface org.openqa.selenium.WebDriver.Navigation
Move a single "item" forward in the browser's history.
frame(int) - Method in interface org.openqa.selenium.WebDriver.TargetLocator
Select a frame by its (zero-based) index.
frame(String) - Method in interface org.openqa.selenium.WebDriver.TargetLocator
Select a frame by its name or ID.
frame(WebElement) - Method in interface org.openqa.selenium.WebDriver.TargetLocator
Select a frame using its previously located WebElement.
FULL_RESET - Static variable in interface io.appium.java_client.remote.MobileCapabilityType
(iOS) Delete the entire simulator folder.
fullscreen() - Method in interface org.openqa.selenium.WebDriver.Window
Fullscreen the current window if it is not already fullscreen

G

GeneralServerFlag - Enum in io.appium.java_client.service.local.flags
Here is the list of common Appium server arguments.
get(String) - Method in interface org.openqa.selenium.WebDriver
Load a new web page in the current browser window.
GET_CLIPBOARD - Static variable in class io.appium.java_client.MobileCommand
 
GET_CURRENT_PACKAGE - Static variable in class io.appium.java_client.MobileCommand
 
GET_DEVICE_TIME - Static variable in class io.appium.java_client.MobileCommand
 
GET_DISPLAY_DENSITY - Static variable in class io.appium.java_client.MobileCommand
 
GET_NETWORK_CONNECTION - Static variable in class io.appium.java_client.MobileCommand
 
GET_PERFORMANCE_DATA - Static variable in class io.appium.java_client.MobileCommand
 
GET_SESSION - Static variable in class io.appium.java_client.MobileCommand
 
GET_SETTINGS - Static variable in class io.appium.java_client.MobileCommand
 
GET_STRINGS - Static variable in class io.appium.java_client.MobileCommand
 
GET_SUPPORTED_PERFORMANCE_DATA_TYPES - Static variable in class io.appium.java_client.MobileCommand
 
GET_SYSTEM_BARS - Static variable in class io.appium.java_client.MobileCommand
 
getActiveEngine() - Method in interface org.openqa.selenium.WebDriver.ImeHandler
Get the name of the active IME engine.
getAdditionalCommands() - Method in class io.appium.java_client.remote.AppiumCommandExecutor
 
getAnnotated() - Method in class io.appium.java_client.pagefactory.bys.builder.AnnotatedElementContainer
 
getAppActivity() - Method in class io.appium.java_client.android.Activity
Gets the app activity value.
getAppPackage() - Method in class io.appium.java_client.android.Activity
Gets the app package value.
getAppStringMap() - Method in interface io.appium.java_client.HasAppStrings
Get all defined Strings from an app for the default language.
getAppStringMap(String) - Method in interface io.appium.java_client.HasAppStrings
Get all defined Strings from an app for the specified language.
getAppStringMap(String, String) - Method in interface io.appium.java_client.HasAppStrings
Get all defined Strings from an app for the specified language and strings filename.
getAppWaitActivity() - Method in class io.appium.java_client.android.Activity
Gets the app wait activity value.
getAppWaitPackage() - Method in class io.appium.java_client.android.Activity
Gets the app wait package value.
getArgument() - Method in enum io.appium.java_client.service.local.flags.AndroidServerFlag
 
getArgument() - Method in enum io.appium.java_client.service.local.flags.GeneralServerFlag
 
getArgument() - Method in enum io.appium.java_client.service.local.flags.IOSServerFlag
 
getArgument() - Method in interface io.appium.java_client.service.local.flags.ServerArgument
 
getAttribute(String) - Method in interface org.openqa.selenium.WebElement
Get the value of the given attribute of the element.
getAutomationName() - Method in interface io.appium.java_client.HasSessionDetails
The current automation name.
getAvailableEngines() - Method in interface org.openqa.selenium.WebDriver.ImeHandler
All available engines on the machine.
getBatteryInfo() - Method in class io.appium.java_client.android.AndroidDriver
 
getBatteryInfo() - Method in interface io.appium.java_client.battery.HasBattery
Retrieves battery info from the device under test.
getBatteryInfo() - Method in class io.appium.java_client.ios.IOSDriver
 
getBitMask() - Method in class io.appium.java_client.android.connection.ConnectionState
 
getC(String) - Static method in class io.appium.java_client.MobileCommand
This methods forms GET commands.
getCapabilities() - Method in class io.appium.java_client.android.AndroidDriver
Returns capabilities that were provided on instantiation.
getCapabilities() - Method in class io.appium.java_client.ios.IOSDriver
Returns capabilities that were provided on instantiation.
getCenter() - Method in class io.appium.java_client.MobileElement
Method returns central coordinates of an element.
getClient() - Method in class io.appium.java_client.remote.AppiumCommandExecutor
 
getClipboard(ClipboardContentType) - Method in interface io.appium.java_client.clipboard.HasClipboard
Get the content of the clipboard.
getClipboardImage() - Method in interface io.appium.java_client.ios.HasIOSClipboard
Get an image from the clipboard.
getClipboardText() - Method in interface io.appium.java_client.clipboard.HasClipboard
Get the clipboard text.
getClipboardUrl() - Method in interface io.appium.java_client.ios.HasIOSClipboard
Get an URL from the clipboard.
getClock() - Method in class io.appium.java_client.AppiumFluentWait
 
getCode() - Method in enum io.appium.java_client.android.nativekey.AndroidKey
 
getCommandCodec() - Method in class io.appium.java_client.remote.AppiumCommandExecutor
 
getCommandResult() - Method in class io.appium.java_client.imagecomparison.ComparisonResult
 
getComparisonInterval() - Method in class io.appium.java_client.ScreenshotState
Gets the interval value in ms between similarity verification rounds in verify* methods.
getConnection() - Method in interface io.appium.java_client.android.connection.HasNetworkConnection
Get the current network settings of the device.
getConnectionHandlers() - Method in interface io.appium.java_client.ws.CanHandleConnects
Returns a list of all registered web socket connection handlers.
getConnectionHandlers() - Method in class io.appium.java_client.ws.StringWebSocketClient
 
getContext() - Method in class io.appium.java_client.AppiumDriver
 
getContextHandles() - Method in class io.appium.java_client.AppiumDriver
 
getCookieNamed(String) - Method in interface org.openqa.selenium.WebDriver.Options
Get a cookie with a given name.
getCookies() - Method in interface org.openqa.selenium.WebDriver.Options
Get all the cookies for the current domain.
getCount() - Method in class io.appium.java_client.imagecomparison.FeaturesMatchingResult
Returns a count of matched edges on both images.
getCssValue(String) - Method in interface org.openqa.selenium.WebElement
Get the value of a given CSS property.
getCurrentContentType(SearchContext) - Static method in class io.appium.java_client.pagefactory.utils.WebDriverUnpackUtility
Detects content type by the provided search context.
getCurrentPackage() - Method in interface io.appium.java_client.android.StartsActivity
Get the current package being run on the mobile device.
getCurrentScore() - Method in exception io.appium.java_client.ScreenshotState.ScreenshotComparisonTimeout
 
getCurrentUrl() - Method in interface org.openqa.selenium.WebDriver
Get a string representing the current URL that the browser is looking at.
getDeviceTime(String) - Method in interface io.appium.java_client.HasDeviceTime
Gets device date and time for both iOS(host time is returned for simulators) and Android devices.
getDeviceTime() - Method in interface io.appium.java_client.HasDeviceTime
Gets device date and time for both iOS(host time is returned for simulators) and Android devices.
getDisconnectionHandlers() - Method in interface io.appium.java_client.ws.CanHandleDisconnects
Returns a list of all registered web socket disconnection handlers.
getDisconnectionHandlers() - Method in class io.appium.java_client.ws.StringWebSocketClient
 
getDisplayDensity() - Method in interface io.appium.java_client.android.HasAndroidDeviceDetails
 
getDisplayDensityCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters to Retrieve the display density of the Android device.
getElapsed() - Method in class io.appium.java_client.AppiumFluentWait.IterationInfo
The amount of elapsed time.
getElementClass() - Method in enum io.appium.java_client.internal.ElementMap
 
getElementClass(String, String) - Static method in enum io.appium.java_client.internal.ElementMap
Gets element class by platform and mobile automation type.
getEndpoint() - Method in class io.appium.java_client.ws.StringWebSocketClient
 
getEnhancedProxy(Class<T>, MethodInterceptor) - Static method in class io.appium.java_client.pagefactory.utils.ProxyFactory
 
getEnhancedProxy(Class<T>, Class<?>[], Object[], MethodInterceptor) - Static method in class io.appium.java_client.pagefactory.utils.ProxyFactory
It returns some proxies created by CGLIB.
getErrorHandlers() - Method in interface io.appium.java_client.ws.CanHandleErrors
Returns a list of all registered web socket error handlers.
getErrorHandlers() - Method in class io.appium.java_client.ws.StringWebSocketClient
 
getEventFiringObject(T, WebDriver, Collection<Listener>) - Static method in class io.appium.java_client.events.EventFiringObjectFactory
This method makes an event firing object.
getEventFiringObject(T, WebDriver) - Static method in class io.appium.java_client.events.EventFiringObjectFactory
This method makes an event firing object.
getEventFiringObject(T, WebDriver, Listener...) - Static method in class io.appium.java_client.events.EventFiringObjectFactory
This method makes an event firing object.
getEventFiringWebDriver(T) - Static method in class io.appium.java_client.events.EventFiringWebDriverFactory
This method makes an event firing instance of WebDriver.
getEventFiringWebDriver(T, Listener...) - Static method in class io.appium.java_client.events.EventFiringWebDriverFactory
This method makes an event firing instance of WebDriver.
getEventFiringWebDriver(T, Collection<Listener>) - Static method in class io.appium.java_client.events.EventFiringWebDriverFactory
This method makes an event firing instance of WebDriver.
getExceptionType(int) - Method in class io.appium.java_client.ErrorCodesMobile
Returns the exception type that corresponds to the given statusCode.
getExceptionType(String) - Method in class io.appium.java_client.ErrorCodesMobile
Returns the exception type that corresponds to the given messageor null if there are no matching mobile exceptions.
getExecuteMethod() - Method in class io.appium.java_client.AppiumDriver
 
getIgnoredExceptions() - Method in class io.appium.java_client.AppiumFluentWait
 
getImagesSimilarity(byte[], byte[]) - Method in interface io.appium.java_client.ComparesImages
Performs images matching to calculate the similarity score between them with default options.
getImagesSimilarity(byte[], byte[], SimilarityMatchingOptions) - Method in interface io.appium.java_client.ComparesImages
Performs images matching to calculate the similarity score between them.
getImagesSimilarity(File, File) - Method in interface io.appium.java_client.ComparesImages
Performs images matching to calculate the similarity score between them with default options.
getImagesSimilarity(File, File, SimilarityMatchingOptions) - Method in interface io.appium.java_client.ComparesImages
Performs images matching to calculate the similarity score between them.
getInput() - Method in class io.appium.java_client.AppiumFluentWait
 
getInput() - Method in class io.appium.java_client.battery.BatteryInfo
 
getIntentAction() - Method in class io.appium.java_client.android.Activity
Gets the intent action value.
getIntentCategory() - Method in class io.appium.java_client.android.Activity
Gets the intent category value.
getIntentFlags() - Method in class io.appium.java_client.android.Activity
Gets the intent flags value.
getInterval() - Method in class io.appium.java_client.AppiumFluentWait
 
getInterval() - Method in class io.appium.java_client.AppiumFluentWait.IterationInfo
The current interval.
getIsDeviceLockedCommand() - Static method in class io.appium.java_client.MobileCommand
This method forms a Map of parameters for the device locked query.
getLevel() - Method in class io.appium.java_client.battery.BatteryInfo
Returns battery level.
getLocation() - Method in interface org.openqa.selenium.WebElement
Where on the page is the top left-hand corner of the rendered element?
getLocatorString() - Method in class io.appium.java_client.MobileBy
 
getLogcatClient() - Method in class io.appium.java_client.android.AndroidDriver
 
getLogcatClient() - Method in interface io.appium.java_client.android.ListensToLogcatMessages
 
getMessageHandlers() - Method in interface io.appium.java_client.ws.CanHandleMessages
Returns a list of all registered web socket messages handlers.
getMessageHandlers() - Method in class io.appium.java_client.ws.StringWebSocketClient
 
getMessageSupplier() - Method in class io.appium.java_client.AppiumFluentWait
 
getMethod() - Method in class io.appium.java_client.AppiumCommandInfo
 
getNetworkConnectionCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the getting of a network connection value.
getNumber() - Method in class io.appium.java_client.AppiumFluentWait.IterationInfo
The current iteration number.
getObject(List<WebElement>, Method, Object[]) - Method in class io.appium.java_client.pagefactory.interceptors.InterceptorOfAListOfElements
 
getObject(WebElement, Method, Object[]) - Method in class io.appium.java_client.pagefactory.interceptors.InterceptorOfASingleElement
 
getOptionalIntentArguments() - Method in class io.appium.java_client.android.Activity
Gets the optional intent arguments value.
getOrientation() - Method in class io.appium.java_client.AppiumDriver
 
getOverlapScore(BufferedImage, BufferedImage) - Static method in class io.appium.java_client.ScreenshotState
A shortcut to ScreenshotState.getOverlapScore(BufferedImage, BufferedImage, ResizeMode) method for the case if both reference and template images are expected to have the same dimensions.
getOverlapScore(BufferedImage, BufferedImage, ScreenshotState.ResizeMode) - Static method in class io.appium.java_client.ScreenshotState
Compares two valid java bitmaps and calculates similarity score between them.
getPageSource() - Method in interface org.openqa.selenium.WebDriver
Get the source of the last loaded page.
getParameterMap() - Method in class io.appium.java_client.TouchAction.ActionParameter
 
getParameters() - Method in class io.appium.java_client.MultiTouchAction
 
getParameters() - Method in class io.appium.java_client.TouchAction
Get the mjsonwp parameters for this Action.
getPerformanceData(String, String, int) - Method in interface io.appium.java_client.android.HasSupportedPerformanceDataType
returns the resource usage information of the application. the resource is one of the system state which means cpu, memory, network traffic, and battery.
getPerformanceDataCommand(String, String, int) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
returns the resource usage information of the application. the resource is one of the system state which means cpu, memory, network traffic, and battery.
getPlatformName() - Method in interface io.appium.java_client.HasSessionDetails
The current mobile platform.
getPlatformOrAutomation() - Method in enum io.appium.java_client.internal.ElementMap
 
getPoints1() - Method in class io.appium.java_client.imagecomparison.FeaturesMatchingResult
Returns a list of matching points on the first image.
getPoints2() - Method in class io.appium.java_client.imagecomparison.FeaturesMatchingResult
Returns a list of matching points on the second image.
getPosition() - Method in interface org.openqa.selenium.WebDriver.Window
Get the position of the current window, relative to the upper left corner of the screen.
getPrivateFieldValue(String, Class<B>) - Method in class io.appium.java_client.remote.AppiumCommandExecutor
 
getRect() - Method in class io.appium.java_client.imagecomparison.OccurrenceMatchingResult
Returns rectangle of partial image occurrence.
getRect() - Method in interface org.openqa.selenium.WebElement
 
getRect1() - Method in class io.appium.java_client.imagecomparison.FeaturesMatchingResult
Returns a rect for the `points1` list.
getRect2() - Method in class io.appium.java_client.imagecomparison.FeaturesMatchingResult
Returns a rect for the `points2` list.
getRemoteAddress() - Method in class io.appium.java_client.AppiumDriver
 
getScore() - Method in class io.appium.java_client.imagecomparison.SimilarityMatchingResult
Returns the similarity score as a float number in range [0.0, 1.0].
getSelfReference() - Method in class io.appium.java_client.pagefactory.Widget
 
getSessionDetail(String) - Method in interface io.appium.java_client.HasSessionDetails
 
getSessionDetails() - Method in interface io.appium.java_client.HasSessionDetails
The current session details.
getSettings() - Method in interface io.appium.java_client.HasSettings
Get settings stored for this test session It's probably better to use a convenience function, rather than use this function directly.
getSettingsCommand() - Static method in class io.appium.java_client.MobileCommand
 
getSize() - Method in interface org.openqa.selenium.WebDriver.Window
Get the size of the current window.
getSize() - Method in interface org.openqa.selenium.WebElement
What is the width and height of the rendered element?
getSleeper() - Method in class io.appium.java_client.AppiumFluentWait
 
getState() - Method in class io.appium.java_client.android.AndroidBatteryInfo
 
getState() - Method in class io.appium.java_client.battery.BatteryInfo
Returns battery state.
getState() - Method in class io.appium.java_client.ios.IOSBatteryInfo
 
getStdOut() - Method in class io.appium.java_client.service.local.AppiumDriverLocalService
Logs as string.
getSupportedPerformanceDataTypes() - Method in interface io.appium.java_client.android.HasSupportedPerformanceDataType
returns the information type of the system state which is supported to read as like cpu, memory, network traffic, and battery.
getSupportedPerformanceDataTypesCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
returns the information type of the system state which is supported to read as like cpu, memory, network traffic, and battery.
getSyslogClient() - Method in class io.appium.java_client.ios.IOSDriver
 
getSyslogClient() - Method in interface io.appium.java_client.ios.ListensToSyslogMessages
 
getSystemBars() - Method in interface io.appium.java_client.android.HasAndroidDeviceDetails
 
getSystemBarsCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters to Retrieve visibility and bounds information of the status and navigation bars.
getTagName() - Method in interface org.openqa.selenium.WebElement
Get the tag name of this element.
getText() - Method in interface org.openqa.selenium.WebElement
Get the visible (i.e. not hidden by CSS) innerText of this element, including sub-elements, without any leading or trailing whitespace.
getTimeout() - Method in class io.appium.java_client.AppiumFluentWait
 
getTitle() - Method in interface org.openqa.selenium.WebDriver
The title of the current page.
getTotal() - Method in class io.appium.java_client.AppiumFluentWait.IterationInfo
The amount of total time.
getTotalCount() - Method in class io.appium.java_client.imagecomparison.FeaturesMatchingResult
Returns a count of matched edges on both images.
getUrl() - Method in class io.appium.java_client.AppiumCommandInfo
 
getUrl() - Method in class io.appium.java_client.service.local.AppiumDriverLocalService
Base URL.
getValue() - Method in enum io.appium.java_client.android.nativekey.KeyEventFlag
 
getValue() - Method in enum io.appium.java_client.android.nativekey.KeyEventMetaModifier
 
getVisualization() - Method in class io.appium.java_client.imagecomparison.ComparisonResult
Returns the visualization of the matching result.
getWindowHandle() - Method in interface org.openqa.selenium.WebDriver
Return an opaque handle to this window that uniquely identifies it within this driver instance.
getWindowHandles() - Method in interface org.openqa.selenium.WebDriver
Return a set of window handles which can be used to iterate over all open windows of this WebDriver instance by passing them to WebDriver.switchTo().
getWrappedDriver() - Method in class io.appium.java_client.pagefactory.Widget
 
getWrappedElement() - Method in class io.appium.java_client.pagefactory.Widget
 
GSM_CALL - Static variable in class io.appium.java_client.MobileCommand
 
GSM_SIGNAL - Static variable in class io.appium.java_client.MobileCommand
 
GSM_VOICE - Static variable in class io.appium.java_client.MobileCommand
 
GsmCallActions - Enum in io.appium.java_client.android
 
gsmCallCommand(String, GsmCallActions) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the element value replacement.
GsmSignalStrength - Enum in io.appium.java_client.android
 
gsmSignalStrengthCommand(GsmSignalStrength) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the element value replacement.
gsmVoiceCommand(GsmVoiceState) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the element value replacement.
GsmVoiceState - Enum in io.appium.java_client.android
 

H

HasAndroidClipboard - Interface in io.appium.java_client.android
 
HasAndroidDeviceDetails - Interface in io.appium.java_client.android
 
HasAppStrings - Interface in io.appium.java_client
 
HasBattery<T extends BatteryInfo> - Interface in io.appium.java_client.battery
 
HasClipboard - Interface in io.appium.java_client.clipboard
 
HasDeviceTime - Interface in io.appium.java_client
 
HasIOSClipboard - Interface in io.appium.java_client.ios
 
HasNetworkConnection - Interface in io.appium.java_client.android.connection
 
HasOnScreenKeyboard - Interface in io.appium.java_client
 
HasSessionDetails - Interface in io.appium.java_client
 
HasSettings - Interface in io.appium.java_client
 
HasSupportedPerformanceDataType - Interface in io.appium.java_client.android
 
HEAD_SET - Static variable in interface io.appium.java_client.windows.WindowsKeyCode
 
HIDE_KEYBOARD - Static variable in class io.appium.java_client.MobileCommand
 
hideKeyboard() - Method in interface io.appium.java_client.HidesKeyboard
Hides the keyboard if it is showing.
hideKeyboard(String) - Method in interface io.appium.java_client.HidesKeyboardWithKeyName
Hides the keyboard by pressing the button specified by keyName if it is showing.
hideKeyboard(String, String) - Method in interface io.appium.java_client.HidesKeyboardWithKeyName
Hides the keyboard if it is showing.
hideKeyboardCommand(String) - Static method in class io.appium.java_client.MobileCommand
This method forms a Map of parameters for the keyboard hiding.
hideKeyboardCommand(String, String) - Static method in class io.appium.java_client.MobileCommand
This method forms a Map of parameters for the keyboard hiding.
HideKeyboardStrategy - Interface in io.appium.java_client.remote
 
HidesKeyboard - Interface in io.appium.java_client
 
HidesKeyboardWithKeyName - Interface in io.appium.java_client
 
HOME - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
HowToUseLocators - Annotation Type in io.appium.java_client.pagefactory
 
HowToUseSelectors - Enum in io.appium.java_client.pagefactory.bys.builder
 
HWKB_DPLOY - Static variable in interface io.appium.java_client.windows.WindowsKeyCode
 

I

IGNORE_UNIMPORTANT_VIEWS - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Calls the setCompressedLayoutHierarchy() uiautomator function.
IllegalCoordinatesException - Exception in io.appium.java_client
 
IllegalCoordinatesException(String) - Constructor for exception io.appium.java_client.IllegalCoordinatesException
 
ime() - Method in interface org.openqa.selenium.WebDriver.Options
 
implicitlyWait(long, TimeUnit) - Method in interface org.openqa.selenium.WebDriver.Timeouts
Specifies the amount of time the driver should wait when searching for an element if it is not immediately present.
INSTALL_APP - Static variable in class io.appium.java_client.MobileCommand
 
installApp(String) - Method in interface io.appium.java_client.InteractsWithApps
Install an app on the mobile device.
installApp(String, BaseInstallApplicationOptions) - Method in interface io.appium.java_client.InteractsWithApps
Install an app on the mobile device.
INTENT_ACTION - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Intent action which will be used to start activity (default android.intent.action.MAIN).
INTENT_CATEGORY - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Intent category which will be used to start activity (default android.intent.category.LAUNCHER).
INTENT_FLAGS - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Flags that will be used to start activity (default 0x10200000).
INTER_KEY_DELAY - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
The delay, in ms, between keystrokes sent to an element when typing.
InteractsWithApps - Interface in io.appium.java_client
 
InteractsWithFiles - Interface in io.appium.java_client
 
intercept(Object, Method, Object[], MethodProxy) - Method in class io.appium.java_client.pagefactory.interceptors.InterceptorOfAListOfElements
Look at MethodInterceptor.intercept(Object, Method, Object[], MethodProxy).
intercept(Object, Method, Object[], MethodProxy) - Method in class io.appium.java_client.pagefactory.interceptors.InterceptorOfASingleElement
Look at MethodInterceptor.intercept(Object, Method, Object[], MethodProxy).
InterceptorOfAListOfElements - Class in io.appium.java_client.pagefactory.interceptors
 
InterceptorOfAListOfElements(ElementLocator) - Constructor for class io.appium.java_client.pagefactory.interceptors.InterceptorOfAListOfElements
 
InterceptorOfASingleElement - Class in io.appium.java_client.pagefactory.interceptors
 
InterceptorOfASingleElement(ElementLocator, WebDriver) - Constructor for class io.appium.java_client.pagefactory.interceptors.InterceptorOfASingleElement
 
InvalidNodeJSInstance - Exception in io.appium.java_client.service.local
 
InvalidNodeJSInstance(String, Throwable) - Constructor for exception io.appium.java_client.service.local.InvalidNodeJSInstance
 
InvalidServerInstanceException - Exception in io.appium.java_client.service.local
 
InvalidServerInstanceException(String, Throwable) - Constructor for exception io.appium.java_client.service.local.InvalidServerInstanceException
 
io.appium.java_client - package io.appium.java_client
 
io.appium.java_client.android - package io.appium.java_client.android
 
io.appium.java_client.android.appmanagement - package io.appium.java_client.android.appmanagement
 
io.appium.java_client.android.connection - package io.appium.java_client.android.connection
 
io.appium.java_client.android.nativekey - package io.appium.java_client.android.nativekey
 
io.appium.java_client.appmanagement - package io.appium.java_client.appmanagement
 
io.appium.java_client.battery - package io.appium.java_client.battery
 
io.appium.java_client.clipboard - package io.appium.java_client.clipboard
 
io.appium.java_client.events - package io.appium.java_client.events
 
io.appium.java_client.events.api - package io.appium.java_client.events.api
 
io.appium.java_client.events.api.general - package io.appium.java_client.events.api.general
 
io.appium.java_client.events.api.mobile - package io.appium.java_client.events.api.mobile
 
io.appium.java_client.functions - package io.appium.java_client.functions
 
io.appium.java_client.imagecomparison - package io.appium.java_client.imagecomparison
 
io.appium.java_client.internal - package io.appium.java_client.internal
 
io.appium.java_client.ios - package io.appium.java_client.ios
 
io.appium.java_client.ios.touch - package io.appium.java_client.ios.touch
 
io.appium.java_client.pagefactory - package io.appium.java_client.pagefactory
 
io.appium.java_client.pagefactory.bys - package io.appium.java_client.pagefactory.bys
 
io.appium.java_client.pagefactory.bys.builder - package io.appium.java_client.pagefactory.bys.builder
 
io.appium.java_client.pagefactory.interceptors - package io.appium.java_client.pagefactory.interceptors
 
io.appium.java_client.pagefactory.locator - package io.appium.java_client.pagefactory.locator
 
io.appium.java_client.pagefactory.utils - package io.appium.java_client.pagefactory.utils
 
io.appium.java_client.remote - package io.appium.java_client.remote
 
io.appium.java_client.screenrecording - package io.appium.java_client.screenrecording
 
io.appium.java_client.service.local - package io.appium.java_client.service.local
 
io.appium.java_client.service.local.flags - package io.appium.java_client.service.local.flags
 
io.appium.java_client.touch - package io.appium.java_client.touch
 
io.appium.java_client.touch.offset - package io.appium.java_client.touch.offset
 
io.appium.java_client.windows - package io.appium.java_client.windows
 
io.appium.java_client.ws - package io.appium.java_client.ws
 
IOS - Static variable in interface io.appium.java_client.remote.MobilePlatform
 
IOS_INSTALL_PAUSE - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Time in milliseconds to pause between installing the application and starting WebDriverAgent on the device.
IOS_XCUI_TEST - Static variable in interface io.appium.java_client.remote.AutomationName
 
IOSBatteryInfo - Class in io.appium.java_client.ios
 
IOSBatteryInfo(Map<String, Object>) - Constructor for class io.appium.java_client.ios.IOSBatteryInfo
 
IOSBatteryInfo.BatteryState - Enum in io.appium.java_client.ios
 
iOSBy - Annotation Type in io.appium.java_client.pagefactory
Used to build a complex iOS automation locator.
iOSClassChain(String) - Static method in class io.appium.java_client.MobileBy
This locator strategy is available in XCUITest Driver mode.
IOSDriver<T extends WebElement> - Class in io.appium.java_client.ios
iOS driver implementation.
IOSDriver(HttpCommandExecutor, Capabilities) - Constructor for class io.appium.java_client.ios.IOSDriver
Creates a new instance based on command executor and capabilities.
IOSDriver(URL, Capabilities) - Constructor for class io.appium.java_client.ios.IOSDriver
Creates a new instance based on Appium server URL and capabilities.
IOSDriver(URL, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.ios.IOSDriver
Creates a new instance based on Appium server URL, HTTP client factory and capabilities.
IOSDriver(AppiumDriverLocalService, Capabilities) - Constructor for class io.appium.java_client.ios.IOSDriver
Creates a new instance based on Appium driver local service and capabilities.
IOSDriver(AppiumDriverLocalService, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.ios.IOSDriver
Creates a new instance based on Appium driver local service, HTTP client factory and capabilities.
IOSDriver(AppiumServiceBuilder, Capabilities) - Constructor for class io.appium.java_client.ios.IOSDriver
Creates a new instance based on Appium service builder and capabilities.
IOSDriver(AppiumServiceBuilder, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.ios.IOSDriver
Creates a new instance based on Appium service builder, HTTP client factory and capabilities.
IOSDriver(HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.ios.IOSDriver
Creates a new instance based on HTTP client factory and capabilities.
IOSDriver(Capabilities) - Constructor for class io.appium.java_client.ios.IOSDriver
Creates a new instance based on capabilities.
IOSElement - Class in io.appium.java_client.ios
 
IOSElement() - Constructor for class io.appium.java_client.ios.IOSElement
 
iOSFindAll - Annotation Type in io.appium.java_client.pagefactory
Used to mark a field on a Page/Screen Object to indicate that lookup should use a series of iOSBy tags.
iOSFindBy - Annotation Type in io.appium.java_client.pagefactory
Used to mark a field on a Page Object to indicate an alternative mechanism for locating the element or a list of elements.
iOSFindByAllSet - Annotation Type in io.appium.java_client.pagefactory
Defines set of chained/possible locators.
iOSFindByChainSet - Annotation Type in io.appium.java_client.pagefactory
Defines set of chained/possible locators.
iOSFindBys - Annotation Type in io.appium.java_client.pagefactory
Used to mark a field on a Page Object to indicate that lookup should use a series of iOSBy tags.
iOSFindBySet - Annotation Type in io.appium.java_client.pagefactory
Defines set of chained/possible locators.
IOSMobileCapabilityType - Interface in io.appium.java_client.remote
The list of iOS-specific capabilities.
IOSMobileCommandHelper - Class in io.appium.java_client.ios
 
IOSMobileCommandHelper() - Constructor for class io.appium.java_client.ios.IOSMobileCommandHelper
 
iOSNsPredicateString(String) - Static method in class io.appium.java_client.MobileBy
This locator strategy is available in XCUITest Driver mode.
IOSPressOptions - Class in io.appium.java_client.ios.touch
 
IOSPressOptions() - Constructor for class io.appium.java_client.ios.touch.IOSPressOptions
 
iosPressOptions() - Static method in class io.appium.java_client.ios.touch.IOSPressOptions
It creates an empty instance of IOSPressOptions.
IOSServerFlag - Enum in io.appium.java_client.service.local.flags
Here is the list of iOS specific server arguments.
IOSStartScreenRecordingOptions - Class in io.appium.java_client.ios
 
IOSStartScreenRecordingOptions() - Constructor for class io.appium.java_client.ios.IOSStartScreenRecordingOptions
 
IOSStartScreenRecordingOptions.VideoQuality - Enum in io.appium.java_client.ios
 
IOSStartScreenRecordingOptions.VideoType - Enum in io.appium.java_client.ios
 
IOSStopScreenRecordingOptions - Class in io.appium.java_client.ios
 
IOSStopScreenRecordingOptions() - Constructor for class io.appium.java_client.ios.IOSStopScreenRecordingOptions
 
IOSTouchAction - Class in io.appium.java_client.ios
 
IOSTouchAction(PerformsTouchActions) - Constructor for class io.appium.java_client.ios.IOSTouchAction
 
IosUIAutomation(String) - Static method in class io.appium.java_client.MobileBy
Read https://developer.apple.com/library/tvos/documentation/DeveloperTools/ Conceptual/InstrumentsUserGuide/UIAutomation.html
iOSXCUITBy - Annotation Type in io.appium.java_client.pagefactory
Used to build a complex iOS XCUIT mode locator.
iOSXCUITFindAll - Annotation Type in io.appium.java_client.pagefactory
Used to mark a field on a Page/Screen Object to indicate that lookup should use a series of iOSXCUITBy tags.
iOSXCUITFindBy - Annotation Type in io.appium.java_client.pagefactory
 
iOSXCUITFindByAllSet - Annotation Type in io.appium.java_client.pagefactory
Defines set of chained/possible locators.
iOSXCUITFindByChainSet - Annotation Type in io.appium.java_client.pagefactory
Defines set of chained/possible locators.
iOSXCUITFindBys - Annotation Type in io.appium.java_client.pagefactory
Used to mark a field on a Page Object to indicate that lookup should use a series of iOSXCUITBy tags.
iOSXCUITFindBySet - Annotation Type in io.appium.java_client.pagefactory
 
IS_APP_INSTALLED - Static variable in class io.appium.java_client.MobileCommand
 
IS_KEYBOARD_SHOWN - Static variable in class io.appium.java_client.MobileCommand
 
IS_LOCKED - Static variable in class io.appium.java_client.MobileCommand
 
isActivated() - Method in interface org.openqa.selenium.WebDriver.ImeHandler
Indicates whether IME input active at the moment (not if it's available).
isAirplaneModeEnabled() - Method in class io.appium.java_client.android.connection.ConnectionState
Is airplane mode enabled or not.
isAndroid() - Method in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
isAppInstalled(String) - Method in interface io.appium.java_client.InteractsWithApps
Checks if an app is installed on the device.
isBrowser() - Method in class io.appium.java_client.AppiumDriver
 
isBrowser() - Method in interface io.appium.java_client.HasSessionDetails
Checks if focus is on browser.
isConfirmKey() - Method in enum io.appium.java_client.android.nativekey.AndroidKey
Whether key will, by default, trigger a click on the focused view.
isDataEnabled() - Method in class io.appium.java_client.android.connection.ConnectionState
Is data connection enabled or not.
isDeviceLocked() - Method in interface io.appium.java_client.LocksDevice
Check if the device is locked.
isDisplayed() - Method in interface org.openqa.selenium.WebElement
Is this element displayed or not?
isEnabled() - Method in interface org.openqa.selenium.WebElement
Is the element currently enabled or not?
isGamepadButton() - Method in enum io.appium.java_client.android.nativekey.AndroidKey
Returns true if the specified nativekey is a gamepad button.
isIOS() - Method in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
isIOSXcuit() - Method in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
isKeyboardShown() - Method in interface io.appium.java_client.HasOnScreenKeyboard
Check if the keyboard is displayed.
isKeyboardShownCommand() - Static method in class io.appium.java_client.MobileCommand
This method forms a Map of parameters for the checking of the keyboard state (is it shown or not).
isListening() - Method in class io.appium.java_client.ws.StringWebSocketClient
 
isLockedCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the finger print authentication invocation.
isLookupCached() - Method in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
Defines whether or not given element should be returned from cache on further calls.
isLookupCached() - Method in class io.appium.java_client.pagefactory.DefaultElementByBuilder
 
isLookUpCached() - Method in interface io.appium.java_client.pagefactory.locator.CacheableLocator
 
isMediaKey() - Method in enum io.appium.java_client.android.nativekey.AndroidKey
Whether this key is a media key, which can be send to apps that are interested in media key events.
isRunning() - Method in class io.appium.java_client.service.local.AppiumDriverLocalService
 
isSelected() - Method in interface org.openqa.selenium.WebElement
Determine whether or not this element is selected or not.
isSelendroidAutomation() - Method in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
isStopApp() - Method in class io.appium.java_client.android.Activity
Gets the stop app value.
isSystemKey() - Method in enum io.appium.java_client.android.nativekey.AndroidKey
Is this a system key?
isWakeKey() - Method in enum io.appium.java_client.android.nativekey.AndroidKey
Is it wake key or not.
isWiFiEnabled() - Method in class io.appium.java_client.android.connection.ConnectionState
Is Wi-Fi connection enabled or not.
isWindows() - Method in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
IterationInfo(long, Duration, Duration, Duration) - Constructor for class io.appium.java_client.AppiumFluentWait.IterationInfo
The class is used to represent information about a single loop iteration in AppiumFluentWait.until(Function) method.

J

JavaScriptEventListener - Interface in io.appium.java_client.events.api.general
 
JsonToMobileElementConverter - Class in io.appium.java_client.internal
Reconstitutes WebElements from their JSON representation.
JsonToMobileElementConverter(RemoteWebDriver, HasSessionDetails) - Constructor for class io.appium.java_client.internal.JsonToMobileElementConverter
Creates a new instance based on driver and object with session details.

K

KEEP_KEY_CHAINS - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
(Sim-only) Whether to keep keychains (Library/Keychains) when appium session is started/finished.
KEY_ALIAS - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Alias for key.
KEY_PASSWORD - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Password for key.
KEYCHAIN_PASSWORD - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Password for unlocking keychain specified in keychainPath.
KEYCHAIN_PATH - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Full path to the private development key exported from the system keychain.
KEYCODE_0 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_1 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_11 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_12 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_2 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_3 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_3D_MODE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_4 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_5 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_6 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_7 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_8 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_9 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_A - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_ALT_LEFT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_ALT_RIGHT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_APOSTROPHE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_APP_SWITCH - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_ASSIST - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_AT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_AVR_INPUT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_AVR_POWER - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_B - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BACK - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BACKSLASH - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BOOKMARK - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BREAK - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BRIGHTNESS_DOWN - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BRIGHTNESS_UP - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_1 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_10 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_11 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_12 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_13 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_14 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_15 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_16 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_2 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_3 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_4 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_5 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_6 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_7 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_8 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_9 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_A - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_B - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_C - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_L1 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_L2 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_MODE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_R1 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_R2 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_SELECT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_START - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_THUMBL - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_THUMBR - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_X - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_Y - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_BUTTON_Z - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_C - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_CALCULATOR - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_CALENDAR - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_CALL - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_CAMERA - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_CAPS_LOCK - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_CAPTIONS - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_CHANNEL_DOWN - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_CHANNEL_UP - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_CLEAR - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_COMMA - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_CONTACTS - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_CTRL_LEFT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_CTRL_RIGHT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_D - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_DEL - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_DPAD_CENTER - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_DPAD_DOWN - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_DPAD_LEFT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_DPAD_RIGHT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_DPAD_UP - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_DVR - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_E - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_EISU - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_ENDCALL - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_ENTER - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_ENVELOPE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_EQUALS - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_ESCAPE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_EXPLORER - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_F - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_F1 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_F10 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_F11 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_F12 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_F2 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_F3 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_F4 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_F5 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_F6 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_F7 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_F8 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_F9 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_FOCUS - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_FORWARD - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_FORWARD_DEL - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_FUNCTION - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_G - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_GRAVE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_GUIDE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_H - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_HEADSETHOOK - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_HELP - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_HENKAN - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_HOME - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_I - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_INFO - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_INSERT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_J - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_K - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_KANA - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_KATAKANA_HIRAGANA - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_L - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_LANGUAGE_SWITCH - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_LAST_CHANNEL - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_LEFT_BRACKET - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_M - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MANNER_MODE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MEDIA_AUDIO_TRACK - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MEDIA_CLOSE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MEDIA_EJECT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MEDIA_FAST_FORWARD - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MEDIA_NEXT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MEDIA_PAUSE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MEDIA_PLAY - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MEDIA_PLAY_PAUSE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MEDIA_PREVIOUS - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MEDIA_RECORD - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MEDIA_REWIND - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MEDIA_STOP - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MEDIA_TOP_MENU - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MENU - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_META_LEFT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_META_RIGHT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MINUS - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MOVE_END - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MOVE_HOME - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MUHENKAN - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MUSIC - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_MUTE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_N - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NOTIFICATION - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUM - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUM_LOCK - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_0 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_1 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_2 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_3 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_4 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_5 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_6 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_7 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_8 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_9 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_ADD - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_COMMA - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_DIVIDE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_DOT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_ENTER - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_EQUALS - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_LEFT_PAREN - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_MULTIPLY - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_RIGHT_PAREN - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_NUMPAD_SUBTRACT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_O - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_P - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_PAGE_DOWN - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_PAGE_UP - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_PAIRING - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_PERIOD - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_PICTSYMBOLS - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_PLUS - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_POUND - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_POWER - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_PROG_BLUE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_PROG_GREEN - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_PROG_RED - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_PROG_YELLOW - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_Q - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_R - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_RIGHT_BRACKET - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_RO - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_S - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_SCROLL_LOCK - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_SEARCH - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_SEMICOLON - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_SETTINGS - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_SHIFT_LEFT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_SHIFT_RIGHT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_SLASH - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_SLEEP - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_SOFT_LEFT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_SOFT_RIGHT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_SPACE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_STAR - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_STB_INPUT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_STB_POWER - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_SWITCH_CHARSET - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_SYM - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_SYSRQ - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_T - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TAB - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_ANTENNA_CABLE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_AUDIO_DESCRIPTION - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_AUDIO_DESCRIPTION_MIX_DOWN - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_AUDIO_DESCRIPTION_MIX_UP - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_CONTENTS_MENU - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_DATA_SERVICE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_INPUT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_INPUT_COMPONENT_1 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_INPUT_COMPONENT_2 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_INPUT_COMPOSITE_1 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_INPUT_COMPOSITE_2 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_INPUT_HDMI_1 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_INPUT_HDMI_2 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_INPUT_HDMI_3 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_INPUT_HDMI_4 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_INPUT_VGA_1 - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_MEDIA_CONTEXT_MENU - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_NETWORK - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_NUMBER_ENTRY - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_POWER - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_RADIO_SERVICE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_SATELLITE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_SATELLITE_BS - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_SATELLITE_CS - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_SATELLITE_SERVICE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_TELETEXT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_TERRESTRIAL_ANALOG - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_TERRESTRIAL_DIGITAL - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_TIMER_PROGRAMMING - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_TV_ZOOM_MODE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_U - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_UNKNOWN - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_V - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_VOICE_ASSIST - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_VOLUME_DOWN - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_VOLUME_MUTE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_VOLUME_UP - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_W - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_WAKEUP - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_WINDOW - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_X - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_Y - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_YEN - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_Z - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_ZENKAKU_HANKAKU - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_ZOOM_IN - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KEYCODE_ZOOM_OUT - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
KeyEvent - Class in io.appium.java_client.android.nativekey
 
KeyEvent() - Constructor for class io.appium.java_client.android.nativekey.KeyEvent
 
KeyEvent(AndroidKey) - Constructor for class io.appium.java_client.android.nativekey.KeyEvent
 
KeyEventFlag - Enum in io.appium.java_client.android.nativekey
 
KeyEventMetaModifier - Enum in io.appium.java_client.android.nativekey
 
KEYSTORE_PASSWORD - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Password for custom keystore.
KEYSTORE_PATH - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Path to custom keystore, default ~/.android/debug.keystore.

L

LANGUAGE - Static variable in interface io.appium.java_client.remote.MobileCapabilityType
(Sim/Emu-only) Language to set for the simulator / emulator.
LAUNCH_APP - Static variable in class io.appium.java_client.MobileCommand
 
LAUNCH_TIMEOUT - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Amount of time in ms to wait for instruments before assuming it hung and failing the session.
launchApp() - Method in interface io.appium.java_client.InteractsWithApps
Launches the app, which was provided in the capabilities at session creation, and (re)starts the session.
Listener - Interface in io.appium.java_client.events.api
This interface just marks event listeners.
ListensToException - Interface in io.appium.java_client.events.api.general
 
ListensToLogcatMessages - Interface in io.appium.java_client.android
 
ListensToSyslogMessages - Interface in io.appium.java_client.ios
 
LOCALE - Static variable in interface io.appium.java_client.remote.MobileCapabilityType
(Sim/Emu-only) Locale to set for the simulator / emulator.
LOCALIZABLE_STRINGS_DIR - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Where to look for localizable strings.
location() - Method in class io.appium.java_client.AppiumDriver
 
LOCATION_SERVICES_AUTHORIZED - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
(Sim-only) Set location services to be authorized or not authorized for app via plist, so that location services alert doesn't pop up.
LOCATION_SERVICES_ENABLED - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
(Sim-only) Force location services to be either on or off.
locator - Variable in class io.appium.java_client.pagefactory.interceptors.InterceptorOfAListOfElements
 
locator - Variable in class io.appium.java_client.pagefactory.interceptors.InterceptorOfASingleElement
 
LocatorGroupStrategy - Enum in io.appium.java_client.pagefactory
 
LOCK - Static variable in class io.appium.java_client.MobileCommand
 
lockDevice() - Method in interface io.appium.java_client.LocksDevice
This method locks a device.
lockDevice(Duration) - Method in interface io.appium.java_client.LocksDevice
Lock the device (bring it to the lock screen) for a given number of seconds or forever (until the command for unlocking is called).
lockDeviceCommand(Duration) - Static method in class io.appium.java_client.MobileCommand
This method forms a Map of parameters for the device locking.
LocksDevice - Interface in io.appium.java_client
 
logs() - Method in interface org.openqa.selenium.WebDriver.Options
Gets the Logs interface used to fetch different types of logs.
LONG_PRESS_KEY_CODE - Static variable in class io.appium.java_client.MobileCommand
 
longPress(LongPressOptions) - Method in class io.appium.java_client.TouchAction
Press and hold the at the center of an element until the context menu event has fired.
longPress(PointOption) - Method in class io.appium.java_client.TouchAction
Press and hold the at the center of an element until the context menu event has fired.
longPressKey(KeyEvent) - Method in interface io.appium.java_client.android.nativekey.PressesKey
Send a long press key event to the device under test.
longPressKeyCode(int) - Method in interface io.appium.java_client.android.nativekey.PressesKey
Deprecated.
longPressKeyCode(int, Integer) - Method in interface io.appium.java_client.android.nativekey.PressesKey
Deprecated.
longPressKeyCode(int) - Method in interface io.appium.java_client.windows.PressesKeyCode
Send a long key event to the device.
longPressKeyCode(int, Integer) - Method in interface io.appium.java_client.windows.PressesKeyCode
Send a long key event along with an Android metastate to an Android device.
longPressKeyCodeCommand(int) - Static method in class io.appium.java_client.MobileCommand
This method forms a Map of parameters for the long key event invocation.
longPressKeyCodeCommand(int, Integer) - Static method in class io.appium.java_client.MobileCommand
This method forms a Map of parameters for the long key event invocation.
LongPressOptions - Class in io.appium.java_client.touch
 
LongPressOptions() - Constructor for class io.appium.java_client.touch.LongPressOptions
 
longPressOptions() - Static method in class io.appium.java_client.touch.LongPressOptions
It creates an empty instance of LongPressOptions.

M

makeGsmCall(String, GsmCallActions) - Method in interface io.appium.java_client.android.SupportsSpecialEmulatorCommands
Emulate GSM call event on the connected emulator.
manage() - Method in interface org.openqa.selenium.WebDriver
Gets the Option interface
mapToPoint(Map<String, Object>) - Static method in class io.appium.java_client.imagecomparison.ComparisonResult
Transforms a map into Point object.
mapToRect(Map<String, Object>) - Static method in class io.appium.java_client.imagecomparison.ComparisonResult
Transforms a map into Rectangle object.
matchImagesFeatures(byte[], byte[]) - Method in interface io.appium.java_client.ComparesImages
Performs images matching by features with default options.
matchImagesFeatures(byte[], byte[], FeaturesMatchingOptions) - Method in interface io.appium.java_client.ComparesImages
Performs images matching by features.
matchImagesFeatures(File, File) - Method in interface io.appium.java_client.ComparesImages
Performs images matching by features with default options.
matchImagesFeatures(File, File, FeaturesMatchingOptions) - Method in interface io.appium.java_client.ComparesImages
Performs images matching by features.
MatchingFunction - Enum in io.appium.java_client.imagecomparison
 
MAX_KEYCODE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
MAX_TYPING_FREQUENCY - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Maximum frequency of keystrokes for typing and clear.
maximize() - Method in interface org.openqa.selenium.WebDriver.Window
Maximizes the current window if it is not already maximized
MENU - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_ALT_LEFT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_ALT_LEFT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyMetastate
Deprecated.
 
META_ALT_MASK - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_ALT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_ALT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyMetastate
Deprecated.
 
META_ALT_RIGHT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_ALT_RIGHT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyMetastate
Deprecated.
 
META_CAPS_LOCK_ON - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_CAPS_LOCK_ON - Static variable in interface io.appium.java_client.android.AndroidKeyMetastate
Deprecated.
 
META_CTRL_LEFT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_CTRL_LEFT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyMetastate
Deprecated.
 
META_CTRL_MASK - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_CTRL_ON - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_CTRL_ON - Static variable in interface io.appium.java_client.android.AndroidKeyMetastate
Deprecated.
 
META_CTRL_RIGHT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_CTRL_RIGHT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyMetastate
Deprecated.
 
META_FUNCTION_ON - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_FUNCTION_ON - Static variable in interface io.appium.java_client.android.AndroidKeyMetastate
Deprecated.
 
META_META_LEFT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_META_LEFT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyMetastate
Deprecated.
 
META_META_MASK - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_META_ON - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_META_ON - Static variable in interface io.appium.java_client.android.AndroidKeyMetastate
Deprecated.
 
META_META_RIGHT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_META_RIGHT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyMetastate
Deprecated.
 
META_NUM_LOCK_ON - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_NUM_LOCK_ON - Static variable in interface io.appium.java_client.android.AndroidKeyMetastate
Deprecated.
 
META_SCROLL_LOCK_ON - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_SCROLL_LOCK_ON - Static variable in interface io.appium.java_client.android.AndroidKeyMetastate
Deprecated.
 
META_SHIFT_LEFT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_SHIFT_LEFT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyMetastate
Deprecated.
 
META_SHIFT_MASK - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_SHIFT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_SHIFT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyMetastate
Deprecated.
 
META_SHIFT_RIGHT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_SHIFT_RIGHT_ON - Static variable in interface io.appium.java_client.android.AndroidKeyMetastate
Deprecated.
 
META_SYM_ON - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
META_SYM_ON - Static variable in interface io.appium.java_client.android.AndroidKeyMetastate
Deprecated.
 
MobileBrowserType - Interface in io.appium.java_client.remote
 
MobileBy - Class in io.appium.java_client
 
MobileBy(MobileSelector, String) - Constructor for class io.appium.java_client.MobileBy
 
MobileBy.ByAccessibilityId - Class in io.appium.java_client
 
MobileBy.ByAndroidUIAutomator - Class in io.appium.java_client
 
MobileBy.ByIosClassChain - Class in io.appium.java_client
 
MobileBy.ByIosNsPredicate - Class in io.appium.java_client
 
MobileBy.ByIosUIAutomation - Class in io.appium.java_client
 
MobileBy.ByWindowsAutomation - Class in io.appium.java_client
 
MobileCapabilityType - Interface in io.appium.java_client.remote
The list of common capabilities.
MobileCommand - Class in io.appium.java_client
The repository of mobile commands defined in the Mobile JSON wire protocol.
MobileCommand() - Constructor for class io.appium.java_client.MobileCommand
 
MobileDriver<T extends WebElement> - Interface in io.appium.java_client
 
MobileElement - Class in io.appium.java_client
 
MobileElement() - Constructor for class io.appium.java_client.MobileElement
 
MobilePlatform - Interface in io.appium.java_client.remote
 
MobileSelector - Enum in io.appium.java_client
 
moveTo(PointOption) - Method in class io.appium.java_client.TouchAction
Moves current touch to a new position.
MultiTouchAction - Class in io.appium.java_client
Used for Webdriver 3 multi-touch gestures See the Webriver 3 spec https://dvcs.w3.org/hg/webdriver/raw-file/default/webdriver-spec.html The MultiTouchAction object is a collection of TouchAction objects (remember that TouchAction objects are in turn, a chain of individual actions) Add multiple TouchAction objects using the add() method.
MultiTouchAction(PerformsTouchActions) - Constructor for class io.appium.java_client.MultiTouchAction
 

N

NATIVE_INSTRUMENTS_LIB - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Use native intruments lib (ie disable instruments-without-delay).
NATIVE_WEB_SCREENSHOT - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
In a web context, use native (adb) method for taking a screenshot, rather than proxying to ChromeDriver, default false.
NATIVE_WEB_TAP - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
(Sim-only) Enable "real", non-javascript-based web taps in Safari.
navigate() - Method in interface org.openqa.selenium.WebDriver
An abstraction allowing the driver to access the browser's history and to navigate to a given URL.
NavigationEventListener - Interface in io.appium.java_client.events.api.general
 
NETWORK_SPEED - Static variable in class io.appium.java_client.MobileCommand
 
NetworkSpeed - Enum in io.appium.java_client.android
 
networkSpeedCommand(NetworkSpeed) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the element value replacement.
NEW_COMMAND_TIMEOUT - Static variable in interface io.appium.java_client.remote.MobileCapabilityType
How long (in seconds) Appium will wait for a new command from the client before assuming the client quit and ending the session.
NewAppiumSessionPayload - Class in io.appium.java_client.remote
 
newRemoteWebElement() - Method in class io.appium.java_client.internal.JsonToMobileElementConverter
 
NO_RESET - Static variable in interface io.appium.java_client.remote.MobileCapabilityType
Don't reset app state before this session.
NO_SIGN - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Skip checking and signing of app with debug keys, will work only with UiAutomator and not with selendroid, default false.
NO_SUCH_CONTEXT - Static variable in class io.appium.java_client.ErrorCodesMobile
 
NODE_PATH - Static variable in class io.appium.java_client.service.local.AppiumServiceBuilder
The environmental variable used to define the path to executable NodeJS file (node.exe for WIN and node for Linux/MacOS X).
NoSuchContextException - Exception in io.appium.java_client
 
NoSuchContextException(String) - Constructor for exception io.appium.java_client.NoSuchContextException
 
NoSuchContextException(String, Throwable) - Constructor for exception io.appium.java_client.NoSuchContextException
 

O

OccurrenceMatchingOptions - Class in io.appium.java_client.imagecomparison
 
OccurrenceMatchingOptions() - Constructor for class io.appium.java_client.imagecomparison.OccurrenceMatchingOptions
 
OccurrenceMatchingResult - Class in io.appium.java_client.imagecomparison
 
OccurrenceMatchingResult(Map<String, Object>) - Constructor for class io.appium.java_client.imagecomparison.OccurrenceMatchingResult
 
OEM_CUSTOM - Static variable in interface io.appium.java_client.windows.WindowsKeyCode
 
OEM_CUSTOM2 - Static variable in interface io.appium.java_client.windows.WindowsKeyCode
 
OEM_CUSTOM3 - Static variable in interface io.appium.java_client.windows.WindowsKeyCode
 
ofCode(long) - Static method in enum io.appium.java_client.appmanagement.ApplicationState
Creates ApplicationState instance based on the code.
onClosing(WebSocket, int, String) - Method in class io.appium.java_client.ws.StringWebSocketClient
 
onException(Throwable, WebDriver) - Method in interface io.appium.java_client.events.api.general.ListensToException
Called whenever an exception would be thrown.
onFailure(WebSocket, Throwable, Response) - Method in class io.appium.java_client.ws.StringWebSocketClient
 
onMessage(WebSocket, String) - Method in class io.appium.java_client.ws.StringWebSocketClient
 
onOpen(WebSocket, Response) - Method in class io.appium.java_client.ws.StringWebSocketClient
 
OPEN_NOTIFICATIONS - Static variable in class io.appium.java_client.MobileCommand
 
openNotifications() - Method in class io.appium.java_client.android.AndroidDriver
Open the notification shade, on Android devices.
openNotificationsCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the notification opening.
OPTIONAL_INTENT_ARGUMENTS - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Additional intent arguments that will be used to start activity.
org.openqa.selenium - package org.openqa.selenium
 
org.openqa.selenium.internal - package org.openqa.selenium.internal
 
ORIENTATION - Static variable in interface io.appium.java_client.remote.MobileCapabilityType
(Sim/Emu-only) start in a certain orientation.
OverrideWidget - Annotation Type in io.appium.java_client.pagefactory
This annotation should mark an abstract/certain Widget object class or field that declares some abstract/certain Widget object class.

P

pageLoadTimeout(long, TimeUnit) - Method in interface org.openqa.selenium.WebDriver.Timeouts
Sets the amount of time to wait for a page load to complete before throwing an error.
parameterBuilder - Variable in class io.appium.java_client.TouchAction
 
parentFrame() - Method in interface org.openqa.selenium.WebDriver.TargetLocator
Change focus to the parent context.
perform() - Method in class io.appium.java_client.MultiTouchAction
Perform the multi-touch action on the mobile performsTouchActions.
perform() - Method in interface io.appium.java_client.PerformsActions
 
perform() - Method in class io.appium.java_client.TouchAction
Perform this chain of actions on the performsTouchActions.
PERFORM_MULTI_TOUCH - Static variable in class io.appium.java_client.MobileCommand
 
PERFORM_TOUCH_ACTION - Static variable in class io.appium.java_client.MobileCommand
 
performMultiTouchAction(MultiTouchAction) - Method in interface io.appium.java_client.PerformsTouchActions
Performs multiple TouchAction gestures at the same time, to simulate multiple fingers/touch inputs.
PerformsActions<T extends PerformsActions<T>> - Interface in io.appium.java_client
 
PerformsTouchActions - Interface in io.appium.java_client
 
PerformsTouchID - Interface in io.appium.java_client.ios
 
performTouchAction(TouchAction) - Method in interface io.appium.java_client.PerformsTouchActions
Performs a chain of touch actions, which together can be considered an entire gesture.
performTouchID(boolean) - Method in interface io.appium.java_client.ios.PerformsTouchID
Simulate touchId event.
platform - Variable in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
PLATFORM_VERSION - Static variable in interface io.appium.java_client.remote.MobileCapabilityType
Mobile OS version.
point(int, int) - Static method in class io.appium.java_client.touch.offset.PointOption
It creates a built instance of PointOption which takes x and y coordinates.
PointOption<T extends PointOption<T>> - Class in io.appium.java_client.touch.offset
 
PointOption() - Constructor for class io.appium.java_client.touch.offset.PointOption
 
postC(String) - Static method in class io.appium.java_client.MobileCommand
This methods forms POST commands.
POWER - Static variable in interface io.appium.java_client.windows.WindowsKeyCode
 
POWER_AC_STATE - Static variable in class io.appium.java_client.MobileCommand
 
POWER_CAPACITY - Static variable in class io.appium.java_client.MobileCommand
 
powerACCommand(PowerACState) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the element value replacement.
PowerACState - Enum in io.appium.java_client.android
 
powerCapacityCommand(int) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the element value replacement.
prepareArguments(String, Object) - Static method in class io.appium.java_client.MobileCommand
Prepares single argument.
prepareArguments(String[], Object[]) - Static method in class io.appium.java_client.MobileCommand
Prepares collection of arguments.
press(IOSPressOptions) - Method in class io.appium.java_client.ios.IOSTouchAction
Press action on the screen.
press(PointOption) - Method in class io.appium.java_client.TouchAction
Press action on the screen.
PRESS_KEY - Static variable in interface io.appium.java_client.remote.HideKeyboardStrategy
 
PRESS_KEY_CODE - Static variable in class io.appium.java_client.MobileCommand
 
PressesKey - Interface in io.appium.java_client.android.nativekey
 
PressesKeyCode - Interface in io.appium.java_client.windows
 
pressKey(KeyEvent) - Method in interface io.appium.java_client.android.nativekey.PressesKey
Send a key event to the device under test.
pressKeyCode(int) - Method in interface io.appium.java_client.android.nativekey.PressesKey
Deprecated.
pressKeyCode(int, Integer) - Method in interface io.appium.java_client.android.nativekey.PressesKey
Deprecated.
pressKeyCode(int) - Method in interface io.appium.java_client.windows.PressesKeyCode
Send a key event to the device.
pressKeyCode(int, Integer) - Method in interface io.appium.java_client.windows.PressesKeyCode
Send a key event along with an Android metastate to an Android device.
pressKeyCodeCommand(int) - Static method in class io.appium.java_client.MobileCommand
This method forms a Map of parameters for the key event invocation.
pressKeyCodeCommand(int, Integer) - Static method in class io.appium.java_client.MobileCommand
This method forms a Map of parameters for the key event invocation.
PREVENT_WDAATTACHMENTS - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Sets read only permissons to Attachments subfolder of WebDriverAgent root inside Xcode's DerivedData.
PROCESS_ARGUMENTS - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Arguments to pass to the AUT using instruments.
propagateIfNotIgnored(Throwable) - Method in class io.appium.java_client.AppiumFluentWait
 
ProxyFactory - Class in io.appium.java_client.pagefactory.utils
Original class is a super class of a proxy object here.
PULL_FILE - Static variable in class io.appium.java_client.MobileCommand
 
PULL_FOLDER - Static variable in class io.appium.java_client.MobileCommand
 
pullFile(String) - Method in interface io.appium.java_client.InteractsWithFiles
Pull a file from the simulator/device.
pullFolder(String) - Method in interface io.appium.java_client.InteractsWithFiles
Pull a folder content from the simulator/device.
PUSH_FILE - Static variable in class io.appium.java_client.MobileCommand
 
PushesFiles - Interface in io.appium.java_client.android
 
PushesFiles - Interface in io.appium.java_client.ios
 
pushFile(String, byte[]) - Method in interface io.appium.java_client.android.PushesFiles
Saves base64 encoded data as a file on the remote mobile device.
pushFile(String, File) - Method in interface io.appium.java_client.android.PushesFiles
Saves the given file to the remote mobile device.
pushFile(String, byte[]) - Method in interface io.appium.java_client.ios.PushesFiles
Saves base64 encoded data as a media file on the remote mobile device.
pushFile(String, File) - Method in interface io.appium.java_client.ios.PushesFiles
Saves base64 encoded data as a media file on the remote mobile device.
pushFileCommand(String, byte[]) - Static method in class io.appium.java_client.MobileCommand
This method forms a Map of parameters for the file pushing.

Q

QUERY_APP_STATE - Static variable in class io.appium.java_client.MobileCommand
 
queryAppState(String) - Method in interface io.appium.java_client.InteractsWithApps
Queries the state of an application.
quit() - Method in interface org.openqa.selenium.WebDriver
Quits this driver, closing every associated window.

R

RECREATE_CHROME_DRIVER_SESSIONS - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Kill ChromeDriver session when moving to a non-ChromeDriver webview.
refresh() - Method in interface org.openqa.selenium.WebDriver.Navigation
Refresh the current page
release() - Method in class io.appium.java_client.TouchAction
Remove the current touching implement from the screen (withdraw your touch).
remember() - Method in class io.appium.java_client.ScreenshotState
Call this method to save the initial screenshot state.
remember(BufferedImage) - Method in class io.appium.java_client.ScreenshotState
This method allows to pass a custom bitmap for further comparison instead of taking one using screenshot provider function.
REMOVE_APP - Static variable in class io.appium.java_client.MobileCommand
 
removeAllHandlers() - Method in class io.appium.java_client.ws.StringWebSocketClient
Remove all the registered handlers.
removeAllLogcatListeners() - Method in interface io.appium.java_client.android.ListensToLogcatMessages
Removes all existing logcat handlers.
removeAllSyslogListeners() - Method in interface io.appium.java_client.ios.ListensToSyslogMessages
Removes all existing syslog handlers.
removeApp(String) - Method in interface io.appium.java_client.InteractsWithApps
Remove the specified app from the device (uninstall).
removeApp(String, BaseRemoveApplicationOptions) - Method in interface io.appium.java_client.InteractsWithApps
Remove the specified app from the device (uninstall).
removeConnectionHandlers() - Method in interface io.appium.java_client.ws.CanHandleConnects
Removes existing web socket connection handlers.
removeDisconnectionHandlers() - Method in interface io.appium.java_client.ws.CanHandleDisconnects
Removes existing disconnection handlers.
removeErrorHandlers() - Method in interface io.appium.java_client.ws.CanHandleErrors
Removes existing error handlers.
removeMessageHandlers() - Method in interface io.appium.java_client.ws.CanHandleMessages
Removes existing message handlers.
REPLACE_VALUE - Static variable in class io.appium.java_client.MobileCommand
 
replaceElementValueCommand(HasIdentity, String) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the element value replacement.
replaceValue(String) - Method in class io.appium.java_client.android.AndroidElement
This method replace current text value.
RESET - Static variable in class io.appium.java_client.MobileCommand
 
RESET_KEYBOARD - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Reset keyboard to its original state, after running Unicode tests with unicodeKeyboard capability.
RESET_ON_SESSION_START_ONLY - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Whether to perform reset on test session finish (false) or not (true).
resetApp() - Method in interface io.appium.java_client.InteractsWithApps
Resets the currently running app together with the session.
RINGER_TOGGLE - Static variable in interface io.appium.java_client.windows.WindowsKeyCode
 
rotate(DeviceRotation) - Method in class io.appium.java_client.AppiumDriver
 
rotate(ScreenOrientation) - Method in class io.appium.java_client.AppiumDriver
 
rotation() - Method in class io.appium.java_client.AppiumDriver
 
ROTATION_LOCK - Static variable in interface io.appium.java_client.windows.WindowsKeyCode
 
RotationEventListener - Interface in io.appium.java_client.events.api.mobile
 
RUN_APP_IN_BACKGROUND - Static variable in class io.appium.java_client.MobileCommand
 
runAppInBackground(Duration) - Method in interface io.appium.java_client.InteractsWithApps
Runs the current app as a background app for the time requested.
runAppInBackground(Duration) - Method in class io.appium.java_client.ios.IOSDriver
Runs the current app as a background app for the number of seconds or minimizes the app.

S

SAFARI - Static variable in interface io.appium.java_client.remote.MobileBrowserType
 
SAFARI_ALLOW_POPUPS - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
(Sim-only) Allow javascript to open new windows in Safari.
SAFARI_IGNORE_FRAUD_WARNING - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
(Sim-only) Prevent Safari from showing a fraudulent website warning.
SAFARI_INITIAL_URL - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
(Sim-only) (>= 8.1) Initial safari url, default is a local welcome page.
SAFARI_OPEN_LINKS_IN_BACKGROUND - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
(Sim-only) Whether Safari should allow links to open in new windows.
SCALE_FACTOR - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
The capability to direct Appium to set the simulator scale.
ScreenRecordingUploadOptions - Class in io.appium.java_client.screenrecording
 
ScreenRecordingUploadOptions() - Constructor for class io.appium.java_client.screenrecording.ScreenRecordingUploadOptions
 
ScreenRecordingUploadOptions.RequestMethod - Enum in io.appium.java_client.screenrecording
 
SCREENSHOT_WAIT_TIMEOUT - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Max timeout in sec to wait for a screenshot to be generated. default: 10.
ScreenshotState - Class in io.appium.java_client
 
ScreenshotState(Supplier<BufferedImage>) - Constructor for class io.appium.java_client.ScreenshotState
The class constructor accepts single argument, which is lambda function, that provides the screenshot of the necessary screen area to be verified for similarity.
ScreenshotState.ResizeMode - Enum in io.appium.java_client
 
ScreenshotState.ScreenshotComparisonError - Exception in io.appium.java_client
 
ScreenshotState.ScreenshotComparisonTimeout - Exception in io.appium.java_client
 
SEARCH - Static variable in interface io.appium.java_client.windows.WindowsKeyCode
 
SearchContext - Interface in org.openqa.selenium
 
SearchingEventListener - Interface in io.appium.java_client.events.api.general
 
SELENDROID - Static variable in interface io.appium.java_client.remote.AutomationName
 
SELENDROID_PORT - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
 
SelendroidBy - Annotation Type in io.appium.java_client.pagefactory
Used to build a complex selendroid locator.
SelendroidFindAll - Annotation Type in io.appium.java_client.pagefactory
Used to mark a field on a Page/Screen Object to indicate that lookup should use a series of SelendroidBy tags It will then search for all elements that match any criteria.
SelendroidFindBy - Annotation Type in io.appium.java_client.pagefactory
Used to mark a field on a Page Object to indicate an alternative mechanism for locating the element or a list of elements.
SelendroidFindByAllSet - Annotation Type in io.appium.java_client.pagefactory
Defines set of chained/possible locators.
SelendroidFindByChainSet - Annotation Type in io.appium.java_client.pagefactory
Defines set of chained/possible locators.
SelendroidFindBys - Annotation Type in io.appium.java_client.pagefactory
Used to mark a field on a Page Object to indicate that lookup should use a series of SelendroidBy tags.
SelendroidFindBySet - Annotation Type in io.appium.java_client.pagefactory
Defines set of chained/possible locators.
SEND_KEY_STRATEGY - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
strategy to use to type test into a test field.
SEND_SMS - Static variable in class io.appium.java_client.MobileCommand
 
sendKeys(CharSequence...) - Method in interface org.openqa.selenium.WebElement
Use this method to simulate typing into an element, which may set its value.
sendSMS(String, String) - Method in interface io.appium.java_client.android.SupportsSpecialEmulatorCommands
Emulate send SMS event on the connected emulator.
sendSMSCommand(String, String) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the element value replacement.
ServerArgument - Interface in io.appium.java_client.service.local.flags
 
SET_CLIPBOARD - Static variable in class io.appium.java_client.MobileCommand
 
SET_NETWORK_CONNECTION - Static variable in class io.appium.java_client.MobileCommand
 
SET_SETTINGS - Static variable in class io.appium.java_client.MobileCommand
 
SET_VALUE - Static variable in class io.appium.java_client.MobileCommand
 
setAnnotated(AnnotatedElement) - Method in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
This method should be used for the setting up of AnnotatedElement instances before the building of By-locator strategies.
setAppWaitActivity(String) - Method in class io.appium.java_client.android.Activity
Sets the app wait activity value.
setAppWaitPackage(String) - Method in class io.appium.java_client.android.Activity
Sets the app wait package value.
setClipboard(String, ClipboardContentType, byte[]) - Method in interface io.appium.java_client.android.HasAndroidClipboard
Set the content of device's clipboard.
setClipboard(ClipboardContentType, byte[]) - Method in interface io.appium.java_client.clipboard.HasClipboard
Set the content of device's clipboard.
setClipboardImage(BufferedImage) - Method in interface io.appium.java_client.ios.HasIOSClipboard
Set an image to the clipboard.
setClipboardText(String, String) - Method in interface io.appium.java_client.android.HasAndroidClipboard
Set the clipboard text.
setClipboardText(String) - Method in interface io.appium.java_client.clipboard.HasClipboard
Set the clipboard text.
setClipboardUrl(URL) - Method in interface io.appium.java_client.ios.HasIOSClipboard
Set an URL to the clipboard.
setCommandCodec(CommandCodec<HttpRequest>) - Method in class io.appium.java_client.remote.AppiumCommandExecutor
 
setComparisonInterval(Duration) - Method in class io.appium.java_client.ScreenshotState
Sets the interval between similarity verification rounds in verify* methods.
setConnection(ConnectionState) - Method in interface io.appium.java_client.android.connection.HasNetworkConnection
Set the network connection of the device.
setConnectionCommand(long) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the setting of device network connection.
setGsmSignalStrength(GsmSignalStrength) - Method in interface io.appium.java_client.android.SupportsSpecialEmulatorCommands
Emulate GSM signal strength change event on the connected emulator.
setGsmVoice(GsmVoiceState) - Method in interface io.appium.java_client.android.SupportsSpecialEmulatorCommands
Emulate GSM voice event on the connected emulator.
setIntentAction(String) - Method in class io.appium.java_client.android.Activity
Sets the intent action value.
setIntentCategory(String) - Method in class io.appium.java_client.android.Activity
Sets the intent category value.
setIntentFlags(String) - Method in class io.appium.java_client.android.Activity
Sets the intent flags value.
setLocation(Location) - Method in class io.appium.java_client.AppiumDriver
 
setNetworkSpeed(NetworkSpeed) - Method in interface io.appium.java_client.android.SupportsSpecialEmulatorCommands
Emulate network speed change event on the connected emulator.
setOptionalIntentArguments(String) - Method in class io.appium.java_client.android.Activity
Sets the optional intent arguments value.
setPosition(Point) - Method in interface org.openqa.selenium.WebDriver.Window
Set the position of the current window.
setPowerAC(PowerACState) - Method in interface io.appium.java_client.android.SupportsSpecialEmulatorCommands
Emulate power state change on the connected emulator.
setPowerCapacity(int) - Method in interface io.appium.java_client.android.SupportsSpecialEmulatorCommands
Emulate power capacity change on the connected emulator.
setPrivateFieldValue(String, Object) - Method in class io.appium.java_client.remote.AppiumCommandExecutor
 
setResponseCodec(ResponseCodec<HttpResponse>) - Method in class io.appium.java_client.remote.AppiumCommandExecutor
 
setScriptTimeout(long, TimeUnit) - Method in interface org.openqa.selenium.WebDriver.Timeouts
Sets the amount of time to wait for an asynchronous script to finish execution before throwing an error.
setSetting(Setting, Object) - Method in interface io.appium.java_client.HasSettings
Set a setting for this test session It's probably better to use a convenience function, rather than use this function directly.
setSettingsCommand(Setting, Object) - Static method in class io.appium.java_client.MobileCommand
 
setSize(Dimension) - Method in interface org.openqa.selenium.WebDriver.Window
Set the size of the current window.
setStopApp(boolean) - Method in class io.appium.java_client.android.Activity
Sets the stop app value.
Setting - Enum in io.appium.java_client
Enums defining constants for Appium Settings which can be set and toggled during a test session.
SETTINGS - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
setValue(String) - Method in class io.appium.java_client.MobileElement
This method sets the new value of the attribute "value".
shake() - Method in interface io.appium.java_client.ios.ShakesDevice
Simulate shaking the device.
SHAKE - Static variable in class io.appium.java_client.MobileCommand
 
shakeCommand() - Static method in class io.appium.java_client.ios.IOSMobileCommandHelper
This method forms a Map of parameters for the device shaking.
ShakesDevice - Interface in io.appium.java_client.ios
 
SHOULD_USE_SINGLETON_TESTMANAGER - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Use default proxy for test management within WebDriverAgent.
SHOW_IOS_LOG - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Whether to show any logs captured from a device in the appium logs.
SHOW_XCODE_LOG - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Whether to display the output of the Xcode command used to run the tests.If this is true, there will be lots of extra logging at startup.
SimilarityMatchingOptions - Class in io.appium.java_client.imagecomparison
 
SimilarityMatchingOptions() - Constructor for class io.appium.java_client.imagecomparison.SimilarityMatchingOptions
 
SimilarityMatchingResult - Class in io.appium.java_client.imagecomparison
 
SimilarityMatchingResult(Map<String, Object>) - Constructor for class io.appium.java_client.imagecomparison.SimilarityMatchingResult
 
SIMPLE_ISVISIBLE_CHECK - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Use native methods for determining visibility of elements.
SPACE - Static variable in interface io.appium.java_client.android.AndroidKeyCode
Deprecated.
 
start() - Method in class io.appium.java_client.service.local.AppiumDriverLocalService
Starts the defined appium server.
START_ACTIVITY - Static variable in class io.appium.java_client.MobileCommand
 
START_IWDP - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Set this to true if you want to start ios_webkit_debug proxy server automatically for accessing webviews on iOS.
START_RECORDING_SCREEN - Static variable in class io.appium.java_client.MobileCommand
 
startActivity(Activity) - Method in interface io.appium.java_client.android.StartsActivity
This method should start arbitrary activity during a test.
startActivityCommand(String, String, String, String, String, String, String, String, boolean) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the activity starting.
startLogcatBroadcast() - Method in interface io.appium.java_client.android.ListensToLogcatMessages
Start logcat messages broadcast via web socket.
startLogcatBroadcast(String) - Method in interface io.appium.java_client.android.ListensToLogcatMessages
Start logcat messages broadcast via web socket.
startLogcatBroadcast(String, int) - Method in interface io.appium.java_client.android.ListensToLogcatMessages
Start logcat messages broadcast via web socket.
startRecordingScreen(T) - Method in interface io.appium.java_client.screenrecording.CanRecordScreen
Start asynchronous screen recording process.
startRecordingScreen() - Method in interface io.appium.java_client.screenrecording.CanRecordScreen
Start asynchronous screen recording process with default options.
startRecordingScreenCommand(BaseStartScreenRecordingOptions) - Static method in class io.appium.java_client.MobileCommand
 
StartsActivity - Interface in io.appium.java_client.android
 
startScreenRecordingOptions() - Static method in class io.appium.java_client.android.AndroidStartScreenRecordingOptions
 
startScreenRecordingOptions() - Static method in class io.appium.java_client.ios.IOSStartScreenRecordingOptions
 
startSyslogBroadcast() - Method in interface io.appium.java_client.ios.ListensToSyslogMessages
Start syslog messages broadcast via web socket.
startSyslogBroadcast(String) - Method in interface io.appium.java_client.ios.ListensToSyslogMessages
Start syslog messages broadcast via web socket.
startSyslogBroadcast(String, int) - Method in interface io.appium.java_client.ios.ListensToSyslogMessages
Start syslog messages broadcast via web socket.
stop() - Method in class io.appium.java_client.service.local.AppiumDriverLocalService
Stops this service is it is currently running.
STOP_RECORDING_SCREEN - Static variable in class io.appium.java_client.MobileCommand
 
stopLogcatBroadcast() - Method in interface io.appium.java_client.android.ListensToLogcatMessages
Stops logcat messages broadcast via web socket.
stopRecordingScreen(T) - Method in interface io.appium.java_client.screenrecording.CanRecordScreen
Gather the output from the previously started screen recording to a media file.
stopRecordingScreen() - Method in interface io.appium.java_client.screenrecording.CanRecordScreen
Gather the output from the previously started screen recording to a media file with default options.
stopRecordingScreenCommand(BaseStopScreenRecordingOptions) - Static method in class io.appium.java_client.MobileCommand
 
stopScreenRecordingOptions() - Static method in class io.appium.java_client.android.AndroidStopScreenRecordingOptions
 
stopScreenRecordingOptions() - Static method in class io.appium.java_client.ios.IOSStopScreenRecordingOptions
 
stopSyslogBroadcast() - Method in interface io.appium.java_client.ios.ListensToSyslogMessages
Stops syslog messages broadcast via web socket.
storeVisualization(File) - Method in class io.appium.java_client.imagecomparison.ComparisonResult
Stores visualization image into the given file.
stream() - Method in class io.appium.java_client.remote.NewAppiumSessionPayload
Stream the Capabilities encoded in the payload used to create this instance.
StringWebSocketClient - Class in io.appium.java_client.ws
 
StringWebSocketClient() - Constructor for class io.appium.java_client.ws.StringWebSocketClient
 
submit() - Method in interface org.openqa.selenium.WebElement
If this current element is a form, or an element within a form, then this will be submitted to the remote server.
substituteMobilePlatform(Capabilities, String) - Static method in class io.appium.java_client.AppiumDriver
Changes platform name and returns new capabilities.
SupportsNetworkStateManagement - Interface in io.appium.java_client.android
 
SupportsSpecialEmulatorCommands - Interface in io.appium.java_client.android
 
switchTo() - Method in class io.appium.java_client.ios.IOSDriver
 
switchTo() - Method in interface org.openqa.selenium.WebDriver
Send future commands to a different frame or window.
SYSTEM_PORT - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
The port number, which being used by UIAutomator2.

T

tap(TapOptions) - Method in class io.appium.java_client.TouchAction
Tap on an element.
tap(PointOption) - Method in class io.appium.java_client.TouchAction
Tap on a position.
TAP_OUTSIDE - Static variable in interface io.appium.java_client.remote.HideKeyboardStrategy
 
TAP_WITH_SHORT_PRESS_DURATION - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
The desired capability to specify a length for tapping, if the regular tap is too long for the app under test.
TapOptions - Class in io.appium.java_client.touch
 
TapOptions() - Constructor for class io.appium.java_client.touch.TapOptions
 
tapOptions() - Static method in class io.appium.java_client.touch.TapOptions
It creates an empty instance of TapOptions.
TERMINATE_APP - Static variable in class io.appium.java_client.MobileCommand
 
terminateApp(String) - Method in interface io.appium.java_client.InteractsWithApps
Terminate the particular application if it is running.
terminateApp(String, BaseTerminateApplicationOptions) - Method in interface io.appium.java_client.InteractsWithApps
Terminate the particular application if it is running.
timeouts() - Method in interface org.openqa.selenium.WebDriver.Options
 
to(String) - Method in interface org.openqa.selenium.WebDriver.Navigation
Load a new web page in the current browser window.
to(URL) - Method in interface org.openqa.selenium.WebDriver.Navigation
Overloaded version of WebDriver.Navigation.to(String) that makes it easy to pass in a URL.
TOGGLE_AIRPLANE_MODE - Static variable in class io.appium.java_client.MobileCommand
 
TOGGLE_DATA - Static variable in class io.appium.java_client.MobileCommand
 
TOGGLE_LOCATION_SERVICES - Static variable in class io.appium.java_client.MobileCommand
 
TOGGLE_WIFI - Static variable in class io.appium.java_client.MobileCommand
 
toggleAirplaneCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the toggle airplane mode.
toggleAirplaneMode() - Method in interface io.appium.java_client.android.SupportsNetworkStateManagement
Toggle Airplane mode and this works on OS 6.0 and lesser and does not work on OS 7.0 and greater
toggleData() - Method in interface io.appium.java_client.android.SupportsNetworkStateManagement
Toggle Mobile Data and this works on Emulator and rooted device.
toggleDataCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the toggle data.
toggleLocationServices() - Method in class io.appium.java_client.android.AndroidDriver
 
toggleLocationServicesCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the toggling of location services.
toggleTouchIDEnrollment(boolean) - Method in interface io.appium.java_client.ios.PerformsTouchID
Enrolls touchId in iOS Simulators.
toggleTouchIdEnrollmentCommand(boolean) - Static method in class io.appium.java_client.ios.IOSMobileCommandHelper
This method forms a Map of parameters for the toggling touchId enrollment in simulator.
toggleWifi() - Method in interface io.appium.java_client.android.SupportsNetworkStateManagement
Toggles Wifi on and off.
toggleWifiCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the toggling of wifi.
toStatusCode(Throwable) - Method in class io.appium.java_client.ErrorCodesMobile
Converts a thrown error into the corresponding status code.
toString() - Method in class io.appium.java_client.android.Activity
 
toString() - Method in enum io.appium.java_client.imagecomparison.ComparisonMode
 
toString() - Method in enum io.appium.java_client.imagecomparison.MatchingFunction
 
toString() - Method in class io.appium.java_client.MobileBy.ByAccessibilityId
 
toString() - Method in class io.appium.java_client.MobileBy.ByAndroidUIAutomator
 
toString() - Method in class io.appium.java_client.MobileBy.ByIosClassChain
 
toString() - Method in class io.appium.java_client.MobileBy.ByIosNsPredicate
 
toString() - Method in class io.appium.java_client.MobileBy.ByIosUIAutomation
 
toString() - Method in enum io.appium.java_client.MobileSelector
 
toString() - Method in class io.appium.java_client.pagefactory.bys.ContentMappedBy
 
toString() - Method in enum io.appium.java_client.Setting
 
TOUCH_ID - Static variable in class io.appium.java_client.MobileCommand
 
TOUCH_ID_ENROLLMENT - Static variable in class io.appium.java_client.MobileCommand
 
TouchAction<T extends TouchAction<T>> - Class in io.appium.java_client
Used for Webdriver 3 touch actions See the Webriver 3 spec https://dvcs.w3.org/hg/webdriver/raw-file/default/webdriver-spec.html The flow is to chain individual touch actions into an entire gesture. e.g.
TouchAction(PerformsTouchActions) - Constructor for class io.appium.java_client.TouchAction
 
TouchAction.ActionParameter - Class in io.appium.java_client
Just holds values to eventually return the parameters required for the mjsonwp.
touchIdCommand(boolean) - Static method in class io.appium.java_client.ios.IOSMobileCommandHelper
This method forms a Map of parameters for the touchId simulator.

U

UDID - Static variable in interface io.appium.java_client.remote.MobileCapabilityType
Unique device identifier of the connected physical device.
UNICODE_KEYBOARD - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Enable Unicode input, default false.
UNLOCK - Static variable in class io.appium.java_client.MobileCommand
 
unlockCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
This method forms a Map of parameters for the element.
unlockDevice() - Method in interface io.appium.java_client.LocksDevice
Unlock the device if it is locked.
unlockDeviceCommand() - Static method in class io.appium.java_client.MobileCommand
This method forms a Map of parameters for the device unlocking.
unpackWebDriverFromSearchContext(SearchContext) - Static method in class io.appium.java_client.pagefactory.utils.WebDriverUnpackUtility
This method extract an instance of WebDriver from the given SearchContext.
until(Function<? super T, V>) - Method in class io.appium.java_client.AppiumFluentWait
Repeatedly applies this instance's input value to the given function until one of the following occurs: the function returns neither null nor false, the function throws an unignored exception, the timeout expires, the current thread is interrupted .
UPDATE_WDA_BUNDLEID - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Bundle id to update WDA to before building and launching on real devices.
uploadOptions() - Static method in class io.appium.java_client.screenrecording.ScreenRecordingUploadOptions
 
USE_CARTHAGE_SSL - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Use SSL to download dependencies for WebDriverAgent.
USE_KEYSTORE - Static variable in interface io.appium.java_client.remote.AndroidMobileCapabilityType
Use a custom keystore to sign apks, default false.
USE_NEW_WDA - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Forces uninstall of any existing WebDriverAgent app on device.
USE_PREBUILT_WDA - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Skips the build phase of running the WDA app.
useContent(ContentType) - Method in class io.appium.java_client.pagefactory.bys.ContentMappedBy
This method sets required content type for the further searching.
usingAnyFreePort() - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
Configures the appium server to start on any available port.
usingDriverExecutable(File) - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
Sets which Node.js the builder will use.
usingPort(int) - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
Sets which port the appium server should be started on.

V

valueOf(String) - Static method in enum io.appium.java_client.android.AndroidBatteryInfo.BatteryState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.android.GsmCallActions
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.android.GsmSignalStrength
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.android.GsmVoiceState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.android.nativekey.AndroidKey
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.android.nativekey.KeyEventFlag
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.android.nativekey.KeyEventMetaModifier
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.android.NetworkSpeed
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.android.PowerACState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.appmanagement.ApplicationState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.clipboard.ClipboardContentType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.imagecomparison.ComparisonMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.imagecomparison.FeatureDetector
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.imagecomparison.MatchingFunction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.internal.ElementMap
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.ios.IOSBatteryInfo.BatteryState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.ios.IOSStartScreenRecordingOptions.VideoQuality
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.ios.IOSStartScreenRecordingOptions.VideoType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.MobileSelector
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.pagefactory.bys.builder.HowToUseSelectors
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.pagefactory.bys.ContentType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.pagefactory.LocatorGroupStrategy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.screenrecording.ScreenRecordingUploadOptions.RequestMethod
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.ScreenshotState.ResizeMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.service.local.flags.AndroidServerFlag
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.service.local.flags.GeneralServerFlag
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.service.local.flags.IOSServerFlag
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.Setting
Returns the enum constant of this type with the specified name.
values() - Static method in enum io.appium.java_client.android.AndroidBatteryInfo.BatteryState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.android.GsmCallActions
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.android.GsmSignalStrength
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.android.GsmVoiceState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.android.nativekey.AndroidKey
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.android.nativekey.KeyEventFlag
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.android.nativekey.KeyEventMetaModifier
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.android.NetworkSpeed
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.android.PowerACState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.appmanagement.ApplicationState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.clipboard.ClipboardContentType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.imagecomparison.ComparisonMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.imagecomparison.FeatureDetector
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.imagecomparison.MatchingFunction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.internal.ElementMap
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.ios.IOSBatteryInfo.BatteryState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.ios.IOSStartScreenRecordingOptions.VideoQuality
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.ios.IOSStartScreenRecordingOptions.VideoType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.MobileSelector
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.pagefactory.bys.builder.HowToUseSelectors
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.pagefactory.bys.ContentType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.pagefactory.LocatorGroupStrategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.screenrecording.ScreenRecordingUploadOptions.RequestMethod
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.ScreenshotState.ResizeMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.service.local.flags.AndroidServerFlag
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.service.local.flags.GeneralServerFlag
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.service.local.flags.IOSServerFlag
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum io.appium.java_client.Setting
Returns an array containing the constants of this enum type, in the order they are declared.
verify() - Method in class io.appium.java_client.touch.ActionOptions
This method is automatically called before building options map to verify the consistency of the instance.
verify() - Method in class io.appium.java_client.touch.offset.AbstractOptionCombinedWithPosition
 
verify() - Method in class io.appium.java_client.touch.offset.ElementOption
 
verify() - Method in class io.appium.java_client.touch.offset.PointOption
 
verify() - Method in class io.appium.java_client.touch.WaitOptions
 
verifyChanged(Duration, double) - Method in class io.appium.java_client.ScreenshotState
Verifies whether the state of the screenshot provided by stateProvider lambda function is changed within the given timeout.
verifyChanged(Duration, double, ScreenshotState.ResizeMode) - Method in class io.appium.java_client.ScreenshotState
Verifies whether the state of the screenshot provided by stateProvider lambda function is changed within the given timeout.
verifyNotChanged(Duration, double) - Method in class io.appium.java_client.ScreenshotState
Verifies whether the state of the screenshot provided by stateProvider lambda function is not changed within the given timeout.
verifyNotChanged(Duration, double, ScreenshotState.ResizeMode) - Method in class io.appium.java_client.ScreenshotState
Verifies whether the state of the screenshot provided by stateProvider lambda function is changed within the given timeout.
verifyPropertyPresence(String) - Method in class io.appium.java_client.imagecomparison.ComparisonResult
Verifies if the corresponding property is present in the commend result and throws an exception if not.
VOLUME_DOWN - Static variable in interface io.appium.java_client.windows.WindowsKeyCode
 
VOLUME_UP - Static variable in interface io.appium.java_client.windows.WindowsKeyCode
 

W

WAIT_FOR_APP_SCRIPT - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
The ios automation script used to determined if the app has been launched, by default the system wait for the page source not to be empty.
waitAction() - Method in class io.appium.java_client.TouchAction
A wait action, used as a NOP in multi-chaining.
waitAction(WaitOptions) - Method in class io.appium.java_client.TouchAction
Waits for specified amount of time to pass before continue to next touch action.
WaitOptions - Class in io.appium.java_client.touch
 
WaitOptions() - Constructor for class io.appium.java_client.touch.WaitOptions
 
waitOptions(Duration) - Static method in class io.appium.java_client.touch.WaitOptions
Creates and instance of WaitOptions.
WDA_CONNECTION_TIMEOUT - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Timeout, in ms, for waiting for a resonse from WebDriverAgent.
WDA_LAUNCH_TIMEOUT - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Time, in ms, to wait for WebDriverAgewnt to be pingable.
WDA_LOCAL_PORT - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
This value if specified, will be used to forward traffic from Mac host to real ios devices over USB.
WDA_STARTUP_RETRIES - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Number of times to try to build and launch WebDriverAgent onto the device.
WDA_STARTUP_RETRY_INTERVAL - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Time, in ms, to wait between tries to build and launch WebDriverAgent.
WEB_DRIVER_AGENT_URL - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Appium will connect to an existing WebDriverAgent, instance at this URL instead of starting a new one.
WebDriver - Interface in org.openqa.selenium
The main interface to use for testing, which represents an idealised web browser.
WebDriver.ImeHandler - Interface in org.openqa.selenium
An interface for managing input methods.
WebDriver.Navigation - Interface in org.openqa.selenium
 
WebDriver.Options - Interface in org.openqa.selenium
An interface for managing stuff you would do in a browser menu
WebDriver.TargetLocator - Interface in org.openqa.selenium
Used to locate a given frame or window.
WebDriver.Timeouts - Interface in org.openqa.selenium
An interface for managing timeout behavior for WebDriver instances.
WebDriver.Window - Interface in org.openqa.selenium
 
WebDriverUnpackUtility - Class in io.appium.java_client.pagefactory.utils
 
WebDriverUnpackUtility() - Constructor for class io.appium.java_client.pagefactory.utils.WebDriverUnpackUtility
 
WebElement - Interface in org.openqa.selenium
Represents an HTML element.
WEBVIEW_CONNECT_RETRIES - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Number of times to send connection message to remote debugger, to get webview.
Widget - Class in io.appium.java_client.pagefactory
It is the Appium-specific extension of the Page Object design pattern.
Widget(WebElement) - Constructor for class io.appium.java_client.pagefactory.Widget
 
WidgetByBuilder - Class in io.appium.java_client.pagefactory
 
WidgetByBuilder(String, String) - Constructor for class io.appium.java_client.pagefactory.WidgetByBuilder
 
WIFI_MASK - Static variable in class io.appium.java_client.android.connection.ConnectionState
 
window() - Method in interface org.openqa.selenium.WebDriver.Options
 
window(String) - Method in interface org.openqa.selenium.WebDriver.TargetLocator
Switch the focus of future commands for this driver to the window with the given name/handle.
WindowEventListener - Interface in io.appium.java_client.events.api.general
 
WINDOWS - Static variable in interface io.appium.java_client.remote.MobilePlatform
 
WINDOWS - Static variable in interface io.appium.java_client.windows.WindowsKeyCode
 
windowsAutomation(String) - Static method in class io.appium.java_client.MobileBy
 
WindowsBy - Annotation Type in io.appium.java_client.pagefactory
Used to build a complex Windows automation locator.
WindowsDriver<T extends WebElement> - Class in io.appium.java_client.windows
 
WindowsDriver(HttpCommandExecutor, Capabilities) - Constructor for class io.appium.java_client.windows.WindowsDriver
 
WindowsDriver(URL, Capabilities) - Constructor for class io.appium.java_client.windows.WindowsDriver
 
WindowsDriver(URL, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.windows.WindowsDriver
 
WindowsDriver(AppiumDriverLocalService, Capabilities) - Constructor for class io.appium.java_client.windows.WindowsDriver
 
WindowsDriver(AppiumDriverLocalService, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.windows.WindowsDriver
 
WindowsDriver(AppiumServiceBuilder, Capabilities) - Constructor for class io.appium.java_client.windows.WindowsDriver
 
WindowsDriver(AppiumServiceBuilder, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.windows.WindowsDriver
 
WindowsDriver(HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.windows.WindowsDriver
 
WindowsDriver(Capabilities) - Constructor for class io.appium.java_client.windows.WindowsDriver
 
WindowsElement - Class in io.appium.java_client.windows
 
WindowsElement() - Constructor for class io.appium.java_client.windows.WindowsElement
 
WindowsFindAll - Annotation Type in io.appium.java_client.pagefactory
Used to mark a field on a Page/Screen Object to indicate that lookup should use a series of WindowsBy tags It will then search for all elements that match any criteria.
WindowsFindBy - Annotation Type in io.appium.java_client.pagefactory
Used to mark a field on a Page Object to indicate an alternative mechanism for locating the element or a list of elements.
WindowsFindByAllSet - Annotation Type in io.appium.java_client.pagefactory
Defines set of chained/possible locators.
WindowsFindByChainSet - Annotation Type in io.appium.java_client.pagefactory
Defines set of chained/possible locators.
WindowsFindBys - Annotation Type in io.appium.java_client.pagefactory
Used to mark a field on a Page Object to indicate that lookup should use a series of WindowsBy tags.
WindowsFindBySet - Annotation Type in io.appium.java_client.pagefactory
Defines set of chained/possible locators.
WindowsKeyCode - Interface in io.appium.java_client.windows
Created by STikhomirov on 15.12.2016.
withAirplaneModeDisabled() - Method in class io.appium.java_client.android.connection.ConnectionStateBuilder
Sets airplane mode to disabled state if it was enabled.
withAirplaneModeEnabled() - Method in class io.appium.java_client.android.connection.ConnectionStateBuilder
Sets airplane mode to enabled state if it was disabled.
withAllowTestPackagesDisabled() - Method in class io.appium.java_client.android.appmanagement.AndroidInstallApplicationOptions
Disables a possibility to install packages marked as test in the manifest (the default setting).
withAllowTestPackagesEnabled() - Method in class io.appium.java_client.android.appmanagement.AndroidInstallApplicationOptions
Allows to install packages marked as test in the manifest.
withAppiumJS(File) - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
Sets an executable appium.js.
withArgument(ServerArgument) - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
Boolean arguments have a special moment: the presence of an arguments means "true".
withArgument(ServerArgument, String) - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
Adds a server argument.
withAuthCredentials(String, String) - Method in class io.appium.java_client.screenrecording.ScreenRecordingUploadOptions
Sets the credentials for remote ftp/http authentication (if needed).
withBitRate(int) - Method in class io.appium.java_client.android.AndroidStartScreenRecordingOptions
The video bit rate for the video, in megabits per second.
withCapabilities(DesiredCapabilities) - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
Adds a desired capabilities.
withCoordinates(int, int) - Method in class io.appium.java_client.touch.offset.ElementOption
It defines x and y offset from the upper left corner of an element.
withCoordinates(int, int) - Method in class io.appium.java_client.touch.offset.PointOption
It defines x and y coordinates.
withDataDisabled() - Method in class io.appium.java_client.android.connection.ConnectionStateBuilder
Sets data connection mode to disabled state if it was enabled.
withDataEnabled() - Method in class io.appium.java_client.android.connection.ConnectionStateBuilder
Sets data connection mode to enabled state if it was disabled.
withDetectorName(FeatureDetector) - Method in class io.appium.java_client.imagecomparison.FeaturesMatchingOptions
Sets the detector name for features matching algorithm.
withDuration(Duration) - Method in class io.appium.java_client.touch.LongPressOptions
Set the long press duration.
withDuration(Duration) - Method in class io.appium.java_client.touch.WaitOptions
Set the wait duration.
withElement(ElementOption) - Method in class io.appium.java_client.touch.offset.AbstractOptionCombinedWithPosition
Most of touch action may use position which is relative to some element.
withElement(WebElement) - Method in class io.appium.java_client.touch.offset.ElementOption
This method sets the element as an option.
withEnabledVisualization() - Method in class io.appium.java_client.imagecomparison.BaseComparisonOptions
Makes the endpoint to return an image, which contains the visualized result of the corresponding picture matching operation.
withEnvironment(Map<String, String>) - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
Defines the environment for the launched appium server.
withFlag(KeyEventFlag) - Method in class io.appium.java_client.android.nativekey.KeyEvent
Adds the flag.
withGoodMatchesFactor(int) - Method in class io.appium.java_client.imagecomparison.FeaturesMatchingOptions
The maximum count of "good" matches (e. g. with minimal distances).
withGrantPermissionsDisabled() - Method in class io.appium.java_client.android.appmanagement.AndroidInstallApplicationOptions
Does not grant all the permissions requested in the application's manifest automatically after the installation is completed (the default behavior).
withGrantPermissionsEnabled() - Method in class io.appium.java_client.android.appmanagement.AndroidInstallApplicationOptions
Grants all the permissions requested in the application's manifest automatically after the installation is completed under Android 6+.
withHttpMethod(ScreenRecordingUploadOptions.RequestMethod) - Method in class io.appium.java_client.screenrecording.ScreenRecordingUploadOptions
Sets the method name for http(s) upload.
withIPAddress(String) - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
 
withKeepDataDisabled() - Method in class io.appium.java_client.android.appmanagement.AndroidRemoveApplicationOptions
Forces uninstall to delete the application data and caches (the default behavior).
withKeepDataEnabled() - Method in class io.appium.java_client.android.appmanagement.AndroidRemoveApplicationOptions
Forces uninstall to keep the application data and caches.
withKey(AndroidKey) - Method in class io.appium.java_client.android.nativekey.KeyEvent
Sets the key code.
withLogFile(File) - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
Configures the appium server to write log to the given file.
withMatchFunc(MatchingFunction) - Method in class io.appium.java_client.imagecomparison.FeaturesMatchingOptions
The name of the matching function.
withMetaModifier(KeyEventMetaModifier) - Method in class io.appium.java_client.android.nativekey.KeyEvent
Adds the meta modifier.
withPollingStrategy(Function<AppiumFluentWait.IterationInfo, Duration>) - Method in class io.appium.java_client.AppiumFluentWait
Sets the strategy for polling.
withPosition(PointOption) - Method in class io.appium.java_client.touch.offset.AbstractOptionCombinedWithPosition
Some actions may require coordinates.
withPressure(double) - Method in class io.appium.java_client.ios.touch.IOSPressOptions
Set the pressure value.
withRemotePath(String) - Method in class io.appium.java_client.screenrecording.ScreenRecordingUploadOptions
The path to the remote location, where the resulting video should be uploaded.
withReplaceDisabled() - Method in class io.appium.java_client.android.appmanagement.AndroidInstallApplicationOptions
Disables the possibility to upgrade/reinstall the application if it is already present on the device.
withReplaceEnabled() - Method in class io.appium.java_client.android.appmanagement.AndroidInstallApplicationOptions
Enables the possibility to upgrade/reinstall the application if it is already present on the device (the default behavior).
withStartUpTimeOut(long, TimeUnit) - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
Sets start up timeout.
withTapsCount(int) - Method in class io.appium.java_client.touch.TapOptions
Set the count of taps to perform.
withTimeLimit(Duration) - Method in class io.appium.java_client.android.AndroidStartScreenRecordingOptions
The maximum recording time.
withTimeLimit(Duration) - Method in class io.appium.java_client.ios.IOSStartScreenRecordingOptions
The maximum recording time.
withTimeLimit(Duration) - Method in class io.appium.java_client.screenrecording.BaseStartScreenRecordingOptions
The maximum recording time.
withTimeout(Duration) - Method in class io.appium.java_client.android.appmanagement.AndroidInstallApplicationOptions
The time to wait until the app is installed (60000ms by default).
withTimeout(Duration) - Method in class io.appium.java_client.android.appmanagement.AndroidRemoveApplicationOptions
The time to wait until the app is removed (20000ms by default).
withTimeout(Duration) - Method in class io.appium.java_client.android.appmanagement.AndroidTerminateApplicationOptions
The time to wait until the app is terminated (500ms by default).
WithTimeout - Annotation Type in io.appium.java_client.pagefactory
This annotation is used when some element waits for time that differs from defined by default.
WithTimeout.DurationBuilder - Class in io.appium.java_client.pagefactory
 
withUploadOptions(ScreenRecordingUploadOptions) - Method in class io.appium.java_client.screenrecording.BaseScreenRecordingOptions
Upload options set for the recorded screen capture.
withUploadOptions(ScreenRecordingUploadOptions) - Method in class io.appium.java_client.screenrecording.BaseStartScreenRecordingOptions
The remotePath upload option is the path to the remote location, where the resulting video should be uploaded.
withUploadOptions(ScreenRecordingUploadOptions) - Method in class io.appium.java_client.screenrecording.BaseStopScreenRecordingOptions
The remotePath upload option is the path to the remote location, where the resulting video should be uploaded.
withUseSdcardDisabled() - Method in class io.appium.java_client.android.appmanagement.AndroidInstallApplicationOptions
Forces the application to be installed to the internal memory (the default behavior).
withUseSdcardEnabled() - Method in class io.appium.java_client.android.appmanagement.AndroidInstallApplicationOptions
Forces the application to be installed of SD card instead of the internal memory.
withVideoQuality(IOSStartScreenRecordingOptions.VideoQuality) - Method in class io.appium.java_client.ios.IOSStartScreenRecordingOptions
The video encoding quality (low, medium, high, photo - defaults to medium).
withVideoSize(String) - Method in class io.appium.java_client.android.AndroidStartScreenRecordingOptions
The video size of the generated media file.
withVideoType(IOSStartScreenRecordingOptions.VideoType) - Method in class io.appium.java_client.ios.IOSStartScreenRecordingOptions
The format of the screen capture to be recorded.
withWiFiDisabled() - Method in class io.appium.java_client.android.connection.ConnectionStateBuilder
Sets Wi-Fi connection mode to disabled state if it was enabled.
withWiFiEnabled() - Method in class io.appium.java_client.android.connection.ConnectionStateBuilder
Sets Wi-Fi connection mode to enabled state if it was disabled.
writeTo(Appendable) - Method in class io.appium.java_client.remote.NewAppiumSessionPayload
Writes json capabilities to some appendable object.

X

XCODE_CONFIG_FILE - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Full path to an optional Xcode configuration file that specifies the code signing identity and team for running the WebDriverAgent on the real device.
XCODE_ORG_ID - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
Apple developer team identifier string.
XCODE_SIGNING_ID - Static variable in interface io.appium.java_client.remote.IOSMobileCapabilityType
String representing a signing certificate.

Y

YOUI_ENGINE - Static variable in interface io.appium.java_client.remote.AutomationName
 
YouiEngineCapabilityType - Interface in io.appium.java_client.remote
The list of youiengine-specific capabilities.
A B C D E F G H I J K L M N O P Q R S T U V W X Y 
Skip navigation links