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 Z 
All Classes All Packages

A

A - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'A' key.
ABSOLUTE_WEB_LOCATIONS_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsAbsoluteWebLocationsOption
 
absoluteWebLocations() - Method in interface io.appium.java_client.ios.options.webview.SupportsAbsoluteWebLocationsOption
Enforces Get Element Location to return coordinates relative to the page origin for web view elements.
AbstractOptionCombinedWithPosition<T extends AbstractOptionCombinedWithPosition<T>> - Class in io.appium.java_client.touch.offset
 
AbstractOptionCombinedWithPosition() - Constructor for class io.appium.java_client.touch.offset.AbstractOptionCombinedWithPosition
 
ACCEPT - io.appium.java_client.android.GsmCallActions
 
ACCEPT - io.appium.java_client.remote.options.UnhandledPromptBehavior
 
ACCEPT_AND_NOTIFY - io.appium.java_client.remote.options.UnhandledPromptBehavior
 
ACCEPT_INSECURE_CERTS_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsAcceptInsecureCertsOption
 
acceptInsecureCerts() - Method in interface io.appium.java_client.remote.options.SupportsAcceptInsecureCertsOption
Enforces untrusted and self-signed TLS certificates are implicitly trusted on navigation for the duration of the session.
accessibility() - Method in annotation type io.appium.java_client.pagefactory.AndroidBy
It an UI automation accessibility Id which is a convenient to Android.
accessibility() - Method in annotation type io.appium.java_client.pagefactory.AndroidFindBy
It an UI automation accessibility Id which is a convenient to Android.
accessibility() - Method in annotation type io.appium.java_client.pagefactory.iOSBy
It an UI automation accessibility Id which is a convenient to iOS.
accessibility() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITBy
It an UI automation accessibility Id which is a convenient to iOS.
accessibility() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITFindBy
It an UI automation accessibility Id which is a convenient to iOS.
accessibilityId(String) - Static method in class io.appium.java_client.AppiumBy
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
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
Deprecated.
 
ActionParameter(String, ActionOptions) - Constructor for class io.appium.java_client.TouchAction.ActionParameter
Deprecated.
 
ActionSupplier<T extends PerformsActions<?>> - Interface in io.appium.java_client.functions
Deprecated.
Use Supplier instead
ACTIVATE_APP - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
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.
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.
ACTIVITY_OPTIONS_OPTION - Static variable in interface io.appium.java_client.android.options.app.SupportsActivityOptionsOption
 
ActivityOptions - Class in io.appium.java_client.android.options.app
 
ActivityOptions() - Constructor for class io.appium.java_client.android.options.app.ActivityOptions
 
ActivityOptions(Map<String, Object>) - Constructor for class io.appium.java_client.android.options.app.ActivityOptions
 
ADB_EXEC_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.android.options.adb.SupportsAdbExecTimeoutOption
 
ADB_PORT_OPTION - Static variable in interface io.appium.java_client.android.options.adb.SupportsAdbPortOption
 
add(TouchAction) - Method in class io.appium.java_client.MultiTouchAction
Deprecated.
Add a TouchAction to this multi-touch gesture.
addCommand(HttpMethod, String, String) - Method in class io.appium.java_client.AppiumDriver
This method is used to add custom appium commands in Appium 2.0.
addConnectionHandler(Runnable) - Method in interface io.appium.java_client.ws.CanHandleConnects
Register a new message handler.
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.
ADDITIONAL_ANDROID_TEST_DEPENDENCIES - Static variable in class io.appium.java_client.android.options.server.EspressoBuildConfig
 
ADDITIONAL_APP_DEPENDENCIES - Static variable in class io.appium.java_client.android.options.server.EspressoBuildConfig
 
ADDITIONAL_WEBVIEW_BUNDLE_IDS_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsAdditionalWebviewBundleIdsOption
 
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.
addLogMessageConsumer(Consumer<String>) - Method in class io.appium.java_client.service.local.AppiumDriverLocalService
When a complete log message is available (from server output data), the specified Consumer is invoked with that log message.
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.
addSlf4jLogMessageConsumer(BiConsumer<String, Slf4jLogMessageContext>) - Method in class io.appium.java_client.service.local.AppiumDriverLocalService
When a complete log message is available (from server output data) that message is parsed for its slf4j context (logger name, logger level etc.) and the specified BiConsumer is invoked with the log message and slf4j context.
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.
afterCall(Object, Method, Object[], Object) - Method in interface io.appium.java_client.proxy.MethodCallListener
The callback to be invoked after any public method of the proxy is called.
AGAST - io.appium.java_client.imagecomparison.FeatureDetector
 
AIRPLANE_MODE_MASK - Static variable in class io.appium.java_client.android.connection.ConnectionState
 
AKAZE - io.appium.java_client.imagecomparison.FeatureDetector
 
alias(String, String) - Method in class io.appium.java_client.remote.AppiumW3CHttpCommandCodec
 
ALL_POSSIBLE - io.appium.java_client.pagefactory.LocatorGroupStrategy
 
ALLOW_DELAY_ADB_OPTION - Static variable in interface io.appium.java_client.android.options.adb.SupportsAllowDelayAdbOption
 
ALLOW_INSECURE - io.appium.java_client.service.local.flags.GeneralServerFlag
Allow a list of features which are considered insecure and must be turned on explicitly by system administrators.
ALLOW_INVISIBLE_ELEMENTS - io.appium.java_client.Setting
 
ALLOW_PROVISIONING_DEVICE_REGISTRATION_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsAllowProvisioningDeviceRegistrationOption
 
ALLOW_TEST_PACKAGES_OPTION - Static variable in interface io.appium.java_client.android.options.app.SupportsAllowTestPackagesOption
 
allowInvisibleElements(boolean) - Method in interface io.appium.java_client.android.HasAndroidSettings
Set whether the source output/xpath search should consider all elements, visible and invisible.
allowProvisioningDeviceRegistration() - Method in interface io.appium.java_client.ios.options.wda.SupportsAllowProvisioningDeviceRegistrationOption
Allows xcodebuild to register your destination device on the developer portal.
allowTestPackages() - Method in interface io.appium.java_client.android.options.app.SupportsAllowTestPackagesOption
Enables usage of packages built with the test flag for the automated testing (literally adds -t flag to the adb install command).
ALT_LEFT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Left Alt modifier key.
ALT_LEFT_ON - io.appium.java_client.android.nativekey.KeyEventMetaModifier
This mask is used to check whether the left ALT meta key is pressed.
ALT_LOCKED - io.appium.java_client.android.nativekey.KeyEventMetaModifier
ALT key locked.
ALT_MASK - io.appium.java_client.android.nativekey.KeyEventMetaModifier
ALT_ON - io.appium.java_client.android.nativekey.KeyEventMetaModifier
This mask is used to check whether one of the ALT meta keys is pressed.
ALT_RIGHT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Right Alt modifier key.
ALT_RIGHT_ON - io.appium.java_client.android.nativekey.KeyEventMetaModifier
This mask is used to check whether the right the ALT meta key is pressed.
amend(String, Object) - Method in interface io.appium.java_client.remote.options.CanSetCapability
Set a custom option.
amendParameters(String, Map<String, ?>) - Method in class io.appium.java_client.remote.AppiumW3CHttpCommandCodec
 
ANDROID - Static variable in interface io.appium.java_client.remote.MobileBrowserType
 
ANDROID - Static variable in interface io.appium.java_client.remote.MobilePlatform
 
ANDROID_INSTALL_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.android.options.app.SupportsAndroidInstallTimeoutOption
 
ANDROID_STORAGE_OPTION - Static variable in interface io.appium.java_client.gecko.options.SupportsAndroidStorageOption
 
ANDROID_UIAUTOMATOR2 - Static variable in interface io.appium.java_client.remote.AutomationName
 
androidAutomation() - Method in annotation type io.appium.java_client.pagefactory.HowToUseLocators
The strategy which defines how to use locators which are described by the AndroidFindBy annotation.
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.
androidDataMatcher() - Method in annotation type io.appium.java_client.pagefactory.AndroidFindBy
It is a desired data matcher expression.
androidDataMatcher(String) - Static method in class io.appium.java_client.AppiumBy
This locator strategy is only available in Espresso Driver mode.
AndroidDriver - Class in io.appium.java_client.android
Android driver implementation.
AndroidDriver(AppiumClientConfig, Capabilities) - Constructor for class io.appium.java_client.android.AndroidDriver
Creates a new instance based on the given ClientConfig 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(URL, String) - Constructor for class io.appium.java_client.android.AndroidDriver
This is a special constructor used to connect to a running driver instance.
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(Capabilities) - Constructor for class io.appium.java_client.android.AndroidDriver
Creates a new instance based on capabilities.
AndroidDriver(ClientConfig, Capabilities) - Constructor for class io.appium.java_client.android.AndroidDriver
Creates a new instance based on the given ClientConfig 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(HttpCommandExecutor, Capabilities) - Constructor for class io.appium.java_client.android.AndroidDriver
Creates a new instance based on command executor and capabilities.
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.
AndroidGeoLocation - Class in io.appium.java_client.android.geolocation
 
AndroidGeoLocation() - Constructor for class io.appium.java_client.android.geolocation.AndroidGeoLocation
Initializes AndroidLocation instance.
AndroidGeoLocation(double, double) - Constructor for class io.appium.java_client.android.geolocation.AndroidGeoLocation
Initializes AndroidLocation instance with longitude and latitude values.
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
 
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
Deprecated.
Touch actions are deprecated. Please use W3C Actions instead or the corresponding extension methods for the driver (if available). Check - https://www.youtube.com/watch?v=oAJ7jwMNFVU - https://appiumpro.com/editions/30-ios-specific-touch-action-methods - https://appiumpro.com/editions/29-automating-complex-gestures-with-the-w3c-actions-api for more details.
AndroidTouchAction(PerformsTouchActions) - Constructor for class io.appium.java_client.android.AndroidTouchAction
Deprecated.
 
androidUIAutomator() - Method in annotation type io.appium.java_client.pagefactory.OverrideWidget
This property is designed for Android native content.
androidUIAutomator(String) - Static method in class io.appium.java_client.AppiumBy
Refer to https://developer.android.com/training/testing/ui-automator
androidViewMatcher() - Method in annotation type io.appium.java_client.pagefactory.AndroidFindBy
It is a desired view matcher expression.
androidViewMatcher(String) - Static method in class io.appium.java_client.AppiumBy
This locator strategy is only available in Espresso Driver mode.
androidViewTag(String) - Static method in class io.appium.java_client.AppiumBy
This locator strategy is available in Espresso Driver mode.
andThen(Function<? super T, ? extends V>) - Method in interface io.appium.java_client.functions.AppiumFunction
Deprecated.
 
annotatedElementContainer - Variable in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
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
 
APOSTROPHE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: ''' (apostrophe) key.
APP_ACTIVITY_OPTION - Static variable in interface io.appium.java_client.android.options.app.SupportsAppActivityOption
 
APP_ARGUMENTS_OPTION - Static variable in interface io.appium.java_client.windows.options.SupportsAppArgumentsOption
 
APP_INSTALL_STRATEGY_OPTION - Static variable in interface io.appium.java_client.ios.options.app.SupportsAppInstallStrategyOption
 
APP_LOCALE_OPTION - Static variable in interface io.appium.java_client.android.options.localization.SupportsAppLocaleOption
 
APP_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsAppOption
 
APP_PACKAGE_OPTION - Static variable in interface io.appium.java_client.android.options.app.SupportsAppPackageOption
 
APP_PUSH_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.ios.options.app.SupportsAppPushTimeoutOption
 
APP_SWITCH - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: App switch key.
APP_TOP_LEVEL_WINDOW_OPTION - Static variable in interface io.appium.java_client.windows.options.SupportsAppTopLevelWindowOption
 
APP_WAIT_ACTIVITY_OPTION - Static variable in interface io.appium.java_client.android.options.app.SupportsAppWaitActivityOption
 
APP_WAIT_DURATION_OPTION - Static variable in interface io.appium.java_client.android.options.app.SupportsAppWaitDurationOption
 
APP_WAIT_FOR_LAUNCH_OPTION - Static variable in interface io.appium.java_client.android.options.app.SupportsAppWaitForLaunchOption
 
APP_WAIT_PACKAGE_OPTION - Static variable in interface io.appium.java_client.android.options.app.SupportsAppWaitPackageOption
 
APP_WORKING_DIR_OPTION - Static variable in interface io.appium.java_client.windows.options.SupportsAppWorkingDirOption
 
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_PREFIX - Static variable in class io.appium.java_client.internal.CapabilityHelpers
 
AppiumBy - Class in io.appium.java_client
 
AppiumBy(String, String, String) - Constructor for class io.appium.java_client.AppiumBy
 
AppiumBy.ByAccessibilityId - Class in io.appium.java_client
 
AppiumBy.ByAndroidDataMatcher - Class in io.appium.java_client
 
AppiumBy.ByAndroidUIAutomator - Class in io.appium.java_client
 
AppiumBy.ByAndroidViewMatcher - Class in io.appium.java_client
 
AppiumBy.ByAndroidViewTag - Class in io.appium.java_client
 
AppiumBy.ByClassName - Class in io.appium.java_client
 
AppiumBy.ByCustom - Class in io.appium.java_client
 
AppiumBy.ById - Class in io.appium.java_client
 
AppiumBy.ByImage - Class in io.appium.java_client
 
AppiumBy.ByIosClassChain - Class in io.appium.java_client
 
AppiumBy.ByIosNsPredicate - Class in io.appium.java_client
 
AppiumBy.ByName - Class in io.appium.java_client
 
AppiumByBuilder - Class in io.appium.java_client.pagefactory.bys.builder
It is the basic handler of Appium-specific page object annotations.
AppiumByBuilder(String, String) - Constructor for class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
AppiumClientConfig - Class in io.appium.java_client
A class to store the appium http client configuration.
AppiumClientConfig(URI, Duration, Duration, Filter, Proxy, Credentials, SSLContext, String, Boolean) - Constructor for class io.appium.java_client.AppiumClientConfig
Client side configuration.
AppiumCommandExecutor - Class in io.appium.java_client.remote
 
AppiumCommandExecutor(Map<String, CommandInfo>, AppiumClientConfig) - 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>, URL, AppiumClientConfig) - 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>, DriverService) - Constructor for class io.appium.java_client.remote.AppiumCommandExecutor
 
AppiumCommandExecutor(Map<String, CommandInfo>, DriverService, AppiumClientConfig) - Constructor for class io.appium.java_client.remote.AppiumCommandExecutor
 
AppiumCommandExecutor(Map<String, CommandInfo>, DriverService, HttpClient.Factory) - Constructor for class io.appium.java_client.remote.AppiumCommandExecutor
 
AppiumCommandExecutor(Map<String, CommandInfo>, DriverService, HttpClient.Factory, AppiumClientConfig) - Constructor for class io.appium.java_client.remote.AppiumCommandExecutor
Create an AppiumCommandExecutor instance.
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 - Class in io.appium.java_client
Default Appium driver implementation.
AppiumDriver(AppiumClientConfig, 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(URL, String, String) - Constructor for class io.appium.java_client.AppiumDriver
This is a special constructor used to connect to a running driver instance.
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(Capabilities) - Constructor for class io.appium.java_client.AppiumDriver
 
AppiumDriver(HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.AppiumDriver
 
AppiumDriver(HttpCommandExecutor, Capabilities) - Constructor for class io.appium.java_client.AppiumDriver
Creates a new instance based on command executor and capabilities.
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) - Constructor for class io.appium.java_client.pagefactory.AppiumFieldDecorator
 
AppiumFieldDecorator(SearchContext, Duration) - Constructor for class io.appium.java_client.pagefactory.AppiumFieldDecorator
Creates field decorator based on SearchContext and timeout duration.
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
Deprecated.
Use Function instead
AppiumIdempotencyFilter - Class in io.appium.java_client.internal.filters
 
AppiumIdempotencyFilter() - Constructor for class io.appium.java_client.internal.filters.AppiumIdempotencyFilter
 
AppiumNewSessionCommandPayload - Class in io.appium.java_client.remote
 
AppiumNewSessionCommandPayload(Capabilities) - Constructor for class io.appium.java_client.remote.AppiumNewSessionCommandPayload
Overrides the default new session behavior to only handle W3C capabilities.
AppiumProtocolHandshake - Class in io.appium.java_client.remote
 
AppiumProtocolHandshake() - Constructor for class io.appium.java_client.remote.AppiumProtocolHandshake
 
AppiumServerAvailabilityChecker - Class in io.appium.java_client.service.local
 
AppiumServerAvailabilityChecker() - Constructor for class io.appium.java_client.service.local.AppiumServerAvailabilityChecker
 
AppiumServerAvailabilityChecker.ConnectionError - Exception in io.appium.java_client.service.local
 
AppiumServerAvailabilityChecker.ConnectionTimeout - Exception in io.appium.java_client.service.local
 
AppiumServerHasNotBeenStartedLocallyException - Exception in io.appium.java_client.service.local
 
AppiumServerHasNotBeenStartedLocallyException(String) - Constructor for exception io.appium.java_client.service.local.AppiumServerHasNotBeenStartedLocallyException
 
AppiumServerHasNotBeenStartedLocallyException(String, Throwable) - Constructor for exception io.appium.java_client.service.local.AppiumServerHasNotBeenStartedLocallyException
 
AppiumServerHasNotBeenStartedLocallyException(Throwable) - 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
 
AppiumUserAgentFilter - Class in io.appium.java_client.internal.filters
Manage Appium Client configurations.
AppiumUserAgentFilter() - Constructor for class io.appium.java_client.internal.filters.AppiumUserAgentFilter
 
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.
AppleScriptData - Class in io.appium.java_client.mac.options
 
AppleScriptData() - Constructor for class io.appium.java_client.mac.options.AppleScriptData
 
AppleScriptData(Map<String, Object>) - Constructor for class io.appium.java_client.mac.options.AppleScriptData
 
ApplicationState - Enum in io.appium.java_client.appmanagement
 
AppLocale - Class in io.appium.java_client.android.options.localization
 
AppLocale() - Constructor for class io.appium.java_client.android.options.localization.AppLocale
 
AppLocale(Map<String, Object>) - Constructor for class io.appium.java_client.android.options.localization.AppLocale
 
apply(HttpHandler) - Method in class io.appium.java_client.internal.filters.AppiumIdempotencyFilter
 
apply(HttpHandler) - Method in class io.appium.java_client.internal.filters.AppiumUserAgentFilter
 
ARGUMENTS_OPTION - Static variable in interface io.appium.java_client.mac.options.SupportsArgumentsOption
 
asMap() - Method in class io.appium.java_client.remote.options.BaseOptions
 
assertExtensionExists(String) - Method in class io.appium.java_client.AppiumDriver
 
assertExtensionExists(String) - Method in interface io.appium.java_client.CanRememberExtensionPresence
Verifies if the given extension is not present in the list of absent extensions for the given driver instance.
assertValidAnnotations() - Method in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
assertValidAnnotations() - Method in class io.appium.java_client.pagefactory.DefaultElementByBuilder
 
assignOptionValue(String, Object) - Method in class io.appium.java_client.remote.options.BaseMapOptionData
Sets the given value on the data object.
ASSIST - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Assist key.
ASYNC_TRACE - io.appium.java_client.service.local.flags.GeneralServerFlag
Add long stack traces to log entries.
AT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '@' key.
authenticateAs(Credentials) - Method in class io.appium.java_client.AppiumClientConfig
 
AuthenticatesByFinger - Interface in io.appium.java_client.android
 
AUTO_ACCEPT_ALERTS_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsAutoAcceptAlertsOption
 
AUTO_DISMISS_ALERTS_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsAutoDismissAlertsOption
 
AUTO_GRANT_PERMISSIONS_OPTION - Static variable in interface io.appium.java_client.android.options.app.SupportsAutoGrantPermissionsOption
 
AUTO_WEB_VIEW_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsAutoWebViewOption
 
AUTO_WEBVIEW_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.android.options.context.SupportsAutoWebviewTimeoutOption
 
autoAcceptAlerts() - Method in interface io.appium.java_client.ios.options.wda.SupportsAutoAcceptAlertsOption
Enforce to accept all alerts automatically.
autoDismissAlerts() - Method in interface io.appium.java_client.ios.options.wda.SupportsAutoDismissAlertsOption
Enforce to dismiss all alerts automatically.
AUTODOWNLOAD_ENABLED - Static variable in interface io.appium.java_client.chromium.options.SupportsAutodownloadOption
 
autoGrantPermissions() - Method in interface io.appium.java_client.android.options.app.SupportsAutoGrantPermissionsOption
Enables granting of all the requested application permissions automatically when a test starts.
automation - Variable in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
AUTOMATION_NAME_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsAutomationNameOption
 
AutomationName - Interface in io.appium.java_client.remote
 
autoWebview() - Method in interface io.appium.java_client.remote.options.SupportsAutoWebViewOption
Set the app to move directly into Webview context.
AVD_ARGS_OPTION - Static variable in interface io.appium.java_client.android.options.avd.SupportsAvdArgsOption
 
AVD_ENV_OPTION - Static variable in interface io.appium.java_client.android.options.avd.SupportsAvdEnvOption
 
AVD_LAUNCH_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.android.options.avd.SupportsAvdLaunchTimeoutOption
 
AVD_OPTION - Static variable in interface io.appium.java_client.android.options.avd.SupportsAvdOption
 
AVD_READY_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.android.options.avd.SupportsAvdReadyTimeoutOption
 
AVR_INPUT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: A/V Receiver input key.
AVR_POWER - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: A/V Receiver power key.

B

B - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'B' key.
BACK - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Back key.
BACK_END_RETRIES - io.appium.java_client.service.local.flags.IOSServerFlag
How many times to retry launching Instruments before saying it crashed or timed out.
BACKSLASH - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '\' key.
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
 
BaseMapOptionData<T extends BaseMapOptionData<T>> - Class in io.appium.java_client.remote.options
 
BaseMapOptionData() - Constructor for class io.appium.java_client.remote.options.BaseMapOptionData
 
BaseMapOptionData(String) - Constructor for class io.appium.java_client.remote.options.BaseMapOptionData
 
BaseMapOptionData(Map<String, Object>) - Constructor for class io.appium.java_client.remote.options.BaseMapOptionData
 
BaseOptions<T extends BaseOptions<T>> - Class in io.appium.java_client.appmanagement
 
BaseOptions<T extends BaseOptions<T>> - Class in io.appium.java_client.remote.options
This class represents capabilities that are available in the base driver, e.g.
BaseOptions() - Constructor for class io.appium.java_client.appmanagement.BaseOptions
 
BaseOptions() - Constructor for class io.appium.java_client.remote.options.BaseOptions
Creates new instance with no preset capabilities.
BaseOptions(Map<String, ?>) - Constructor for class io.appium.java_client.remote.options.BaseOptions
Creates new instance with provided capabilities.
BaseOptions(Capabilities) - Constructor for class io.appium.java_client.remote.options.BaseOptions
Creates new instance with provided capabilities.
BASEPATH - io.appium.java_client.service.local.flags.GeneralServerFlag
Base path to use as the prefix for all webdriver routes running on this server.
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
 
baseUri(URI) - Method in class io.appium.java_client.AppiumClientConfig
 
baseUrl(URL) - Method in class io.appium.java_client.AppiumClientConfig
 
BatteryInfo - Class in io.appium.java_client.battery
 
BatteryInfo(Map<String, Object>) - Constructor for class io.appium.java_client.battery.BatteryInfo
 
beforeCall(Object, Method, Object[]) - Method in interface io.appium.java_client.proxy.MethodCallListener
The callback to be invoked before any public method of the proxy is called.
BOOKMARK - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Bookmark key.
BOOTSTRAP_PORT_NUMBER - io.appium.java_client.service.local.flags.AndroidServerFlag
Port to use on device to talk to Appium.
BOOTSTRAP_ROOT_OPTION - Static variable in interface io.appium.java_client.mac.options.SupportsBootstrapRootOption
 
BOUND_ELEMENTS_BY_INDEX - io.appium.java_client.Setting
 
BREAK - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Break / Pause key.
BRIGHTNESS_DOWN - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Brightness Down key.
BRIGHTNESS_UP - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Brightness Up key.
BRISK - io.appium.java_client.imagecomparison.FeatureDetector
 
BROADCAST_IP4_ADDRESS - Static variable in class io.appium.java_client.service.local.AppiumServiceBuilder
 
BROADCAST_IP6_ADDRESS - Static variable in class io.appium.java_client.service.local.AppiumServiceBuilder
 
BROWSER - Static variable in interface io.appium.java_client.remote.MobileBrowserType
 
BROWSER_NAME_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsBrowserNameOption
 
BROWSER_VERSION_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsBrowserVersionOption
 
BRUTE_FORCE - io.appium.java_client.imagecomparison.MatchingFunction
 
BRUTE_FORCE_HAMMING - io.appium.java_client.imagecomparison.MatchingFunction
 
BRUTE_FORCE_HAMMING_LUT - io.appium.java_client.imagecomparison.MatchingFunction
 
BRUTE_FORCE_SL2 - io.appium.java_client.imagecomparison.MatchingFunction
 
BRUTE_FORCE1 - io.appium.java_client.imagecomparison.MatchingFunction
 
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.geolocation.AndroidGeoLocation
Builds parameters map suitable for passing to the downstream API.
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.driverscripts.ScriptOptions
Builds a values map for further usage in HTTP requests to Appium.
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.imagecomparison.OccurrenceMatchingOptions
 
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.mac.Mac2StartScreenRecordingOptions
 
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
 
build() - Method in class io.appium.java_client.windows.WindowsStartScreenRecordingOptions
 
BUILD_CHAINED - io.appium.java_client.pagefactory.bys.builder.HowToUseSelectors
 
BUILD_TOOLS_VERSION_OPTION - Static variable in interface io.appium.java_client.android.options.adb.SupportsBuildToolsVersionOption
 
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
 
buildUserAgent(String) - Static method in class io.appium.java_client.internal.filters.AppiumUserAgentFilter
Returns the User Agent.
BUNDLE_ID_OPTION - Static variable in interface io.appium.java_client.ios.options.app.SupportsBundleIdOption
 
BUNDLE_ID_OPTION - Static variable in interface io.appium.java_client.mac.options.SupportsBundleIdOption
 
BUTTON_1 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic Game Pad Button #1.
BUTTON_10 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic Game Pad Button #10.
BUTTON_11 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic Game Pad Button #11.
BUTTON_12 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic Game Pad Button #12.
BUTTON_13 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic Game Pad Button #13.
BUTTON_14 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic Game Pad Button #14.
BUTTON_15 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic Game Pad Button #15.
BUTTON_16 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic Game Pad Button #16.
BUTTON_2 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic Game Pad Button #2.
BUTTON_3 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic Game Pad Button #3.
BUTTON_4 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic Game Pad Button #4.
BUTTON_5 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic Game Pad Button #5.
BUTTON_6 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic Game Pad Button #6.
BUTTON_7 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic Game Pad Button #7.
BUTTON_8 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic Game Pad Button #8.
BUTTON_9 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic Game Pad Button #9.
BUTTON_A - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: A Button key.
BUTTON_B - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: B Button key.
BUTTON_C - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: C Button key.
BUTTON_L1 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: L1 Button key.
BUTTON_L2 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: L2 Button key.
BUTTON_MODE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Mode Button key.
BUTTON_R1 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: R1 Button key.
BUTTON_R2 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: R2 Button key.
BUTTON_SELECT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Select Button key.
BUTTON_START - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Start Button key.
BUTTON_THUMBL - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Left Thumb Button key.
BUTTON_THUMBR - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Right Thumb Button key.
BUTTON_X - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: X Button key.
BUTTON_Y - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Y Button key.
BUTTON_Z - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Z Button key.
ByAccessibilityId(String) - Constructor for class io.appium.java_client.AppiumBy.ByAccessibilityId
 
ByAndroidDataMatcher(String) - Constructor for class io.appium.java_client.AppiumBy.ByAndroidDataMatcher
 
ByAndroidUIAutomator(String) - Constructor for class io.appium.java_client.AppiumBy.ByAndroidUIAutomator
 
ByAndroidViewMatcher(String) - Constructor for class io.appium.java_client.AppiumBy.ByAndroidViewMatcher
 
ByAndroidViewTag(String) - Constructor for class io.appium.java_client.AppiumBy.ByAndroidViewTag
 
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.
ByClassName(String) - Constructor for class io.appium.java_client.AppiumBy.ByClassName
 
ByCustom(String) - Constructor for class io.appium.java_client.AppiumBy.ByCustom
 
ById(String) - Constructor for class io.appium.java_client.AppiumBy.ById
 
ByImage(String) - Constructor for class io.appium.java_client.AppiumBy.ByImage
 
ByIosClassChain(String) - Constructor for class io.appium.java_client.AppiumBy.ByIosClassChain
 
ByIosNsPredicate(String) - Constructor for class io.appium.java_client.AppiumBy.ByIosNsPredicate
 
ByName(String) - Constructor for class io.appium.java_client.AppiumBy.ByName
 

C

C - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'C' key.
CacheableElementLocatorFactory - Interface in io.appium.java_client.pagefactory.locator
 
CacheableLocator - Interface in io.appium.java_client.pagefactory.locator
 
CALCULATOR - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Calculator special function key.
CALENDAR - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Calendar special function key.
CALENDAR_ACCESS_AUTHORIZED_OPTION - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsCalendarAccessAuthorizedOption
 
CALENDAR_FORMAT_OPTION - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsCalendarFormatOption
 
calendarAccessAuthorized() - Method in interface io.appium.java_client.ios.options.simulator.SupportsCalendarAccessAuthorizedOption
Enable calendar access on IOS Simulator.
call(Object, Method, Object[], Callable<?>) - Method in class io.appium.java_client.pagefactory.interceptors.InterceptorOfAListOfElements
 
call(Object, Method, Object[], Callable<?>) - Method in class io.appium.java_client.pagefactory.interceptors.InterceptorOfASingleElement
 
call(Object, Method, Object[], Callable<?>) - Method in class io.appium.java_client.pagefactory.WidgetInterceptor
 
call(Object, Method, Object[], Callable<?>) - Method in interface io.appium.java_client.proxy.MethodCallListener
Override this callback in order to change/customize the behavior of a single or multiple methods.
CALL - io.appium.java_client.android.GsmCallActions
 
CALL - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Call key.
CALLBACK_ADDRESS - io.appium.java_client.service.local.flags.GeneralServerFlag
callback IP Address (default: same as address).
CALLBACK_PORT - io.appium.java_client.service.local.flags.GeneralServerFlag
callback port (default: same as port).
CAMERA - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Camera key.
cancel() - Method in class io.appium.java_client.TouchAction
Deprecated.
Cancel this action, if it was partially completed by the performsTouchActions.
CANCEL - io.appium.java_client.android.GsmCallActions
 
CANCELED - io.appium.java_client.android.nativekey.KeyEventFlag
When associated with up key events, this indicates that the key press has been canceled.
CANCELED_LONG_PRESS - io.appium.java_client.android.nativekey.KeyEventFlag
Set when a key event has KeyEventFlag.CANCELED set because a long press action was executed while it was down.
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
 
CanRememberExtensionPresence - Interface in io.appium.java_client
 
CanReplaceElementValue - Interface in io.appium.java_client.android
 
CanSetCapability<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
CAP_LOCKED - io.appium.java_client.android.nativekey.KeyEventMetaModifier
SHIFT key locked in CAPS mode.
CapabilityHelpers - Class in io.appium.java_client.internal
 
CAPS_LOCK - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Caps Lock key.
CAPS_LOCK_ON - io.appium.java_client.android.nativekey.KeyEventMetaModifier
This mask is used to check whether the CAPS LOCK meta key is on.
CAPTIONS - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Toggle captions key.
CHAIN - io.appium.java_client.pagefactory.LocatorGroupStrategy
 
CHANNEL_DOWN - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Channel down key.
CHANNEL_UP - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Channel up key.
CHARGING - io.appium.java_client.android.AndroidBatteryInfo.BatteryState
 
CHARGING - io.appium.java_client.ios.IOSBatteryInfo.BatteryState
 
CHECK_IMAGE_ELEMENT_STALENESS - io.appium.java_client.Setting
 
CHROME - Static variable in interface io.appium.java_client.remote.MobileBrowserType
 
CHROME_DRIVER_EXECUTABLE - io.appium.java_client.service.local.flags.AndroidServerFlag
ChromeDriver executable full path.
CHROME_DRIVER_PORT - io.appium.java_client.service.local.flags.AndroidServerFlag
Port upon which ChromeDriver will run.
CHROME_DRIVER_PORT - Static variable in interface io.appium.java_client.chromium.options.SupportsChromeDrivePortOption
 
CHROME_LOGGING_PREFS_OPTION - Static variable in interface io.appium.java_client.android.options.context.SupportsChromeLoggingPrefsOption
 
CHROME_OPTIONS_OPTION - Static variable in interface io.appium.java_client.android.options.context.SupportsChromeOptionsOption
 
CHROMEDRIVER_ARGS_OPTION - Static variable in interface io.appium.java_client.android.options.context.SupportsChromedriverArgsOption
 
CHROMEDRIVER_CHROME_MAPPING_FILE_OPTION - Static variable in interface io.appium.java_client.android.options.context.SupportsChromedriverChromeMappingFileOption
 
CHROMEDRIVER_DISABLE_BUILD_CHECK_OPTION - Static variable in interface io.appium.java_client.android.options.context.SupportsChromedriverDisableBuildCheckOption
 
CHROMEDRIVER_EXECUTABLE_DIR_OPTION - Static variable in interface io.appium.java_client.android.options.context.SupportsChromedriverExecutableDirOption
 
CHROMEDRIVER_EXECUTABLE_OPTION - Static variable in interface io.appium.java_client.android.options.context.SupportsChromedriverExecutableOption
 
CHROMEDRIVER_PORT_OPTION - Static variable in interface io.appium.java_client.android.options.context.SupportsChromedriverPortOption
 
CHROMEDRIVER_PORTS_OPTION - Static variable in interface io.appium.java_client.android.options.context.SupportsChromedriverPortsOption
 
CHROMEDRIVER_USE_SYSTEM_EXECUTABLE_OPTION - Static variable in interface io.appium.java_client.android.options.context.SupportsChromedriverUseSystemExecutableOption
 
chromedriverDisableBuildCheck() - Method in interface io.appium.java_client.android.options.context.SupportsChromedriverDisableBuildCheckOption
Disables the compatibility validation between the current chromedriver and the destination browser/web view.
chromedriverUseSystemExecutable() - Method in interface io.appium.java_client.android.options.context.SupportsChromedriverUseSystemExecutableOption
Enforce the usage of chromedriver, which gets downloaded by Appium automatically upon installation.
CHROMIUM - Static variable in interface io.appium.java_client.remote.AutomationName
 
CHROMIUM - Static variable in interface io.appium.java_client.remote.MobileBrowserType
 
ChromiumDriver - Class in io.appium.java_client.chromium
ChromiumDriver is an officially supported Appium driver created to automate Mobile browsers and web views based on the Chromium engine.
ChromiumDriver(AppiumClientConfig, Capabilities) - Constructor for class io.appium.java_client.chromium.ChromiumDriver
Creates a new instance based on the given ClientConfig and capabilities.
ChromiumDriver(AppiumDriverLocalService, Capabilities) - Constructor for class io.appium.java_client.chromium.ChromiumDriver
 
ChromiumDriver(AppiumDriverLocalService, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.chromium.ChromiumDriver
 
ChromiumDriver(AppiumServiceBuilder, Capabilities) - Constructor for class io.appium.java_client.chromium.ChromiumDriver
 
ChromiumDriver(AppiumServiceBuilder, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.chromium.ChromiumDriver
 
ChromiumDriver(URL, String) - Constructor for class io.appium.java_client.chromium.ChromiumDriver
This is a special constructor used to connect to a running driver instance.
ChromiumDriver(URL, Capabilities) - Constructor for class io.appium.java_client.chromium.ChromiumDriver
 
ChromiumDriver(URL, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.chromium.ChromiumDriver
 
ChromiumDriver(Capabilities) - Constructor for class io.appium.java_client.chromium.ChromiumDriver
 
ChromiumDriver(ClientConfig, Capabilities) - Constructor for class io.appium.java_client.chromium.ChromiumDriver
Creates a new instance based on the given ClientConfig and capabilities.
ChromiumDriver(HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.chromium.ChromiumDriver
 
ChromiumDriver(HttpCommandExecutor, Capabilities) - Constructor for class io.appium.java_client.chromium.ChromiumDriver
 
ChromiumOptions - Class in io.appium.java_client.chromium.options
Options class that sets options for Chromium when testing websites.
ChromiumOptions() - Constructor for class io.appium.java_client.chromium.options.ChromiumOptions
 
ChromiumOptions(Map<String, ?>) - Constructor for class io.appium.java_client.chromium.options.ChromiumOptions
 
ChromiumOptions(Capabilities) - Constructor for class io.appium.java_client.chromium.options.ChromiumOptions
 
chronoUnit() - Method in annotation type io.appium.java_client.pagefactory.WithTimeout
Desired time unit.
className() - Method in annotation type io.appium.java_client.pagefactory.AndroidBy
It is a className of the target element.
className() - Method in annotation type io.appium.java_client.pagefactory.AndroidFindBy
It is a className of the target element.
className() - Method in annotation type io.appium.java_client.pagefactory.iOSBy
It is a name of a type/class of the target element.
className() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITBy
It is a name of a type/class of the target element.
className() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITFindBy
It is a name of a type/class of the target element.
className(String) - Static method in class io.appium.java_client.AppiumBy
For IOS it is the full name of the XCUI element and begins with XCUIElementType.
CLEAR - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Clear key.
CLEAR_DEVICE_LOGS_ON_START_OPTION - Static variable in interface io.appium.java_client.android.options.adb.SupportsClearDeviceLogsOnStartOption
 
CLEAR_SYSTEM_FILES_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsClearSystemFilesOption
 
clearActions() - Method in class io.appium.java_client.MultiTouchAction
Deprecated.
Clears all the existing touch actions and resets the instance to the initial state.
clearDeviceLogsOnStart() - Method in interface io.appium.java_client.android.options.adb.SupportsClearDeviceLogsOnStartOption
Makes UiAutomator2 to delete all the existing logs in the device buffer before starting a new test.
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
Deprecated.
Clears all the existing action parameters and resets the instance to the initial state.
clearSystemFiles() - Method in interface io.appium.java_client.remote.options.SupportsClearSystemFilesOption
Set the app to delete any generated files at the end of a session.
ClipboardContentType - Enum in io.appium.java_client.clipboard
 
clone() - Method in class io.appium.java_client.remote.options.BaseOptions
Makes a deep clone of the current Options instance.
CLOSE_APP - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
closeApp() - Method in class io.appium.java_client.windows.WindowsDriver
Close the app under test.
COMMA - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: ',' key.
COMMAND_TIMEOUTS_OPTION - Static variable in interface io.appium.java_client.ios.options.other.SupportsCommandTimeoutsOption
 
CommandEvent - Class in io.appium.java_client.serverevents
 
CommandEvent() - Constructor for class io.appium.java_client.serverevents.CommandEvent
 
CommandExecutionHelper - Class in io.appium.java_client
 
commandRepository - Static variable in class io.appium.java_client.MobileCommand
 
commands - Variable in class io.appium.java_client.serverevents.ServerEvents
 
CommandTimeouts - Class in io.appium.java_client.ios.options.other
 
CommandTimeouts() - Constructor for class io.appium.java_client.ios.options.other.CommandTimeouts
 
CommandTimeouts(String) - Constructor for class io.appium.java_client.ios.options.other.CommandTimeouts
 
CommandTimeouts(Map<String, Object>) - Constructor for class io.appium.java_client.ios.options.other.CommandTimeouts
 
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
Deprecated.
 
Config - Class in io.appium.java_client.internal
 
CONFIGURATION_FILE - io.appium.java_client.service.local.flags.GeneralServerFlag
Configuration JSON file to register Appium with selenium grid.
configuratorSetActionAcknowledgmentTimeout(Duration) - Method in interface io.appium.java_client.android.HasAndroidSettings
invoke setActionAcknowledgmentTimeout in com.android.uiautomator.core.Configurator.
configuratorSetKeyInjectionDelay(Duration) - Method in interface io.appium.java_client.android.HasAndroidSettings
invoke configuratorSetKeyInjectionDelay in com.android.uiautomator.core.Configurator.
configuratorSetScrollAcknowledgmentTimeout(Duration) - Method in interface io.appium.java_client.android.HasAndroidSettings
invoke setScrollAcknowledgmentTimeout in com.android.uiautomator.core.Configurator.
configuratorSetWaitForIdleTimeout(Duration) - Method in interface io.appium.java_client.android.HasAndroidSettings
invoke setWaitForIdleTimeout in com.android.uiautomator.core.Configurator.
configuratorSetWaitForSelectorTimeout(Duration) - Method in interface io.appium.java_client.android.HasAndroidSettings
invoke setWaitForSelectorTimeout in com.android.uiautomator.core.Configurator.
connect(URI) - Method in class io.appium.java_client.ws.StringWebSocketClient
Connects web socket client.
CONNECT_HARDWARE_KEYBOARD_OPTION - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsConnectHardwareKeyboardOption
 
connectHardwareKeyboard() - Method in interface io.appium.java_client.ios.options.simulator.SupportsConnectHardwareKeyboardOption
Enforce connecting of hardware keyboard to Simulator.
ConnectionError(URL, int, InputStream) - Constructor for exception io.appium.java_client.service.local.AppiumServerAvailabilityChecker.ConnectionError
Thrown on server connection errors.
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.
connectionTimeout(Duration) - Method in class io.appium.java_client.AppiumClientConfig
 
ConnectionTimeout(Duration, Throwable) - Constructor for exception io.appium.java_client.service.local.AppiumServerAvailabilityChecker.ConnectionTimeout
Thrown on server timeout errors.
CONTACTS - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Contacts special function key.
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 interface io.appium.java_client.remote.SupportsContextSwitching
Switches to the given context.
coordinates - Variable in class io.appium.java_client.touch.offset.PointOption
 
COPY - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Copy key.
CREATE_SESSION_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.windows.options.SupportsCreateSessionTimeoutOption
 
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
 
createDriverService(File, int, Duration, List<String>, Map<String, String>) - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
 
createLocator(AnnotatedElement) - Method in class io.appium.java_client.pagefactory.AppiumElementLocatorFactory
 
createLocator(AnnotatedElement) - Method in interface io.appium.java_client.pagefactory.locator.CacheableElementLocatorFactory
 
createLocator(Field) - Method in class io.appium.java_client.pagefactory.AppiumElementLocatorFactory
 
createLocator(Field) - Method in interface io.appium.java_client.pagefactory.locator.CacheableElementLocatorFactory
 
createProxy(Class<T>, MethodCallListener) - Static method in class io.appium.java_client.proxy.Helpers
Creates a transparent proxy instance for the given class.
createProxy(Class<T>, Object[], Class<?>[], MethodCallListener) - Static method in class io.appium.java_client.proxy.Helpers
Creates a transparent proxy instance for the given class.
createProxy(Class<T>, Object[], Class<?>[], Collection<MethodCallListener>) - Static method in class io.appium.java_client.proxy.Helpers
Creates a transparent proxy instance for the given class.
createProxy(Class<T>, Object[], Class<?>[], Collection<MethodCallListener>, ElementMatcher<MethodDescription>) - Static method in class io.appium.java_client.proxy.Helpers
Creates a transparent proxy instance for the given class.
createProxy(Class<T>, Collection<MethodCallListener>) - Static method in class io.appium.java_client.proxy.Helpers
Creates a transparent proxy instance for the given class.
createSession(HttpHandler, Command) - Method in class io.appium.java_client.remote.AppiumProtocolHandshake
 
createSession(HttpHandler, NewSessionPayload) - Method in class io.appium.java_client.remote.AppiumProtocolHandshake
 
CTRL_LEFT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Left Control modifier key.
CTRL_LEFT_ON - io.appium.java_client.android.nativekey.KeyEventMetaModifier
This mask is used to check whether the left CTRL meta key is pressed.
CTRL_MASK - io.appium.java_client.android.nativekey.KeyEventMetaModifier
CTRL_ON - io.appium.java_client.android.nativekey.KeyEventMetaModifier
This mask is used to check whether one of the CTRL meta keys is pressed.
CTRL_RIGHT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Right Control modifier key.
CTRL_RIGHT_ON - io.appium.java_client.android.nativekey.KeyEventMetaModifier
This mask is used to check whether the right CTRL meta key is pressed.
CURRENT_ACTIVITY - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
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
Deprecated.
currentPackageCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
Deprecated.
custom(String) - Static method in class io.appium.java_client.AppiumBy
This type of locator requires the use of the 'customFindModules' capability and a separately-installed element finding plugin.
CUSTOM_INSTRUMENTS_PATH - io.appium.java_client.service.local.flags.IOSServerFlag
custom path to the instruments commandline tool.
CUSTOM_SSLCERT_OPTION - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsCustomSslCertOption
 
CustomEvent - Class in io.appium.java_client.serverevents
 
CustomEvent() - Constructor for class io.appium.java_client.serverevents.CustomEvent
 
CUT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Cut key.

D

D - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'D' key.
DATA_MASK - Static variable in class io.appium.java_client.android.connection.ConnectionState
 
DEBUG - io.appium.java_client.gecko.options.Verbosity
 
DEBUG_LOG_SPACING - io.appium.java_client.service.local.flags.GeneralServerFlag
Add exaggerated spacing in logs to help with visual inspection.
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_COMMAND - Static variable in class io.appium.java_client.ios.options.other.CommandTimeouts
 
DEFAULT_DEVICE - io.appium.java_client.service.local.flags.IOSServerFlag
use the default simulator that instruments launches on its own.
DEFAULT_IMAGE_TEMPLATE_SCALE - io.appium.java_client.Setting
 
DEFAULT_WAITING_TIMEOUT - Static variable in class io.appium.java_client.pagefactory.AppiumFieldDecorator
 
DEFAULT_XCODE_SIGNING_ID - Static variable in interface io.appium.java_client.ios.options.wda.SupportsXcodeCertificateOptions
 
defaultConfig() - Static method in class io.appium.java_client.AppiumClientConfig
Return the instance of AppiumClientConfig with a default config.
DefaultElementByBuilder - Class in io.appium.java_client.pagefactory
 
DefaultElementByBuilder(String, String) - Constructor for class io.appium.java_client.pagefactory.DefaultElementByBuilder
 
DEL - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Backspace key.
deleteC(String) - Static method in class io.appium.java_client.MobileCommand
This methods forms DELETE commands.
DENIED - io.appium.java_client.android.GsmVoiceState
 
DENY_INSECURE - io.appium.java_client.service.local.flags.GeneralServerFlag
Specify a list of features which will never be allowed to run, even if --relaxed-security is turned on, and even if feature names are listed with --allow-insecure.
DERIVED_DATA_PATH_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsDerivedDataPathOption
 
DEVICE_NAME_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsDeviceNameOption
 
DIGIT_0 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '0' key.
DIGIT_1 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '1' key.
DIGIT_2 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '2' key.
DIGIT_3 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '3' key.
DIGIT_4 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '4' key.
DIGIT_5 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '5' key.
DIGIT_6 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '6' key.
DIGIT_7 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '7' key.
DIGIT_8 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '8' key.
DIGIT_9 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '9' key.
directConnect(boolean) - Method in class io.appium.java_client.AppiumClientConfig
Whether enable directConnect feature described in Connecting Directly to Appium Hosts in Distributed Environments.
DirectConnect - Class in io.appium.java_client.remote
 
DirectConnect(Map<String, ?>) - Constructor for class io.appium.java_client.remote.DirectConnect
Create a DirectConnect instance.
DISABLE_AUTOMATIC_SCREENSHOTS_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsDisableAutomaticScreenshotsOption
 
DISABLE_BUILD_CHECK - Static variable in interface io.appium.java_client.chromium.options.SupportsBuildCheckOption
 
DISABLE_SUPPRESS_ACCESSIBILITY_SERVICE_OPTION - Static variable in interface io.appium.java_client.android.options.other.SupportsDisableSuppressAccessibilityServiceOption
 
DISABLE_WINDOWS_ANIMATION_OPTION - Static variable in interface io.appium.java_client.android.options.server.SupportsDisableWindowAnimationOption
 
disableForcedRestart() - Method in class io.appium.java_client.screenrecording.BaseStartScreenRecordingOptions
Whether to return silently if there is an active video recording.
disableSuppressAccessibilityService() - Method in interface io.appium.java_client.android.options.other.SupportsDisableSuppressAccessibilityServiceOption
Tells the instrumentation process to not suppress accessibility services during the automated test.
disableWindowAnimation() - Method in interface io.appium.java_client.android.options.server.SupportsDisableWindowAnimationOption
Disables window animations when starting the instrumentation process.
DISCHARGING - io.appium.java_client.android.AndroidBatteryInfo.BatteryState
 
DISMISS - io.appium.java_client.remote.options.UnhandledPromptBehavior
 
DISMISS_AND_NOTIFY - io.appium.java_client.remote.options.UnhandledPromptBehavior
 
doesAbsoluteWebLocations() - Method in interface io.appium.java_client.ios.options.webview.SupportsAbsoluteWebLocationsOption
Get whether Get Element Location returns coordinates relative to the page origin for web view elements.
doesAcceptInsecureCerts() - Method in interface io.appium.java_client.remote.options.SupportsAcceptInsecureCertsOption
Get whether untrusted and self-signed TLS certificates are implicitly trusted on navigation for the duration of the session.
doesAllowDelayAdb() - Method in interface io.appium.java_client.android.options.adb.SupportsAllowDelayAdbOption
Get whether to prevent the emulator to use -delay-adb feature.
doesAllowProvisioningDeviceRegistration() - Method in interface io.appium.java_client.ios.options.wda.SupportsAllowProvisioningDeviceRegistrationOption
Get whether to allow xcodebuild to register your destination device on the developer portal.
doesAllowTestPackages() - Method in interface io.appium.java_client.android.options.app.SupportsAllowTestPackagesOption
Get whether it is possible to use packages built with the test flag for the automated testing (literally adds -t flag to the adb install command).
doesAppWaitForLaunch() - Method in interface io.appium.java_client.android.options.app.SupportsAppWaitForLaunchOption
Get whether to block until the app under test returns the control to the caller after its activity has been started by Activity Manager.
doesAutoAcceptAlerts() - Method in interface io.appium.java_client.ios.options.wda.SupportsAutoAcceptAlertsOption
Get whether to accept all alerts automatically.
doesAutoDismissAlerts() - Method in interface io.appium.java_client.ios.options.wda.SupportsAutoDismissAlertsOption
Get whether to dismiss all alerts automatically.
doesAutoGrantPermissions() - Method in interface io.appium.java_client.android.options.app.SupportsAutoGrantPermissionsOption
Get whether to grant all the requested application permissions automatically when a test starts.
doesAutoWebview() - Method in interface io.appium.java_client.remote.options.SupportsAutoWebViewOption
Get whether the app moves directly into Webview context.
doesCalendarAccessAuthorized() - Method in interface io.appium.java_client.ios.options.simulator.SupportsCalendarAccessAuthorizedOption
Get whether to enable calendar access on IOS Simulator.
doesChromedriverDisableBuildCheck() - Method in interface io.appium.java_client.android.options.context.SupportsChromedriverDisableBuildCheckOption
Get whether to disable the compatibility validation between the current chromedriver and the destination browser/web view.
doesChromedriverUseSystemExecutable() - Method in interface io.appium.java_client.android.options.context.SupportsChromedriverUseSystemExecutableOption
Get whether to use the system chromedriver.
doesClearDeviceLogsOnStart() - Method in interface io.appium.java_client.android.options.adb.SupportsClearDeviceLogsOnStartOption
Get whether to delete all the existing logs in the device buffer before starting a new test.
doesClearSystemFiles() - Method in interface io.appium.java_client.remote.options.SupportsClearSystemFilesOption
Get whether the app deletes generated files at the end of a session.
doesConnectHardwareKeyboard() - Method in interface io.appium.java_client.ios.options.simulator.SupportsConnectHardwareKeyboardOption
Get whether to connect hardware keyboard to Simulator.
doesDisableAutomaticScreenshots() - Method in interface io.appium.java_client.ios.options.wda.SupportsDisableAutomaticScreenshotsOption
Get whether to disable automatic XCTest screenshots.
doesDisableIceCandidateFiltering() - Method in class io.appium.java_client.safari.options.WebrtcData
Get whether to disable ICE candidates filtering.
doesDisableInsecureMediaCapture() - Method in class io.appium.java_client.safari.options.WebrtcData
Get whether to disable insecure media capture.
doesDisableSuppressAccessibilityService() - Method in interface io.appium.java_client.android.options.other.SupportsDisableSuppressAccessibilityServiceOption
Get whether to suppress accessibility services.
doesDisableWindowAnimation() - Method in interface io.appium.java_client.android.options.server.SupportsDisableWindowAnimationOption
Get whether window animations when starting the instrumentation process are disabled.
doesEnableAsyncExecuteFromHttps() - Method in interface io.appium.java_client.ios.options.webview.SupportsEnableAsyncExecuteFromHttpsOption
Get whether to allow simulators to execute async JavaScript on pages using HTTPS.
doesEnforceAppInstall() - Method in interface io.appium.java_client.remote.options.SupportsEnforceAppInstallOption
Get whether the application under test is always reinstalled even if a newer version of it already exists on the device under test.
doesEnforceFreshSimulatorCreation() - Method in interface io.appium.java_client.ios.options.simulator.SupportsEnforceFreshSimulatorCreationOption
Get whether to create a new simulator for each new test session.
doesEnsureWebviewsHavePages() - Method in interface io.appium.java_client.android.options.context.SupportsEnsureWebviewsHavePagesOption
Get whether to ensure if web views have pages.
doesEventTimings() - Method in interface io.appium.java_client.remote.options.SupportsEventTimingsOption
Get whether the app reports the timings for various Appium-internal events.
doesExtractChromeAndroidPackageFromContextName() - Method in interface io.appium.java_client.android.options.context.SupportsExtractChromeAndroidPackageFromContextNameOption
Get whether to use the android package identifier associated with the context name.
doesForceAppLaunch() - Method in interface io.appium.java_client.ios.options.wda.SupportsForceAppLaunchOption
Get whether to enforce app restart on session startup.
doesForceEspressoRebuild() - Method in interface io.appium.java_client.android.options.server.SupportsForceEspressoRebuildOption
Get to force Espresso server rebuild on a new session startup.
doesForceSimulatorSoftwareKeyboardPresence() - Method in interface io.appium.java_client.ios.options.simulator.SupportsForceSimulatorSoftwareKeyboardPresenceOption
Get to enforce software keyboard presence.
doesFullContextList() - Method in interface io.appium.java_client.ios.options.webview.SupportsFullContextListOption
Get whether to return the detailed information on contexts for the get available context command.
doesFullReset() - Method in interface io.appium.java_client.remote.options.SupportsFullResetOption
Get whether the app does a full reset.
doesIgnoreHiddenApiPolicyError() - Method in interface io.appium.java_client.android.options.adb.SupportsIgnoreHiddenApiPolicyErrorOption
Get whether to ignore a failure while changing hidden API access policies.
doesIncludeDeviceCapsToSessionInfo() - Method in interface io.appium.java_client.ios.options.general.SupportsIncludeDeviceCapsToSessionInfoOption
Get whether to include screen information as the result of Get Session Capabilities.
doesIncludeSafariInWebviews() - Method in interface io.appium.java_client.ios.options.webview.SupportsIncludeSafariInWebviewsOption
Get whether to add Safari web views to the list of contexts available during a native/webview app test.
doesKeepKeyChains() - Method in interface io.appium.java_client.ios.options.simulator.SupportsKeepKeyChainsOption
Get whether to preserve Simulator keychains after full reset.
doesLaunchWithIdb() - Method in interface io.appium.java_client.ios.options.other.SupportsLaunchWithIdbOption
Get whether to launch WebDriverAgentRunner with idb instead of xcodebuild.
doesNativeWebScreenshot() - Method in interface io.appium.java_client.android.options.context.SupportsNativeWebScreenshotOption
Get whether to use native screenshots in web view context.
doesNativeWebTap() - Method in interface io.appium.java_client.ios.options.webview.SupportsNativeWebTapOption
Get whether to enable native taps in web view mode.
doesNativeWebTapStrict() - Method in interface io.appium.java_client.ios.options.webview.SupportsNativeWebTapStrictOption
Get whether native taps are done by XCUITest driver rather than WebDriverAgent.
doesNoReset() - Method in interface io.appium.java_client.remote.options.SupportsNoResetOption
Get whether the app does not do a reset.
doesNoSign() - Method in interface io.appium.java_client.android.options.signing.SupportsNoSignOption
Get whether to skip package signing.
doesPrintPageSourceOnFindFailure() - Method in interface io.appium.java_client.remote.options.SupportsPrintPageSourceOnFindFailureOption
Get whether the app to print page source when a find operation fails.
doesRecreateChromeDriverSessions() - Method in interface io.appium.java_client.android.options.context.SupportsRecreateChromeDriverSessionsOption
Get whether chromedriver sessions should be killed and then recreated instead of just suspending it on context switch.
doesReduceMotion() - Method in interface io.appium.java_client.ios.options.simulator.SupportsReduceMotionOption
Get whether to reduce motion accessibility preference.
doesResetLocationService() - Method in interface io.appium.java_client.ios.options.general.SupportsResetLocationServiceOption
Get whether to reset the location service in the session deletion on real device.
doesResetOnSessionStartOnly() - Method in interface io.appium.java_client.ios.options.other.SupportsResetOnSessionStartOnlyOption
Get whether to perform reset on test session finish (false) or not (true).
doesSafariAllowPopups() - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariAllowPopupsOption
Get whether to allow javascript to open new windows in Safari.
doesSafariAutomaticInspection() - Method in interface io.appium.java_client.safari.options.SupportsSafariAutomaticInspectionOption
Get whether to use automatic inspection.
doesSafariAutomaticProfiling() - Method in interface io.appium.java_client.safari.options.SupportsSafariAutomaticProfilingOption
Get whether to use automatic profiling.
doesSafariGarbageCollect() - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariGarbageCollectOption
Get whether to turn on garbage collection when executing scripts on Safari.
doesSafariIgnoreFraudWarning() - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariIgnoreFraudWarningOption
Get whether to prevent Safari from showing a fraudulent website warning.
doesSafariLogAllCommunication() - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariLogAllCommunicationOption
Get whether to log of plists sent to and received from the Web Inspector.
doesSafariLogAllCommunicationHexDump() - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariLogAllCommunicationHexDumpOption
Get whether to log of plists sent to and received from the Web Inspector in hex dump format.
doesSafariOpenLinksInBackground() - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariOpenLinksInBackgroundOption
Get whether Safari should allow links to open in new windows.
doesSafariUseSimulator() - Method in interface io.appium.java_client.safari.options.SupportsSafariUseSimulatorOption
Get whether to use iOS Simulator.
doesSetWindowRect() - Method in interface io.appium.java_client.remote.options.SupportsSetWindowRectOption
Get whether the remote end supports all of the resizing and repositioning commands.
doesShowChromedriverLog() - Method in interface io.appium.java_client.android.options.context.SupportsShowChromedriverLogOption
Get whether to forward chromedriver output to the Appium server log.
doesShowGradleLog() - Method in interface io.appium.java_client.android.options.server.SupportsShowGradleLogOption
Get whether to include Gradle log to the regular server log.
doesShowIosLog() - Method in interface io.appium.java_client.ios.options.other.SupportsShowIosLogOption
Get whether to show any logs captured from a device in the appium logs.
doesShowServerLogs() - Method in interface io.appium.java_client.mac.options.SupportsShowServerLogsOption
Get whether to show WDA server logs in the Appium log.
doesShowXcodeLog() - Method in interface io.appium.java_client.ios.options.wda.SupportsShowXcodeLogOption
Get whether to display the output of the Xcode command used to run the tests.
doesShutdownOtherSimulators() - Method in interface io.appium.java_client.ios.options.simulator.SupportsShutdownOtherSimulatorsOption
Get whether to shutdown of other booted simulators except of the current one.
doesSimpleIsVisibleCheck() - Method in interface io.appium.java_client.ios.options.wda.SupportsSimpleIsVisibleCheckOption
Get whether to use native methods for determining visibility of elements.
doesSimulatorTracePointer() - Method in interface io.appium.java_client.ios.options.simulator.SupportsSimulatorTracePointerOption
Get whether to highlight pointer moves in the Simulator window.
doesSkipAppKill() - Method in interface io.appium.java_client.mac.options.SupportsSkipAppKillOption
Get whether to skip the termination of the application under test.
doesSkipDeviceInitialization() - Method in interface io.appium.java_client.android.options.server.SupportsSkipDeviceInitializationOption
Get whether initial device startup checks by the server are disabled.
doesSkipLogCapture() - Method in interface io.appium.java_client.remote.options.SupportsSkipLogCaptureOption
Get whether to skip capturing system logs.
doesSkipLogcatCapture() - Method in interface io.appium.java_client.android.options.adb.SupportsSkipLogcatCaptureOption
Get whether to delete all the existing logs in the device buffer before starting a new test.
doesSkipServerInstallation() - Method in interface io.appium.java_client.android.options.server.SupportsSkipServerInstallationOption
Get whether to skip the server components installation on the device under test and all the related checks.
doesSkipUnlock() - Method in interface io.appium.java_client.android.options.locking.SupportsSkipUnlockOption
Get whether to skip the check for lock screen presence.
doesSuppressKillServer() - Method in interface io.appium.java_client.android.options.adb.SupportsSuppressKillServerOption
Get whether to prevent the driver from ever killing the ADB server explicitly.
doesTerminateApp() - Method in interface io.appium.java_client.ios.options.wda.SupportsShouldTerminateAppOption
Get whether to enforce app termination on session quit.
doesUseJSONSource() - Method in interface io.appium.java_client.ios.options.other.SupportsUseJsonSourceOption
Get whether to get JSON source from WDA and transform it to XML.
doesUseKeystore() - Method in interface io.appium.java_client.android.options.signing.SupportsKeystoreOptions
Get whether to use a custom keystore.
doesUseNativeCachingStrategy() - Method in interface io.appium.java_client.ios.options.wda.SupportsUseNativeCachingStrategyOption
Get whether to use the native caching strategy.
doesUseNewWDA() - Method in interface io.appium.java_client.ios.options.wda.SupportsUseNewWdaOption
Get whether to uninstall of any existing WebDriverAgent app on the device under test.
doesUsePrebuiltWda() - Method in interface io.appium.java_client.ios.options.wda.SupportsUsePrebuiltWdaOption
Get whether to skip the build phase of running the WDA app.
doesUseSimpleBuildTest() - Method in interface io.appium.java_client.ios.options.wda.SupportsUseSimpleBuildTestOption
Get whether to use simple build test.
doesUseSingletonTestManager() - Method in interface io.appium.java_client.ios.options.wda.SupportsShouldUseSingletonTestManagerOption
Get whether to use the default proxy for test management within WebDriverAgent.
doesUseXctestrunFile() - Method in interface io.appium.java_client.ios.options.wda.SupportsUseXctestrunFileOption
Get whether to use of .xctestrun file to launch WDA
doesWaitForAppLaunch() - Method in interface io.appium.java_client.windows.options.SupportsMsWaitForAppLaunchOption
Get the timeout used to retry Appium Windows Driver session startup.
doesWaitForQuiescence() - Method in interface io.appium.java_client.ios.options.wda.SupportsWaitForQuiescenceOption
Get whether to wait for application quiescence.
doubleTap(PointOption) - Method in class io.appium.java_client.ios.IOSTouchAction
Deprecated.
Double taps using coordinates.
DPAD_CENTER - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Directional Pad Center key.
DPAD_DOWN - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Directional Pad Down key.
DPAD_DOWN_LEFT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Directional Pad Down-Left.
DPAD_DOWN_RIGHT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Directional Pad Down-Right.
DPAD_LEFT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Directional Pad Left key.
DPAD_RIGHT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Directional Pad Right key.
DPAD_UP - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Directional Pad Up key.
DPAD_UP_LEFT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Directional Pad Up-Left.
DPAD_UP_RIGHT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Directional Pad Up-Right.
duration - Variable in class io.appium.java_client.touch.LongPressOptions
 
duration - Variable in class io.appium.java_client.touch.WaitOptions
 
DVR - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: DVR key.

E

E - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'E' key.
EDGE - io.appium.java_client.android.NetworkSpeed
 
EDITOR_ACTION - io.appium.java_client.android.nativekey.KeyEventFlag
This mask is used for compatibility, to identify enter keys that are coming from an IME whose enter key has been auto-labelled "next" or "done".
EISU - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Japanese alphanumeric key.
element(WebElement) - Static method in class io.appium.java_client.touch.offset.ElementOption
This method creates a build instance of the ElementOption.
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, Point) - Static method in class io.appium.java_client.touch.offset.ElementOption
This method creates a build instance of the ElementOption.
ELEMENT_RESPONSE_ATTRIBUTES - io.appium.java_client.Setting
 
ElementInterceptor - Class in io.appium.java_client.pagefactory
Intercepts requests to WebElement.
ElementInterceptor(ElementLocator, WeakReference<WebDriver>) - Constructor for class io.appium.java_client.pagefactory.ElementInterceptor
 
ElementListInterceptor - Class in io.appium.java_client.pagefactory
Intercepts requests to the list of WebElement.
ElementListInterceptor(ElementLocator) - Constructor for class io.appium.java_client.pagefactory.ElementListInterceptor
 
ElementOption - Class in io.appium.java_client.touch.offset
 
ElementOption() - Constructor for class io.appium.java_client.touch.offset.ElementOption
 
ENABLE_ASYNC_EXECUTE_FROM_HTTPS_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsEnableAsyncExecuteFromHttpsOption
 
ENABLE_HEAP_DUMP - io.appium.java_client.service.local.flags.GeneralServerFlag
Enables NodeJS memory dumps collection feature.
ENABLE_NOTIFICATION_LISTENER - io.appium.java_client.Setting
 
ENABLE_PERFORMANCE_LOGGING_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsEnablePerformanceLoggingOption
 
enableAsyncExecuteFromHttps() - Method in interface io.appium.java_client.ios.options.webview.SupportsEnableAsyncExecuteFromHttpsOption
Enforces to allow simulators to execute async JavaScript on pages using HTTPS.
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.
enableClicksCapture() - Method in class io.appium.java_client.mac.Mac2StartScreenRecordingOptions
Whether to capture the click gestures while recording the screen.
enableClicksCapture() - Method in class io.appium.java_client.windows.WindowsStartScreenRecordingOptions
Whether to capture the click gestures while recording the screen.
enableCursorCapture() - Method in class io.appium.java_client.mac.Mac2StartScreenRecordingOptions
Whether to capture the mouse cursor while recording the screen.
enableCursorCapture() - Method in class io.appium.java_client.windows.WindowsStartScreenRecordingOptions
Whether to capture the mouse cursor while recording the screen.
enableDefaultSlf4jLoggingOfOutputData() - Method in class io.appium.java_client.service.local.AppiumDriverLocalService
Enables server output data logging through SLF4J loggers.
enableForcedRestart() - Method in class io.appium.java_client.screenrecording.BaseStartScreenRecordingOptions
Whether to ignore the result of previous capture and start a new recording immediately.
enableMultiple() - Method in class io.appium.java_client.imagecomparison.OccurrenceMatchingOptions
Whether to enable the support of multiple image occurrences.
enableNotificationListener(boolean) - Method in interface io.appium.java_client.android.HasAndroidSettings
Whether to enable or disable the notification listener.
enablePerformanceLogging() - Method in interface io.appium.java_client.remote.options.SupportsEnablePerformanceLoggingOption
Set the app to enable performance logging.
END_TEST_COVERAGE - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
ENDCALL - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: End Call key.
endTimestamp - Variable in class io.appium.java_client.serverevents.CommandEvent
 
ENFORCE_APP_INSTALL_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsEnforceAppInstallOption
 
ENFORCE_FRESH_SIMULATOR_CREATION_OPTION - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsEnforceFreshSimulatorCreationOption
 
enforceAppInstall() - Method in interface io.appium.java_client.remote.options.SupportsEnforceAppInstallOption
Sets the application under test is always reinstalled even if a newer version of it already exists on the device under test.
enforceFreshSimulatorCreation() - Method in interface io.appium.java_client.ios.options.simulator.SupportsEnforceFreshSimulatorCreationOption
Enforce creation of a new simulator for each new test session.
ENSURE_WEBVIEWS_HAVE_PAGES_OPTION - Static variable in interface io.appium.java_client.android.options.context.SupportsEnsureWebviewsHavePagesOption
 
ensureAutomationName(Capabilities, String) - Static method in class io.appium.java_client.AppiumDriver
Changes automation name if it is not set and returns merged capabilities.
ensurePlatformAndAutomationNames(Capabilities, String, String) - Static method in class io.appium.java_client.AppiumDriver
Changes platform and automation names if they are not set and returns merged capabilities.
ensurePlatformName(Capabilities, String) - Static method in class io.appium.java_client.AppiumDriver
Changes platform name if it is not set and returns merged capabilities.
ensureWebviewsHavePages() - Method in interface io.appium.java_client.android.options.context.SupportsEnsureWebviewsHavePagesOption
Set to skip web views that have no pages from being shown in getContexts output.
ENTER - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Enter key.
ENVELOPE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Envelope special function key.
ENVIRONMENT_OPTION - Static variable in interface io.appium.java_client.mac.options.SupportsEnvironmentOption
 
equals(Object) - Method in class io.appium.java_client.AppiumBy
 
equals(Object) - Method in class io.appium.java_client.pagefactory.bys.ContentMappedBy
 
EQUALS - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '=' key.
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
 
ESCAPE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Escape key.
ESPRESSO - Static variable in interface io.appium.java_client.remote.AutomationName
 
ESPRESSO_BUILD_CONFIG_OPTION - Static variable in interface io.appium.java_client.android.options.server.SupportsEspressoBuildConfigOption
 
ESPRESSO_SERVER_LAUNCH_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.android.options.server.SupportsEspressoServerLaunchTimeoutOption
 
EspressoBuildConfig - Class in io.appium.java_client.android.options.server
 
EspressoBuildConfig() - Constructor for class io.appium.java_client.android.options.server.EspressoBuildConfig
 
EspressoBuildConfig(String) - Constructor for class io.appium.java_client.android.options.server.EspressoBuildConfig
 
EspressoOptions - Class in io.appium.java_client.android.options
https://github.com/appium/appium-espresso-driver#capabilities
EspressoOptions() - Constructor for class io.appium.java_client.android.options.EspressoOptions
 
EspressoOptions(Map<String, ?>) - Constructor for class io.appium.java_client.android.options.EspressoOptions
 
EspressoOptions(Capabilities) - Constructor for class io.appium.java_client.android.options.EspressoOptions
 
EVDO - io.appium.java_client.android.NetworkSpeed
 
EVENT_TIMINGS_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsEventTimingsOption
 
events - Variable in class io.appium.java_client.serverevents.ServerEvents
 
eventTimings() - Method in interface io.appium.java_client.remote.options.SupportsEventTimingsOption
Set the app to report the timings for various Appium-internal events.
EXECUTABLE - Static variable in interface io.appium.java_client.chromium.options.SupportsExecutableOption
 
EXECUTABLE_DIR - Static variable in interface io.appium.java_client.chromium.options.SupportsExecutableDirOption
 
execute(ExecutesMethod, String) - Static method in class io.appium.java_client.CommandExecutionHelper
 
execute(ExecutesMethod, Map.Entry<String, Map<String, ?>>) - Static method in class io.appium.java_client.CommandExecutionHelper
 
execute(String) - Method in class io.appium.java_client.AppiumDriver
 
execute(String) - Method in interface io.appium.java_client.ExecutesMethod
Executes the given command and returns a response.
execute(String, Map<String, ?>) - Method in class io.appium.java_client.AppiumDriver
 
execute(String, Map<String, ?>) - Method in class io.appium.java_client.AppiumExecutionMethod
This method executes a command supported by Appium JSONWP.
execute(String, Map<String, ?>) - Method in interface io.appium.java_client.ExecutesMethod
Executes the given command and returns a response.
execute(Command) - Method in class io.appium.java_client.remote.AppiumCommandExecutor
 
EXECUTE_DRIVER_SCRIPT - Static variable in class io.appium.java_client.MobileCommand
 
EXECUTE_GOOGLE_CDP_COMMAND - Static variable in class io.appium.java_client.MobileCommand
 
executeCdpCommand(String) - Method in interface io.appium.java_client.ExecuteCDPCommand
Allows to execute ChromeDevProtocol commands against Android Chrome browser session without parameters.
executeCdpCommand(String, Map<String, Object>) - Method in interface io.appium.java_client.ExecuteCDPCommand
Allows to execute ChromeDevProtocol commands against Android Chrome browser session.
ExecuteCDPCommand - Interface in io.appium.java_client
 
executeDriverScript(String) - Method in interface io.appium.java_client.ExecutesDriverScript
Run a set of scripts in scope of the current session with default options.
executeDriverScript(String, ScriptOptions) - Method in interface io.appium.java_client.ExecutesDriverScript
Run a set of scripts in scope of the current session.
executeScript(ExecutesMethod, String) - Static method in class io.appium.java_client.CommandExecutionHelper
 
executeScript(ExecutesMethod, String, Map<String, Object>) - Static method in class io.appium.java_client.CommandExecutionHelper
Simplifies arguments preparation for the script execution command.
ExecutesDriverScript - Interface in io.appium.java_client
 
ExecutesMethod - Interface in io.appium.java_client
 
ExpectedCondition<T> - Interface in io.appium.java_client.functions
Deprecated.
Use ExpectedCondition instead
experimentalWebDriver() - Method in interface io.appium.java_client.windows.options.SupportsMsExperimentalWebDriverOption
Enforce to enable experimental driver features and optimizations.
EXPLORER - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Explorer special function key.
EXTRACT_CHROME_ANDROID_PACKAGE_FROM_CONTEXT_NAME_OPTION - Static variable in interface io.appium.java_client.android.options.context.SupportsExtractChromeAndroidPackageFromContextNameOption
 
extractChromeAndroidPackageFromContextName() - Method in interface io.appium.java_client.android.options.context.SupportsExtractChromeAndroidPackageFromContextNameOption
Tell chromedriver to attach to the android package we have associated with the context name, rather than the package of the application under test.

F

F - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'F' key.
F1 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: F1 key.
F10 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: F10 key.
F11 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: F11 key.
F12 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: F12 key.
F2 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: F2 key.
F3 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: F3 key.
F4 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: F4 key.
F5 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: F5 key.
F6 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: F6 key.
F7 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: F7 key.
F8 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: F8 key.
F9 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: F9 key.
FALLBACK - io.appium.java_client.android.nativekey.KeyEventFlag
Set when a key event has been synthesized to implement default behavior for an event that the application did not handle.
FAST - io.appium.java_client.imagecomparison.FeatureDetector
 
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
 
findDefaultExecutable() - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
 
findElement(By) - Method in class io.appium.java_client.pagefactory.Widget
 
findElement(SearchContext) - Method in class io.appium.java_client.AppiumBy
 
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
 
findElements(By) - Method in class io.appium.java_client.pagefactory.Widget
 
findElements(SearchContext) - Method in class io.appium.java_client.AppiumBy
 
findElements(SearchContext) - Method in class io.appium.java_client.pagefactory.bys.ContentMappedBy
 
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.
FINGER_PRINT - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
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
Deprecated.
FIREFOX_OS - Static variable in interface io.appium.java_client.remote.MobilePlatform
 
FIX_IMAGE_FIND_SCREENSHOT_DIMENSIONS - io.appium.java_client.Setting
 
FIX_IMAGE_TEMPLATE_SCALE - io.appium.java_client.Setting
 
FIX_IMAGE_TEMPLATE_SIZE - io.appium.java_client.Setting
 
FLANN_BASED - io.appium.java_client.imagecomparison.MatchingFunction
 
FOCUS - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Camera Focus key.
FORCE_APP_LAUNCH_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsForceAppLaunchOption
 
FORCE_ESPRESSO_REBUILD_OPTION - Static variable in interface io.appium.java_client.android.options.server.SupportsForceEspressoRebuildOption
 
FORCE_IPAD_SIMULATOR - io.appium.java_client.service.local.flags.IOSServerFlag
Use the iPad Simulator no matter what the app wants.
FORCE_IPHONE_SIMULATOR - io.appium.java_client.service.local.flags.IOSServerFlag
Use the iPhone Simulator no matter what the app wants.
FORCE_SIMULATOR_SOFTWARE_KEYBOARD_PRESENCE_OPTION - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsForceSimulatorSoftwareKeyboardPresenceOption
 
forceEspressoRebuild() - Method in interface io.appium.java_client.android.options.server.SupportsForceEspressoRebuildOption
Enforces Espresso server rebuild on a new session startup.
forceSimulatorSoftwareKeyboardPresence() - Method in interface io.appium.java_client.ios.options.simulator.SupportsForceSimulatorSoftwareKeyboardPresenceOption
Enforce software keyboard presence.
FORWARD - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Forward key.
FORWARD_DEL - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Forward Delete key.
FROM_SYSTEM - io.appium.java_client.android.nativekey.KeyEventFlag
This mask is set if an event was known to come from a trusted part of the system.
fromClientConfig(ClientConfig) - Static method in class io.appium.java_client.AppiumClientConfig
Return the instance of AppiumClientConfig from the given ClientConfig parameters.
fromString(String) - Static method in enum io.appium.java_client.remote.options.UnhandledPromptBehavior
Converts the given value to an enum member.
FULL - io.appium.java_client.android.AndroidBatteryInfo.BatteryState
 
FULL - io.appium.java_client.android.NetworkSpeed
 
FULL - io.appium.java_client.ios.IOSBatteryInfo.BatteryState
 
FULL_CONTEXT_LIST_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsFullContextListOption
 
FULL_RESET_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsFullResetOption
 
fullContextList() - Method in interface io.appium.java_client.ios.options.webview.SupportsFullContextListOption
Enforces to return the detailed information on contexts for the get available context command.
fullReset() - Method in interface io.appium.java_client.remote.options.SupportsFullResetOption
Set the app to do a full reset.
FUNCTION - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Function modifier key.
FUNCTION_ON - io.appium.java_client.android.nativekey.KeyEventMetaModifier
This mask is used to check whether the FUNCTION meta key is pressed.

G

G - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'G' key.
GECKO - Static variable in interface io.appium.java_client.remote.AutomationName
 
GeckoDriver - Class in io.appium.java_client.gecko
GeckoDriver is an officially supported Appium driver created to automate Mobile browsers and web views based on the Gecko engine.
GeckoDriver(AppiumClientConfig, Capabilities) - Constructor for class io.appium.java_client.gecko.GeckoDriver
Creates a new instance based on the given ClientConfig and capabilities.
GeckoDriver(AppiumDriverLocalService, Capabilities) - Constructor for class io.appium.java_client.gecko.GeckoDriver
 
GeckoDriver(AppiumDriverLocalService, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.gecko.GeckoDriver
 
GeckoDriver(AppiumServiceBuilder, Capabilities) - Constructor for class io.appium.java_client.gecko.GeckoDriver
 
GeckoDriver(AppiumServiceBuilder, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.gecko.GeckoDriver
 
GeckoDriver(URL, String) - Constructor for class io.appium.java_client.gecko.GeckoDriver
This is a special constructor used to connect to a running driver instance.
GeckoDriver(URL, Capabilities) - Constructor for class io.appium.java_client.gecko.GeckoDriver
 
GeckoDriver(URL, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.gecko.GeckoDriver
 
GeckoDriver(Capabilities) - Constructor for class io.appium.java_client.gecko.GeckoDriver
 
GeckoDriver(ClientConfig, Capabilities) - Constructor for class io.appium.java_client.gecko.GeckoDriver
Creates a new instance based on the given ClientConfig and capabilities.
GeckoDriver(HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.gecko.GeckoDriver
 
GeckoDriver(HttpCommandExecutor, Capabilities) - Constructor for class io.appium.java_client.gecko.GeckoDriver
 
GeckoOptions - Class in io.appium.java_client.gecko.options
https://github.com/appium/appium-geckodriver#usage
GeckoOptions() - Constructor for class io.appium.java_client.gecko.options.GeckoOptions
 
GeckoOptions(Map<String, ?>) - Constructor for class io.appium.java_client.gecko.options.GeckoOptions
 
GeckoOptions(Capabilities) - Constructor for class io.appium.java_client.gecko.options.GeckoOptions
 
GeneralServerFlag - Enum in io.appium.java_client.service.local.flags
Here is the list of common Appium server arguments.
GET_ALLSESSION - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
GET_CLIPBOARD - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
GET_CONTEXT_HANDLES - Static variable in class io.appium.java_client.MobileCommand
 
GET_CURRENT_CONTEXT_HANDLE - Static variable in class io.appium.java_client.MobileCommand
 
GET_CURRENT_PACKAGE - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
GET_DEVICE_TIME - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
GET_DISPLAY_DENSITY - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
GET_EVENTS - Static variable in class io.appium.java_client.MobileCommand
 
GET_LOCATION - Static variable in class io.appium.java_client.MobileCommand
 
GET_MATCHED_IMAGE_RESULT - io.appium.java_client.Setting
 
GET_NETWORK_CONNECTION - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
GET_PERFORMANCE_DATA - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
GET_SCREEN_ORIENTATION - Static variable in class io.appium.java_client.MobileCommand
 
GET_SCREEN_ROTATION - Static variable in class io.appium.java_client.MobileCommand
 
GET_SESSION - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
GET_SETTINGS - Static variable in class io.appium.java_client.MobileCommand
 
GET_SIMILARITY - io.appium.java_client.imagecomparison.ComparisonMode
 
GET_STRINGS - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
GET_SUPPORTED_PERFORMANCE_DATA_TYPES - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
GET_SYSTEM_BARS - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
getAction() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get the action name.
getActivityOptions() - Method in interface io.appium.java_client.android.options.app.SupportsActivityOptionsOption
Get activity options.
getAdbExecTimeout() - Method in interface io.appium.java_client.android.options.adb.SupportsAdbExecTimeoutOption
Get maximum time to wait until single ADB command is executed.
getAdbPort() - Method in interface io.appium.java_client.android.options.adb.SupportsAdbPortOption
Get number of the port where ADB is running.
getAdditionalAndroidTestDependencies() - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Get the array of dependent Android test module names with their versions.
getAdditionalAppDependencies() - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Get the array of dependent application module names with their versions.
getAdditionalCommands() - Method in class io.appium.java_client.remote.AppiumCommandExecutor
 
getAdditionalWebviewBundleIds() - Method in interface io.appium.java_client.ios.options.webview.SupportsAdditionalWebviewBundleIdsOption
Get the array of possible bundle identifiers for webviews.
getAndroidGradlePluginVersion() - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Get Gradle plugin version.
getAndroidInstallTimeout() - Method in interface io.appium.java_client.android.options.app.SupportsAndroidInstallTimeoutOption
Get maximum amount of time to wait until the application under test is installed.
getAndroidStorage() - Method in interface io.appium.java_client.gecko.options.SupportsAndroidStorageOption
Get the currently set storage type.
getApp() - Method in interface io.appium.java_client.remote.options.SupportsAppOption
Get the app location.
getAppActivity() - Method in interface io.appium.java_client.android.options.app.SupportsAppActivityOption
Get the name of the main app activity.
getAppInstallStrategy() - Method in interface io.appium.java_client.ios.options.app.SupportsAppInstallStrategyOption
Get the app install strategy.
getAppLocale() - Method in interface io.appium.java_client.android.options.localization.SupportsAppLocaleOption
Get the locale for the app under test.
getAppPackage() - Method in interface io.appium.java_client.android.options.app.SupportsAppPackageOption
Get the app package identifier.
getAppPermissions(String) - Method in class io.appium.java_client.ios.options.simulator.Permissions
Get permissions mapping for the given app bundle identifier.
getAppPushTimeout() - Method in interface io.appium.java_client.ios.options.app.SupportsAppPushTimeoutOption
Get maximum timeout for application upload.
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.
getAppTopLevelWindow() - Method in interface io.appium.java_client.windows.options.SupportsAppTopLevelWindowOption
Get the hexadecimal handle of an existing application top level window to attach to.
getAppWaitActivity() - Method in interface io.appium.java_client.android.options.app.SupportsAppWaitActivityOption
Get the name of the app activity to wait for.
getAppWaitDuration() - Method in interface io.appium.java_client.android.options.app.SupportsAppWaitDurationOption
Get the identifier of the app package to wait for.
getAppWaitPackage() - Method in interface io.appium.java_client.android.options.app.SupportsAppWaitPackageOption
Get the identifier of the app package to wait for.
getAppWorkingDir() - Method in interface io.appium.java_client.windows.options.SupportsAppWorkingDirOption
Get the full path to the folder, which is going to be set as the working dir for the application under test.
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
 
getArguments() - Method in interface io.appium.java_client.mac.options.SupportsArgumentsOption
Get the array of application command line arguments.
getAutomationName() - Method in interface io.appium.java_client.remote.options.SupportsAutomationNameOption
Get the automation driver to use.
getAutoWebviewTimeout() - Method in interface io.appium.java_client.android.options.context.SupportsAutoWebviewTimeoutOption
Get the timeout to wait until a web view is available.
getAvd() - Method in interface io.appium.java_client.android.options.avd.SupportsAvdOption
Get the name of Android emulator to run the test on.
getAvdArgs() - Method in interface io.appium.java_client.android.options.avd.SupportsAvdArgsOption
Get emulator command line arguments.
getAvdEnv() - Method in interface io.appium.java_client.android.options.avd.SupportsAvdEnvOption
Get the mapping of emulator environment variables.
getAvdLaunchTimeout() - Method in interface io.appium.java_client.android.options.avd.SupportsAvdLaunchTimeoutOption
Get the timeout to wait until Android Emulator is started.
getAvdReadyTimeout() - Method in interface io.appium.java_client.android.options.avd.SupportsAvdReadyTimeoutOption
Get the timeout to wait until Android Emulator is fully booted and is ready for usage.
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
 
getBootstrapRoot() - Method in interface io.appium.java_client.mac.options.SupportsBootstrapRootOption
Get the full path to WebDriverAgentMac root folder where Xcode project of the server sources lives.
getBuildToolsVersion() - Method in interface io.appium.java_client.android.options.adb.SupportsBuildToolsVersionOption
Get the version of Android build tools to use.
getBuildToolsVersion() - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Get Android build tools version.
getBundleId() - Method in interface io.appium.java_client.ios.options.app.SupportsBundleIdOption
Get the app bundle identifier.
getBundleId() - Method in interface io.appium.java_client.mac.options.SupportsBundleIdOption
Get the bundle identifier of the application to automate.
getC(String) - Static method in class io.appium.java_client.MobileCommand
This methods forms GET commands.
getCalendarFormat() - Method in interface io.appium.java_client.ios.options.simulator.SupportsCalendarFormatOption
Get calendar format to set for the iOS Simulator.
getCapability(String) - Method in class io.appium.java_client.remote.options.BaseOptions
 
getCapability(Capabilities, String, Class<T>) - Static method in class io.appium.java_client.internal.CapabilityHelpers
Helper that is used for capability values retrieval.
getCategories() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get intent categories.
getChromedriverArgs() - Method in interface io.appium.java_client.android.options.context.SupportsChromedriverArgsOption
Get the array of chromedriver CLI arguments.
getChromedriverChromeMappingFile() - Method in interface io.appium.java_client.android.options.context.SupportsChromedriverChromeMappingFileOption
Get full path to the chromedrivers mapping file is located.
getChromedriverExecutable() - Method in interface io.appium.java_client.android.options.context.SupportsChromedriverExecutableOption
Get the path to the chromedriver executable on the server file system..
getChromedriverExecutableDir() - Method in interface io.appium.java_client.android.options.context.SupportsChromedriverExecutableDirOption
Get full path to the folder where chromedriver executables are located.
getChromedriverPort() - Method in interface io.appium.java_client.android.options.context.SupportsChromedriverPortOption
Get the local port number to use for Chromedriver communication.
getChromeDriverPort() - Method in interface io.appium.java_client.chromium.options.SupportsChromeDrivePortOption
Get the number of the port for the chrome driver to listen on.
getChromedriverPorts() - Method in interface io.appium.java_client.android.options.context.SupportsChromedriverPortsOption
Get the local port number to use for Chromedriver communication.
getChromeLoggingPrefs() - Method in interface io.appium.java_client.android.options.context.SupportsChromeLoggingPrefsOption
Get chrome logging preferences.
getChromeOptions() - Method in interface io.appium.java_client.android.options.context.SupportsChromeOptionsOption
Get chrome options.
getClassName() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get class name.
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
 
getCommand() - Method in class io.appium.java_client.mac.options.AppleScriptData
Get a single-line AppleScript.
getCommand() - Method in class io.appium.java_client.remote.options.SystemScript
 
getCommand() - Method in class io.appium.java_client.windows.options.PowerShellData
Get a single-line PowerShell script.
getCommandCodec() - Method in class io.appium.java_client.remote.AppiumCommandExecutor
 
getCommandTimeout(String) - Method in class io.appium.java_client.ios.options.other.CommandTimeouts
Get the command timeout.
getCommandTimeouts() - Method in interface io.appium.java_client.ios.options.other.SupportsCommandTimeoutsOption
Get custom timeout(s) in milliseconds for WDA backend commands execution.
getCompileSdkVersion() - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Get the target Android SDK version.
getComponent() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get intent component name.
getComposeVersion() - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Get the version of included androidx.compose.ui components.
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 interface io.appium.java_client.remote.SupportsContextSwitching
Get the name of the current context.
getContextHandles() - Method in interface io.appium.java_client.remote.SupportsContextSwitching
Get the names of available contexts.
getCount() - Method in class io.appium.java_client.imagecomparison.FeaturesMatchingResult
Returns a count of matched edges on both images.
getCountry() - Method in class io.appium.java_client.android.options.localization.AppLocale
Get the country identifier.
getCreateSessionTimeout() - Method in interface io.appium.java_client.windows.options.SupportsCreateSessionTimeoutOption
Get the timeout used to retry Appium Windows Driver session startup.
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
 
getCustomSSLCert() - Method in interface io.appium.java_client.ios.options.simulator.SupportsCustomSslCertOption
Get the SSL certificate content.
getData() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get intent data URI.
getDerivedDataPath() - Method in interface io.appium.java_client.ios.options.wda.SupportsDerivedDataPathOption
Get the path to the derived data WDA folder.
getDeviceName() - Method in interface io.appium.java_client.remote.options.SupportsDeviceNameOption
Get the name of the device.
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.
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.
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
Retrieve the display density of the Android device.
getDisplayDensityCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
Deprecated.
getEcn() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get intent component name parameters.
getEf() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get intent float parameters.
getEfa() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get intent float array parameters.
getEi() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get intent integer parameters.
getEia() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get intent integer array parameters.
getEl() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get intent long parameters.
getEla() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get intent long array parameters.
getEndpoint() - Method in class io.appium.java_client.ws.StringWebSocketClient
 
getEnhancedProxy(Class<T>, MethodCallListener) - Static method in class io.appium.java_client.pagefactory.utils.ProxyFactory
Creates a proxy instance for the given class with an empty constructor.
getEnhancedProxy(Class<T>, Class<?>[], Object[], MethodCallListener) - Static method in class io.appium.java_client.pagefactory.utils.ProxyFactory
Creates a proxy instance for the given class.
getEnvironment() - Method in interface io.appium.java_client.mac.options.SupportsEnvironmentOption
Get the application environment variables mapping.
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
 
getEs() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get intent string parameters.
getEsn() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get intent null parameters.
getEspressoBuildConfig() - Method in interface io.appium.java_client.android.options.server.SupportsEspressoBuildConfigOption
Get the Espresso build config.
getEu() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get intent URI parameters.
getEvents() - Method in interface io.appium.java_client.LogsEvents
Log a custom event on the Appium server.
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.
getExecutable() - Method in interface io.appium.java_client.chromium.options.SupportsExecutableOption
Get the absolute path to a WebDriver binary executable.
getExecutableDir() - Method in interface io.appium.java_client.chromium.options.SupportsExecutableDirOption
Get a directory within which is found any number of WebDriver binaries.
getExecuteMethod() - Method in class io.appium.java_client.AppiumDriver
 
getEz() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get intent boolean parameters.
getFlags() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get intent flag names.
getGpsEnabled() - Method in interface io.appium.java_client.android.options.avd.SupportsGpsEnabledOption
Get the state of GPS service on emulator.
getGradleVersion() - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Get Gradle version.
getHttpClient() - 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 interface io.appium.java_client.android.options.app.SupportsIntentActionOption
Get intent action to be applied when starting the given appActivity by Activity Manager.
getIntentCategory() - Method in interface io.appium.java_client.android.options.app.SupportsIntentCategoryOption
Get intent category to be applied when starting the given appActivity by Activity Manager.
getIntentFlags() - Method in interface io.appium.java_client.android.options.app.SupportsIntentFlagsOption
Get intent flags to be applied when starting the given appActivity by Activity Manager.
getIntentOptions() - Method in interface io.appium.java_client.android.options.app.SupportsIntentOptionsOption
Get intent options.
getInterval() - Method in class io.appium.java_client.AppiumFluentWait
 
getIntFlags() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get intent flags.
getIosSimulatorLogsPredicate() - Method in interface io.appium.java_client.ios.options.simulator.SupportsIosSimulatorLogsPredicateOption
Get Simulator log filtering predicate.
getIsDeviceLockedCommand() - Static method in class io.appium.java_client.MobileCommand
Deprecated.
This helper is deprecated and will be removed in future versions.
getJvmTarget() - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Get the target version of the generated JVM bytecode as a string.
getKeychain() - Method in interface io.appium.java_client.ios.options.wda.SupportsKeychainOptions
Get details to access custom keychain.
getKeychainsExcludePatterns() - Method in interface io.appium.java_client.ios.options.simulator.SupportsKeychainsExcludePatternsOption
Get keychains exclude patterns.
getKeystoreConfig() - Method in interface io.appium.java_client.android.options.signing.SupportsKeystoreOptions
Get the custom keystore config.
getKotlinVersion() - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Get the target Kotlin version.
getLanguage() - Method in class io.appium.java_client.android.options.localization.AppLocale
Get the language identifier.
getLanguage() - Method in interface io.appium.java_client.remote.options.SupportsLanguageOption
Get language abbreviation for use in session.
getLaunchDisplayId() - Method in class io.appium.java_client.android.options.app.ActivityOptions
Get display id which you want to assign to launch the main app activity on.
getLevel() - Method in class io.appium.java_client.battery.BatteryInfo
Returns battery level.
getLocale() - Method in interface io.appium.java_client.remote.options.SupportsLocaleOption
Get locale abbreviation for use in session.
getLocaleScript() - Method in interface io.appium.java_client.android.options.localization.SupportsLocaleScriptOption
Get canonical name of the locale to be set for the app under test.
getLocalizableStringsDir() - Method in interface io.appium.java_client.ios.options.app.SupportsLocalizableStringsDirOption
Get the resource folder name where the main locale strings are stored.
getLocation() - Method in interface io.appium.java_client.remote.SupportsLocation
Gets the current device's geolocation coordinates.
getLocationContext() - Method in class io.appium.java_client.android.AndroidDriver
Deprecated, for removal: This API element is subject to removal in a future version.
This method, LocationContext and RemoteLocationContext interface are deprecated, use SupportsLocation.getLocation() and SupportsLocation.setLocation(io.appium.java_client.Location) instead.
getLocationContext() - Method in class io.appium.java_client.ios.IOSDriver
Deprecated, for removal: This API element is subject to removal in a future version.
This method, LocationContext and RemoteLocationContext interface are deprecated, use SupportsLocation.getLocation() and SupportsLocation.setLocation(io.appium.java_client.Location) instead.
getLocationContext() - Method in interface io.appium.java_client.remote.SupportsLocation
Deprecated, for removal: This API element is subject to removal in a future version.
This method, LocationContext and RemoteLocationContext interface are deprecated, use SupportsLocation.getLocation() and SupportsLocation.setLocation(io.appium.java_client.Location) instead.
getLogcatClient() - Method in class io.appium.java_client.android.AndroidDriver
 
getLogcatClient() - Method in interface io.appium.java_client.android.ListensToLogcatMessages
 
getLogcatFilterSpecs() - Method in interface io.appium.java_client.android.options.adb.SupportsLogcatFilterSpecsOption
Get the logcat filter format.
getLogcatFormat() - Method in interface io.appium.java_client.android.options.adb.SupportsLogcatFormatOption
Get the log print format.
getLogPath() - Method in interface io.appium.java_client.chromium.options.SupportsLogPathOption
Get the log path where the WebDrive writes the logs.
getMarionettePort() - Method in interface io.appium.java_client.gecko.options.SupportsMarionettePortOption
Get the number of the port for the Marionette server to listen on.
getMaxTypingFrequency() - Method in interface io.appium.java_client.ios.options.wda.SupportsMaxTypingFrequencyOption
Get the number of keystrokes per minute.
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
 
getMethodCallListeners() - Method in interface io.appium.java_client.proxy.HasMethodCallListeners
The getter is dynamically created by ByteBuddy to access method call listeners on the instrumented proxy instance.
getMinSdkVersion() - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Get the minimum Android SDK version.
getMjpegScreenshotUrl() - Method in interface io.appium.java_client.android.options.mjpeg.SupportsMjpegScreenshotUrlOption
Get URL of a service that provides realtime device screenshots in MJPEG format.
getMjpegServerPort() - Method in interface io.appium.java_client.android.options.mjpeg.SupportsMjpegServerPortOption
Get the number of the port UiAutomator2 server starts the MJPEG server on.
getMjpegServerPort() - Method in interface io.appium.java_client.ios.options.wda.SupportsMjpegServerPortOption
Get the port number on which WDA broadcasts screenshots stream encoded into MJPEG format from the device under test.
getMockLocationApp() - Method in interface io.appium.java_client.android.options.adb.SupportsMockLocationAppOption
Get the identifier of the app, which is used as a system mock location provider.
getMozFirefoxOptions() - Method in interface io.appium.java_client.gecko.options.SupportsMozFirefoxOptionsOption
Get Firefox options mapping.
getMultiple() - Method in class io.appium.java_client.imagecomparison.OccurrenceMatchingResult
Returns the list of multiple matches (if any).
getName() - Method in class io.appium.java_client.service.local.Slf4jLogMessageContext
Returns the name of the Logger associated with this context.
getNetworkConnectionCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
Deprecated.
getNetworkSpeed() - Method in interface io.appium.java_client.android.options.avd.SupportsNetworkSpeedOption
Get the desired network speed limit for the emulator.
getNewCommandTimeout() - Method in interface io.appium.java_client.remote.options.SupportsNewCommandTimeoutOption
Get the timeout for new commands.
getObject(List<WebElement>, Method, Object[]) - Method in class io.appium.java_client.pagefactory.ElementListInterceptor
 
getObject(List<WebElement>, Method, Object[]) - Method in class io.appium.java_client.pagefactory.interceptors.InterceptorOfAListOfElements
 
getObject(List<WebElement>, Method, Object[]) - Method in class io.appium.java_client.pagefactory.WidgetListInterceptor
 
getObject(WebElement, Method, Object[]) - Method in class io.appium.java_client.pagefactory.ElementInterceptor
 
getObject(WebElement, Method, Object[]) - Method in class io.appium.java_client.pagefactory.interceptors.InterceptorOfASingleElement
 
getObject(WebElement, Method, Object[]) - Method in class io.appium.java_client.pagefactory.WidgetInterceptor
 
getOptionalIntentArguments() - Method in interface io.appium.java_client.android.options.app.SupportsOptionalIntentArgumentsOption
Get intent arguments to be applied when starting the given appActivity by Activity Manager.
getOptionalValue(String, Class<T>) - Method in class io.appium.java_client.internal.Config
Retrieve a value from properties file.
getOptionValue(String) - Method in class io.appium.java_client.remote.options.BaseMapOptionData
Retrieves a value with the given name from a data object.
getOrientation() - Method in interface io.appium.java_client.remote.options.SupportsOrientationOption
Get the orientation of the screen.
getOrientation() - Method in interface io.appium.java_client.remote.SupportsRotation
Get device orientation.
getOtherApps() - Method in interface io.appium.java_client.remote.options.SupportsOtherAppsOption
Get the list of apps to install before running a test.
getOverlapScore(BufferedImage, BufferedImage) - Method in class io.appium.java_client.ScreenshotState
Compares two valid java bitmaps and calculates similarity score between them.
getPageLoadStrategy() - Method in interface io.appium.java_client.remote.options.SupportsPageLoadStrategyOption
Get the current session’s page load strategy.
getParameterMap() - Method in class io.appium.java_client.TouchAction.ActionParameter
Deprecated.
 
getParameters() - Method in class io.appium.java_client.MultiTouchAction
Deprecated.
 
getParameters() - Method in class io.appium.java_client.TouchAction
Deprecated.
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.
getPerformanceDataCommand(String, String, int) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
returns the resource usage information of the application.
getPermissions() - Method in interface io.appium.java_client.ios.options.simulator.SupportsPermissionsOption
Get Simulator permissions.
getPlatformName() - Method in class io.appium.java_client.remote.options.BaseOptions
 
getPlatformVersion() - Method in interface io.appium.java_client.remote.options.SupportsPlatformVersionOption
Get the version of the platform.
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.
getPostrun() - Method in class io.appium.java_client.mac.options.Mac2Options
Get the postrun script.
getPostrun() - Method in interface io.appium.java_client.remote.options.SupportsPostrunOption
 
getPostrun() - Method in class io.appium.java_client.windows.options.WindowsOptions
Get the postrun script.
getPrerun() - Method in class io.appium.java_client.mac.options.Mac2Options
Get the prerun script.
getPrerun() - Method in interface io.appium.java_client.remote.options.SupportsPrerunOption
 
getPrerun() - Method in class io.appium.java_client.windows.options.WindowsOptions
Get the prerun script.
getPrivateFieldValue(Class<?>, Object, String, Class<T>) - Static method in class io.appium.java_client.internal.ReflectionHelpers
Fetches the value of a private instance field.
getPrivateFieldValue(Class<? extends CommandExecutor>, String, Class<B>) - Method in class io.appium.java_client.remote.AppiumCommandExecutor
 
getProcessArguments() - Method in interface io.appium.java_client.ios.options.wda.SupportsProcessArgumentsOption
Get process arguments of the app under test.
getProxy() - Method in interface io.appium.java_client.remote.options.SupportsProxyOption
Get the current session’s proxy configuration.
getRect() - Method in class io.appium.java_client.imagecomparison.OccurrenceMatchingResult
Returns rectangle of partial image occurrence.
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.
getRemoteAdbHost() - Method in interface io.appium.java_client.android.options.adb.SupportsRemoteAdbHostOption
Get the address of the host where ADB is running.
getRemoteAppsCacheLimit() - Method in interface io.appium.java_client.android.options.app.SupportsRemoteAppsCacheLimitOption
Get the maximum amount of apps that could be cached on the remote device.
getResultBundlePath() - Method in interface io.appium.java_client.ios.options.wda.SupportsResultBundlePathOption
Get the path where the resulting XCTest bundle should be stored.
getSafariDeviceName() - Method in interface io.appium.java_client.safari.options.SupportsSafariDeviceNameOption
Get the name of the device.
getSafariDeviceType() - Method in interface io.appium.java_client.safari.options.SupportsSafariDeviceTypeOption
Get the type of the device.
getSafariDeviceUdid() - Method in interface io.appium.java_client.safari.options.SupportsSafariDeviceUdidOption
Get the UDID of the device.
getSafariIgnoreWebHostnames() - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariIgnoreWebHostnamesOption
Get the comma-separated list of host names to be ignored.
getSafariInitialUrl() - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariInitialUrlOption
Get the initial safari url.
getSafariPlatformBuildVersion() - Method in interface io.appium.java_client.safari.options.SupportsSafariPlatformBuildVersionOption
Get the build version of the platform.
getSafariPlatformVersion() - Method in interface io.appium.java_client.safari.options.SupportsSafariPlatformVersionOption
Get the version of the platform.
getSafariSocketChunkSize() - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariSocketChunkSizeOption
Get the size of a single remote debugger socket chunk.
getSafariWebInspectorMaxFrameLength() - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariWebInspectorMaxFrameLengthOption
Get the maximum size in bytes of a single data frame for the Web Inspector.
getScaleFactor() - Method in interface io.appium.java_client.ios.options.simulator.SupportsScaleFactorOption
Get Simulator scale factor.
getScore() - Method in class io.appium.java_client.imagecomparison.SimilarityMatchingResult
Returns the similarity score as a float number in range [0.0, 1.0].
getScreenshotAs(OutputType<X>) - Method in class io.appium.java_client.AppiumDriver
 
getScreenshotQuality() - Method in interface io.appium.java_client.ios.options.wda.SupportsScreenshotQualityOption
Get the screenshot quality value.
getScript() - Method in class io.appium.java_client.mac.options.AppleScriptData
Get a multiline AppleScript.
getScript() - Method in class io.appium.java_client.remote.options.SystemScript
 
getScript() - Method in class io.appium.java_client.windows.options.PowerShellData
Get a multiline PowerShell script.
getSelfReference() - Method in class io.appium.java_client.pagefactory.Widget
 
getServerStartupTimeout() - Method in interface io.appium.java_client.mac.options.SupportsServerStartupTimeoutOption
Get the timeout to wait util the WebDriverAgentMac project is built and started.
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
 
getSimulatorDevicesSetPath() - Method in interface io.appium.java_client.ios.options.simulator.SupportsSimulatorDevicesSetPathOption
Get the alternative path to the simulator devices set.
getSimulatorPasteboardAutomaticSync() - Method in interface io.appium.java_client.ios.options.simulator.SupportsSimulatorPasteboardAutomaticSyncOption
Get the pasteboard automation sync state.
getSimulatorStartupTimeout() - Method in interface io.appium.java_client.ios.options.simulator.SupportsSimulatorStartupTimeoutOption
Get the Simulator startup timeout.
getSimulatorWindowCenter() - Method in interface io.appium.java_client.ios.options.simulator.SupportsSimulatorWindowCenterOption
Get Simulator window center coordinates.
getSleeper() - Method in class io.appium.java_client.AppiumFluentWait
 
getSourceCompatibility() - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Get the minimum version of JVM the project sources are compatible with.
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
 
getStatus() - Method in class io.appium.java_client.AppiumDriver
This method is used to get build version status of running Appium server.
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
Retrieve visibility and bounds information of the status and navigation bars.
getSystemBarsCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
Deprecated.
getSystemHost() - Method in interface io.appium.java_client.mac.options.SupportsSystemHostOption
Get the name of the host for the internal server to listen on.
getSystemPort() - Method in interface io.appium.java_client.android.options.server.SupportsSystemPortOption
Get the system port value.
getSystemPort() - Method in interface io.appium.java_client.gecko.options.SupportsSystemPortOption
Get the number of the port for the internal server to listen on.
getSystemPort() - Method in interface io.appium.java_client.mac.options.SupportsSystemPortOption
Get the number of the port for the internal server to listen on.
getSystemPort() - Method in interface io.appium.java_client.windows.options.SupportsSystemPortOption
Get the port number to execute Appium Windows Driver server listener on.
getTargetCompatibility() - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Get the target version of JVM the project sources are compatible with.
getTargetSdkVersion() - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Get the target Android SDK version.
getTimeout() - Method in class io.appium.java_client.AppiumFluentWait
 
getTotalCount() - Method in class io.appium.java_client.imagecomparison.FeaturesMatchingResult
Returns a count of matched edges on both images.
getType() - Method in class io.appium.java_client.android.options.app.IntentOptions
Get an intent type.
getUdid() - Method in interface io.appium.java_client.remote.options.SupportsUdidOption
Get the id of the device.
getUiautomator2ServerInstallTimeout() - Method in interface io.appium.java_client.android.options.server.SupportsEspressoServerLaunchTimeoutOption
Get the maximum timeout to wait until Espresso server is listening on the device.
getUiautomator2ServerInstallTimeout() - Method in interface io.appium.java_client.android.options.server.SupportsUiautomator2ServerInstallTimeoutOption
Get the maximum timeout to wait until UiAutomator2Server is installed on the device.
getUiautomator2ServerLaunchTimeout() - Method in interface io.appium.java_client.android.options.server.SupportsUiautomator2ServerLaunchTimeoutOption
Get the maximum timeout to wait until UiAutomator2Server is listening on the device.
getUiautomator2ServerReadTimeout() - Method in interface io.appium.java_client.android.options.server.SupportsUiautomator2ServerReadTimeoutOption
Get the maximum timeout to wait for a HTTP response from UiAutomator2Server.
getUnhandledPromptBehavior() - Method in interface io.appium.java_client.remote.options.SupportsUnhandledPromptBehaviorOption
Get the current session’s page load strategy.
getUninstallOtherPackages() - Method in interface io.appium.java_client.android.options.app.SupportsUninstallOtherPackagesOption
Get identifiers of packages to be uninstalled from the device before a test starts.
getUnlockKey() - Method in interface io.appium.java_client.android.options.locking.SupportsUnlockKeyOption
Get the unlock key.
getUnlockStrategy() - Method in interface io.appium.java_client.android.options.locking.SupportsUnlockStrategyOption
Get the strategy key.
getUnlockSuccessTimeout() - Method in interface io.appium.java_client.android.options.locking.SupportsUnlockSuccessTimeoutOption
Get the timeout to wait until the device is unlocked.
getUnlockType() - Method in interface io.appium.java_client.android.options.locking.SupportsUnlockTypeOption
Get the unlock type.
getUpdatedWdaBundleId() - Method in interface io.appium.java_client.ios.options.wda.SupportsUpdatedWdaBundleIdOption
Get the WDA bundle identifier.
getUrl() - Method in class io.appium.java_client.remote.DirectConnect
Returns a URL instance built with members in the DirectConnect instance.
getUrl() - Method in class io.appium.java_client.service.local.AppiumDriverLocalService
Base URL.
getUserProfile() - Method in interface io.appium.java_client.android.options.other.SupportsUserProfileOption
Get the integer identifier of a user profile.
getValue() - Method in enum io.appium.java_client.android.nativekey.KeyEventFlag
 
getValue() - Method in enum io.appium.java_client.android.nativekey.KeyEventMetaModifier
 
getValue(String, Class<T>) - Method in class io.appium.java_client.internal.Config
Retrieve a value from properties file.
getVariant() - Method in class io.appium.java_client.android.options.localization.AppLocale
Get the language variant.
getVerbosity() - Method in interface io.appium.java_client.gecko.options.SupportsVerbosityOption
Get the verbosity level of driver logging.
getVisualization() - Method in class io.appium.java_client.imagecomparison.ComparisonResult
Returns the visualization of the matching result.
getWaitForIdleTimeout() - Method in interface io.appium.java_client.ios.options.wda.SupportsWaitForIdleTimeoutOption
Get the maximum timeout to wait until WDA responds to HTTP requests.
getWdaBaseUrl() - Method in interface io.appium.java_client.ios.options.wda.SupportsWdaBaseUrlOption
Get a prefix to build a custom WebDriverAgent URL.
getWdaConnectionTimeout() - Method in interface io.appium.java_client.ios.options.wda.SupportsWdaConnectionTimeoutOption
Get the maximum timeout to wait until WDA responds to HTTP requests.
getWdaEventloopIdleDelay() - Method in interface io.appium.java_client.ios.options.wda.SupportsWdaEventloopIdleDelayOption
Get the event loop idle delay.
getWdaLaunchTimeout() - Method in interface io.appium.java_client.ios.options.wda.SupportsWdaLaunchTimeoutOption
Get the maximum timeout to wait until WDA is listening.
getWdaLocalPort() - Method in interface io.appium.java_client.ios.options.wda.SupportsWdaLocalPortOption
Get the local port number where the WDA traffic is being forwarded.
getWdaStartupRetries() - Method in interface io.appium.java_client.ios.options.wda.SupportsWdaStartupRetriesOption
Get number of retries before to fail WDA deployment.
getWdaStartupRetryInterval() - Method in interface io.appium.java_client.ios.options.wda.SupportsWdaStartupRetryIntervalOption
Get the interval to wait between tries to build and launch WebDriverAgent.
getWebDriverAgentMacUrl() - Method in interface io.appium.java_client.mac.options.SupportsWebDriverAgentMacUrlOption
Get the URL Appium will connect to an existing WebDriverAgentMac instance.
getWebDriverAgentUrl() - Method in interface io.appium.java_client.ios.options.wda.SupportsWebDriverAgentUrlOption
Get the WDA URL.
getWebkitResponseTimeout() - Method in interface io.appium.java_client.ios.options.simulator.SupportsWebkitResponseTimeoutOption
Get the time to wait for a response from WebKit in a Safari session.
getWebkitWebrtc() - Method in interface io.appium.java_client.safari.options.SupportsWebkitWebrtcOption
Get WebRTC policies.
getWebviewConnectRetries() - Method in interface io.appium.java_client.ios.options.webview.SupportsWebviewConnectRetriesOption
Get the number of retries to send connection message to remote debugger, to get a webview.
getWebviewConnectTimeout() - Method in interface io.appium.java_client.ios.options.webview.SupportsWebkitResponseTimeoutOption
Get the timeout to wait for a response from WebKit in a Safari session.
getWebviewConnectTimeout() - Method in interface io.appium.java_client.ios.options.webview.SupportsWebviewConnectTimeoutOption
Get the timeout to wait for the initial presence of webviews.
getWebviewDevtoolsPort() - Method in interface io.appium.java_client.android.options.context.SupportsWebviewDevtoolsPortOption
Get the local port number to use for devtools communication.
getWrappedDriver() - Method in class io.appium.java_client.pagefactory.Widget
 
getWrappedElement() - Method in class io.appium.java_client.pagefactory.Widget
 
getXcodeCertificate() - Method in interface io.appium.java_client.ios.options.wda.SupportsXcodeCertificateOptions
Get a signing certificate for WebDriverAgent compilation.
GFTT - io.appium.java_client.imagecomparison.FeatureDetector
 
GOOD - io.appium.java_client.android.GsmSignalStrength
 
GPRS - io.appium.java_client.android.NetworkSpeed
 
GPS_ENABLED_OPTION - Static variable in interface io.appium.java_client.android.options.avd.SupportsGpsEnabledOption
 
gpsEnabled() - Method in interface io.appium.java_client.android.options.avd.SupportsGpsEnabledOption
Enables GPS service in the Emulator.
GRAVE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '`' (backtick) key.
GREAT - io.appium.java_client.android.GsmSignalStrength
 
GSM - io.appium.java_client.android.NetworkSpeed
 
GSM_CALL - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
GSM_SIGNAL - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
GSM_VOICE - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
GsmCallActions - Enum in io.appium.java_client.android
 
gsmCallCommand(String, GsmCallActions) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
Deprecated.
GsmSignalStrength - Enum in io.appium.java_client.android
 
gsmSignalStrengthCommand(GsmSignalStrength) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
Deprecated.
gsmVoiceCommand(GsmVoiceState) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
Deprecated.
GsmVoiceState - Enum in io.appium.java_client.android
 
GUIDE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Guide key.

H

H - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'H' key.
HasAndroidClipboard - Interface in io.appium.java_client.android
 
HasAndroidDeviceDetails - Interface in io.appium.java_client.android
 
HasAndroidSettings - 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
 
HasBrowserCheck - Interface in io.appium.java_client
 
HasClipboard - Interface in io.appium.java_client.clipboard
 
HasDeviceTime - Interface in io.appium.java_client
 
hashCode() - Method in class io.appium.java_client.AppiumBy
 
hashCode() - Method in class io.appium.java_client.pagefactory.bys.ContentMappedBy
 
HasIOSClipboard - Interface in io.appium.java_client.ios
 
HasIOSSettings - Interface in io.appium.java_client.ios
 
HasMethodCallListeners - Interface in io.appium.java_client.proxy
 
HasNetworkConnection - Interface in io.appium.java_client.android.connection
 
HasNotifications - Interface in io.appium.java_client.android
 
HasOnScreenKeyboard - Interface in io.appium.java_client
 
HasSettings - Interface in io.appium.java_client
 
HasSupportedPerformanceDataType - Interface in io.appium.java_client.android
 
headless() - Method in interface io.appium.java_client.remote.options.SupportsIsHeadlessOption
Set emulator/simulator to start in headless mode (e.g.
HEADSETHOOK - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Headset Hook key.
HELP - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Help key.
Helpers - Class in io.appium.java_client.proxy
 
HENKAN - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Japanese conversion key.
HIDE_KEYBOARD - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
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.
hideKeyboardCommand(String) - Static method in class io.appium.java_client.MobileCommand
Deprecated.
This helper is deprecated and will be removed in future versions.
hideKeyboardCommand(String, String) - Static method in class io.appium.java_client.MobileCommand
Deprecated.
This helper is deprecated and will be removed in future versions.
HideKeyboardStrategy - Interface in io.appium.java_client.remote
 
HidesKeyboard - Interface in io.appium.java_client
 
HidesKeyboardWithKeyName - Interface in io.appium.java_client
 
HIGH - io.appium.java_client.ios.IOSStartScreenRecordingOptions.VideoQuality
 
HOLD - io.appium.java_client.android.GsmCallActions
 
HOME - io.appium.java_client.android.GsmVoiceState
 
HOME - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Home key.
HowToUseLocators - Annotation Type in io.appium.java_client.pagefactory
 
HowToUseSelectors - Enum in io.appium.java_client.pagefactory.bys.builder
 
HSDPA - io.appium.java_client.android.NetworkSpeed
 
html() - Method in annotation type io.appium.java_client.pagefactory.OverrideWidget
This property is designed for HTML (browser or web view) content.
HTML_OR_DEFAULT - io.appium.java_client.pagefactory.bys.ContentType
 

I

I - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'I' key.
id() - Method in annotation type io.appium.java_client.pagefactory.AndroidBy
It is an id of the target element.
id() - Method in annotation type io.appium.java_client.pagefactory.AndroidFindBy
It is an id of the target element.
id() - Method in annotation type io.appium.java_client.pagefactory.iOSBy
It is an id of the target element.
id() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITBy
It is an id of the target element.
id() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITFindBy
It is an id of the target element.
id(String) - Static method in class io.appium.java_client.AppiumBy
For IOS the element name.
IGNORE - io.appium.java_client.remote.options.UnhandledPromptBehavior
 
IGNORE_HIDDEN_API_POLICY_ERROR_OPTION - Static variable in interface io.appium.java_client.android.options.adb.SupportsIgnoreHiddenApiPolicyErrorOption
 
IGNORE_UNIMPORTANT_VIEWS - io.appium.java_client.Setting
 
ignoreHiddenApiPolicyError() - Method in interface io.appium.java_client.android.options.adb.SupportsIgnoreHiddenApiPolicyErrorOption
Prevents the driver from ever killing the ADB server explicitl.
ignoreUnimportantViews(Boolean) - Method in interface io.appium.java_client.android.HasAndroidSettings
Set the `ignoreUnimportantViews` setting.
image(String) - Static method in class io.appium.java_client.AppiumBy
This locator strategy is available only if OpenCV libraries and Node.js bindings are installed on the server machine.
IMAGE - io.appium.java_client.clipboard.ClipboardContentType
 
IMAGE_ELEMENT_TAP_STRATEGY - io.appium.java_client.Setting
 
IMAGE_MATCH_THRESHOLD - io.appium.java_client.Setting
 
INCLUDE_DEVICE_CAPS_TO_SESSION_INFO_OPTION - Static variable in interface io.appium.java_client.ios.options.general.SupportsIncludeDeviceCapsToSessionInfoOption
 
INCLUDE_SAFARI_IN_WEBVIEWS_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsIncludeSafariInWebviewsOption
 
includeSafariInWebviews() - Method in interface io.appium.java_client.ios.options.webview.SupportsIncludeSafariInWebviewsOption
Enforces Safari web views to be added to the list of contexts available during a native/webview app test.
INFO - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Info key.
INSERT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Insert key.
INSTALL_APP - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
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.
INSTANCE - Static variable in class io.appium.java_client.remote.options.W3CCapabilityKeys
 
INTENT_ACTION_OPTION - Static variable in interface io.appium.java_client.android.options.app.SupportsIntentActionOption
 
INTENT_CATEGORY_OPTION - Static variable in interface io.appium.java_client.android.options.app.SupportsIntentCategoryOption
 
INTENT_FLAGS_OPTION - Static variable in interface io.appium.java_client.android.options.app.SupportsIntentFlagsOption
 
INTENT_OPTIONS_OPTION - Static variable in interface io.appium.java_client.android.options.app.SupportsIntentOptionsOption
 
IntentOptions - Class in io.appium.java_client.android.options.app
 
IntentOptions() - Constructor for class io.appium.java_client.android.options.app.IntentOptions
 
IntentOptions(Map<String, Object>) - Constructor for class io.appium.java_client.android.options.app.IntentOptions
 
InteractsWithApps - Interface in io.appium.java_client
 
intercept(Object, Method, Object[], Callable<?>) - Static method in class io.appium.java_client.proxy.Interceptor
A magic method used to wrap public method calls in classes patched by ByteBuddy and acting as proxies.
Interceptor - Class in io.appium.java_client.proxy
 
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, WeakReference<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) - Constructor for exception io.appium.java_client.service.local.InvalidServerInstanceException
 
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.geolocation - package io.appium.java_client.android.geolocation
 
io.appium.java_client.android.nativekey - package io.appium.java_client.android.nativekey
 
io.appium.java_client.android.options - package io.appium.java_client.android.options
 
io.appium.java_client.android.options.adb - package io.appium.java_client.android.options.adb
 
io.appium.java_client.android.options.app - package io.appium.java_client.android.options.app
 
io.appium.java_client.android.options.avd - package io.appium.java_client.android.options.avd
 
io.appium.java_client.android.options.context - package io.appium.java_client.android.options.context
 
io.appium.java_client.android.options.localization - package io.appium.java_client.android.options.localization
 
io.appium.java_client.android.options.locking - package io.appium.java_client.android.options.locking
 
io.appium.java_client.android.options.mjpeg - package io.appium.java_client.android.options.mjpeg
 
io.appium.java_client.android.options.other - package io.appium.java_client.android.options.other
 
io.appium.java_client.android.options.server - package io.appium.java_client.android.options.server
 
io.appium.java_client.android.options.signing - package io.appium.java_client.android.options.signing
 
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.chromium - package io.appium.java_client.chromium
 
io.appium.java_client.chromium.options - package io.appium.java_client.chromium.options
 
io.appium.java_client.clipboard - package io.appium.java_client.clipboard
 
io.appium.java_client.driverscripts - package io.appium.java_client.driverscripts
 
io.appium.java_client.functions - package io.appium.java_client.functions
 
io.appium.java_client.gecko - package io.appium.java_client.gecko
 
io.appium.java_client.gecko.options - package io.appium.java_client.gecko.options
 
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.internal.filters - package io.appium.java_client.internal.filters
 
io.appium.java_client.ios - package io.appium.java_client.ios
 
io.appium.java_client.ios.options - package io.appium.java_client.ios.options
 
io.appium.java_client.ios.options.app - package io.appium.java_client.ios.options.app
 
io.appium.java_client.ios.options.general - package io.appium.java_client.ios.options.general
 
io.appium.java_client.ios.options.other - package io.appium.java_client.ios.options.other
 
io.appium.java_client.ios.options.simulator - package io.appium.java_client.ios.options.simulator
 
io.appium.java_client.ios.options.wda - package io.appium.java_client.ios.options.wda
 
io.appium.java_client.ios.options.webview - package io.appium.java_client.ios.options.webview
 
io.appium.java_client.ios.touch - package io.appium.java_client.ios.touch
 
io.appium.java_client.mac - package io.appium.java_client.mac
 
io.appium.java_client.mac.options - package io.appium.java_client.mac.options
 
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.proxy - package io.appium.java_client.proxy
 
io.appium.java_client.remote - package io.appium.java_client.remote
 
io.appium.java_client.remote.options - package io.appium.java_client.remote.options
 
io.appium.java_client.safari - package io.appium.java_client.safari
 
io.appium.java_client.safari.options - package io.appium.java_client.safari.options
 
io.appium.java_client.screenrecording - package io.appium.java_client.screenrecording
 
io.appium.java_client.serverevents - package io.appium.java_client.serverevents
 
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.windows.options - package io.appium.java_client.windows.options
 
io.appium.java_client.ws - package io.appium.java_client.ws
 
IOS - Static variable in interface io.appium.java_client.remote.MobilePlatform
 
IOS_SIMULATOR_LOGS_PREDICATE_OPTION - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsIosSimulatorLogsPredicateOption
 
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() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITBy
The Class Chain locator is similar to xpath, but it's faster and can only search direct children elements.
iOSClassChain() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITFindBy
The Class Chain locator is similar to xpath, but it's faster and can only search direct children elements.
iOSClassChain(String) - Static method in class io.appium.java_client.AppiumBy
This locator strategy is available in XCUITest Driver mode.
IOSDriver - Class in io.appium.java_client.ios
iOS driver implementation.
IOSDriver(AppiumClientConfig, Capabilities) - Constructor for class io.appium.java_client.ios.IOSDriver
Creates a new instance based on the given ClientConfig 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(URL) - Constructor for class io.appium.java_client.ios.IOSDriver
This is a special constructor used to connect to a running driver instance.
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(Capabilities) - Constructor for class io.appium.java_client.ios.IOSDriver
Creates a new instance based on capabilities.
IOSDriver(ClientConfig, Capabilities) - Constructor for class io.appium.java_client.ios.IOSDriver
Creates a new instance based on the given ClientConfig 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(HttpCommandExecutor, Capabilities) - Constructor for class io.appium.java_client.ios.IOSDriver
Creates a new instance based on command executor and capabilities.
IOSMobileCommandHelper - Class in io.appium.java_client.ios
Deprecated.
IOSMobileCommandHelper() - Constructor for class io.appium.java_client.ios.IOSMobileCommandHelper
Deprecated.
 
iOSNsPredicate() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITBy
The NSPredicate class is used to define logical conditions used to constrain a search either for a fetch or for in-memory filtering.
iOSNsPredicate() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITFindBy
The NSPredicate class is used to define logical conditions used to constrain a search either for a fetch or for in-memory filtering.
iOSNsPredicateString(String) - Static method in class io.appium.java_client.AppiumBy
This locator strategy is available in XCUITest Driver mode.
iosPressOptions() - Static method in class io.appium.java_client.ios.touch.IOSPressOptions
It creates an empty instance of IOSPressOptions.
IOSPressOptions - Class in io.appium.java_client.ios.touch
 
IOSPressOptions() - Constructor for class io.appium.java_client.ios.touch.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
 
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
Deprecated.
Touch actions are deprecated. Please use W3C Actions instead or the corresponding extension methods for the driver (if available). Check - https://www.youtube.com/watch?v=oAJ7jwMNFVU - https://appiumpro.com/editions/30-ios-specific-touch-action-methods - https://appiumpro.com/editions/29-automating-complex-gestures-with-the-w3c-actions-api for more details.
IOSTouchAction(PerformsTouchActions) - Constructor for class io.appium.java_client.ios.IOSTouchAction
Deprecated.
 
iOSXCUITAutomation() - Method in annotation type io.appium.java_client.pagefactory.HowToUseLocators
The strategy which defines how to use locators which are described by the iOSXCUITFindBy annotation.
iOSXCUITAutomation() - Method in annotation type io.appium.java_client.pagefactory.OverrideWidget
This property is designed for iOS native content when AutomationName.IOS_XCUI_TEST automation is used.
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
 
IPA_ABSOLUTE_PATH - io.appium.java_client.service.local.flags.IOSServerFlag
absolute path to compiled .ipa file.
IS_APP_INSTALLED - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
IS_HEADLESS_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsIsHeadlessOption
 
IS_KEYBOARD_SHOWN - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
IS_LOCKED - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
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.
isAutodownloadEnabled() - Method in interface io.appium.java_client.chromium.options.SupportsAutodownloadOption
Get the auto download flag.
isBrowser() - Method in interface io.appium.java_client.HasBrowserCheck
Validates if the driver is currently in a web browser context.
isBuildCheckDisabled() - Method in interface io.appium.java_client.chromium.options.SupportsBuildCheckOption
Get disable build check flag.
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.
isDirectConnectEnabled() - Method in class io.appium.java_client.AppiumClientConfig
Whether enable directConnect feature is enabled.
isEnablePerformanceLogging() - Method in interface io.appium.java_client.remote.options.SupportsEnablePerformanceLoggingOption
Get the app logs performance.
isExperimentalWebDriver() - Method in interface io.appium.java_client.windows.options.SupportsMsExperimentalWebDriverOption
Get whether to enable experimental features and optimizations.
isGamepadButton() - Method in enum io.appium.java_client.android.nativekey.AndroidKey
Returns true if the specified nativekey is a gamepad button.
isHeadless() - Method in interface io.appium.java_client.remote.options.SupportsIsHeadlessOption
Get whether the emulator/simulator starts in headless mode.
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 on-screen keyboard is displayed.
isKeyboardShownCommand() - Static method in class io.appium.java_client.MobileCommand
Deprecated.
This helper is deprecated and will be removed in future versions.
isListening() - Method in class io.appium.java_client.ws.StringWebSocketClient
 
isLocationServicesEnabled() - Method in interface io.appium.java_client.android.SupportsGpsStateManagement
Check GPS service state.
isLockedCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
Deprecated.
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.
ISOLATE_SIM_DEVICE - io.appium.java_client.service.local.flags.IOSServerFlag
Xcode 6 has a bug on some platforms where a certain simulator can only be launched without error if all other simulator devices are first deleted.
isRunning() - Method in class io.appium.java_client.service.local.AppiumDriverLocalService
 
isSystemKey() - Method in enum io.appium.java_client.android.nativekey.AndroidKey
Is this a system key? System keys can not be used for menu shortcuts.
isTvOS() - Method in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
isUseSystemExecutable() - Method in interface io.appium.java_client.chromium.options.SupportsUseSystemExecutableOption
Get the use system executable flag.
isValid() - Method in class io.appium.java_client.remote.DirectConnect
Returns true if the DirectConnect instance member has nonnull values.
isVerbose() - Method in interface io.appium.java_client.chromium.options.SupportsVerboseOption
Get the verbose flag.
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

J - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'J' key.
jsonData - Variable in class io.appium.java_client.serverevents.ServerEvents
 

K

K - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'K' key.
KANA - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Japanese kana key.
KATAKANA_HIRAGANA - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Japanese katakana / hiragana key.
KAZE - io.appium.java_client.imagecomparison.FeatureDetector
 
KEEP_KEY_CHAINS_OPTION - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsKeepKeyChainsOption
 
KEEP_TOUCH_MODE - io.appium.java_client.android.nativekey.KeyEventFlag
This mask is set if we don't want the key event to cause us to leave touch mode.
keepKeyChains() - Method in interface io.appium.java_client.ios.options.simulator.SupportsKeepKeyChainsOption
Enforce preservation of Simulator keychains folder after full reset.
KEY_11 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '11' key.
KEY_12 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '12' key.
KEY_ALIAS_OPTION - Static variable in interface io.appium.java_client.android.options.signing.SupportsKeystoreOptions
 
KEY_INJECTION_DELAY - io.appium.java_client.Setting
 
KEY_PASSWORD_OPTION - Static variable in interface io.appium.java_client.android.options.signing.SupportsKeystoreOptions
 
KEYBOARD_AUTOCORRECTION - io.appium.java_client.Setting
 
KEYBOARD_PREDICTION - io.appium.java_client.Setting
 
Keychain - Class in io.appium.java_client.ios.options.wda
 
Keychain() - Constructor for class io.appium.java_client.ios.options.wda.Keychain
 
KEYCHAIN_PASSWORD_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsKeychainOptions
 
KEYCHAIN_PATH_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsKeychainOptions
 
KEYCHAINS_EXCLUDE_PATTERNS_OPTION - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsKeychainsExcludePatternsOption
 
KEYCODE_ZOOM_IN - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Zoom in key.
KEYCODE_ZOOM_OUT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Zoom out key.
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_OPTION - Static variable in interface io.appium.java_client.android.options.signing.SupportsKeystoreOptions
 
KEYSTORE_PATH_OPTION - Static variable in interface io.appium.java_client.android.options.signing.SupportsKeystoreOptions
 
KeystoreConfig - Class in io.appium.java_client.android.options.signing
 
KeystoreConfig() - Constructor for class io.appium.java_client.android.options.signing.KeystoreConfig
 

L

L - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'L' key.
LANGUAGE_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsLanguageOption
 
LANGUAGE_SWITCH - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Language Switch key.
LAST_CHANNEL - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Last Channel key.
LAUNCH_APP - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
LAUNCH_WITH_IDB_OPTION - Static variable in interface io.appium.java_client.ios.options.other.SupportsLaunchWithIdbOption
 
launchApp() - Method in class io.appium.java_client.windows.WindowsDriver
Launch the application app under test after it was closed.
launchWithIdb() - Method in interface io.appium.java_client.ios.options.other.SupportsLaunchWithIdbOption
Enforces launching of WebDriverAgentRunner with idb instead of xcodebuild.
LEFT_BRACKET - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '[' key.
ListensToLogcatMessages - Interface in io.appium.java_client.android
 
ListensToSyslogMessages - Interface in io.appium.java_client.ios
 
loadSystemProperties() - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
 
LOCAL_TIMEZONE - io.appium.java_client.service.local.flags.GeneralServerFlag
Use local timezone for timestamps.
LOCALE_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsLocaleOption
 
LOCALE_SCRIPT_OPTION - Static variable in interface io.appium.java_client.android.options.localization.SupportsLocaleScriptOption
 
LOCALIZABLE_STRINGS_DIR_OPTION - Static variable in interface io.appium.java_client.ios.options.app.SupportsLocalizableStringsDirOption
 
location() - Method in interface io.appium.java_client.remote.SupportsLocation
Deprecated, for removal: This API element is subject to removal in a future version.
This method and whole LocationContext interface are deprecated, use SupportsLocation.getLocation() instead.
Location - Class in io.appium.java_client
Represents the physical location.
Location(double, double) - Constructor for class io.appium.java_client.Location
Create Location with latitude and longitude values.
Location(double, double, Double) - Constructor for class io.appium.java_client.Location
Create Location with latitude, longitude and altitude values.
locationContext - Variable in class io.appium.java_client.AppiumDriver
Deprecated, for removal: This API element is subject to removal in a future version.
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
Deprecated.
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
Deprecated.
This helper is deprecated and will be removed in future versions.
LocksDevice - Interface in io.appium.java_client
 
LOG_EVENT - Static variable in class io.appium.java_client.MobileCommand
 
LOG_LEVEL - io.appium.java_client.service.local.flags.GeneralServerFlag
The message log level to be shown.
LOG_NO_COLORS - io.appium.java_client.service.local.flags.GeneralServerFlag
Don’t use colors in console output.
LOG_PATH - Static variable in interface io.appium.java_client.chromium.options.SupportsLogPathOption
 
LOG_TIMESTAMP - io.appium.java_client.service.local.flags.GeneralServerFlag
Show timestamps in console output.
LOGCAT_FILTER_SPECS_OPTION - Static variable in interface io.appium.java_client.android.options.adb.SupportsLogcatFilterSpecsOption
 
LOGCAT_FORMAT_OPTION - Static variable in interface io.appium.java_client.android.options.adb.SupportsLogcatFormatOption
 
logEvent(CustomEvent) - Method in interface io.appium.java_client.LogsEvents
Log a custom event on the Appium server.
LogsEvents - Interface in io.appium.java_client
 
LONG_PRESS - io.appium.java_client.android.nativekey.KeyEventFlag
This flag is set for the first key repeat that occurs after the long press timeout.
LONG_PRESS_KEY_CODE - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
longPress(LongPressOptions) - Method in class io.appium.java_client.TouchAction
Deprecated.
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
Deprecated.
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.
longPressKeyCodeCommand(int) - Static method in class io.appium.java_client.MobileCommand
Deprecated.
This helper is deprecated and will be removed in future versions.
longPressKeyCodeCommand(int, Integer) - Static method in class io.appium.java_client.MobileCommand
Deprecated.
This helper is deprecated and will be removed in future versions.
longPressOptions() - Static method in class io.appium.java_client.touch.LongPressOptions
It creates an empty instance of LongPressOptions.
LongPressOptions - Class in io.appium.java_client.touch
 
LongPressOptions() - Constructor for class io.appium.java_client.touch.LongPressOptions
 
LOW - io.appium.java_client.ios.IOSStartScreenRecordingOptions.VideoQuality
 
LTE - io.appium.java_client.android.NetworkSpeed
 

M

M - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'M' key.
MAC - Static variable in interface io.appium.java_client.remote.MobilePlatform
 
MAC2 - Static variable in interface io.appium.java_client.remote.AutomationName
 
Mac2Driver - Class in io.appium.java_client.mac
Mac2Driver is an officially supported Appium driver created to automate Mac OS apps.
Mac2Driver(AppiumClientConfig, Capabilities) - Constructor for class io.appium.java_client.mac.Mac2Driver
Creates a new instance based on the given ClientConfig and capabilities.
Mac2Driver(AppiumDriverLocalService, Capabilities) - Constructor for class io.appium.java_client.mac.Mac2Driver
 
Mac2Driver(AppiumDriverLocalService, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.mac.Mac2Driver
 
Mac2Driver(AppiumServiceBuilder, Capabilities) - Constructor for class io.appium.java_client.mac.Mac2Driver
 
Mac2Driver(AppiumServiceBuilder, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.mac.Mac2Driver
 
Mac2Driver(URL) - Constructor for class io.appium.java_client.mac.Mac2Driver
This is a special constructor used to connect to a running driver instance.
Mac2Driver(URL, Capabilities) - Constructor for class io.appium.java_client.mac.Mac2Driver
 
Mac2Driver(URL, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.mac.Mac2Driver
 
Mac2Driver(Capabilities) - Constructor for class io.appium.java_client.mac.Mac2Driver
 
Mac2Driver(ClientConfig, Capabilities) - Constructor for class io.appium.java_client.mac.Mac2Driver
Creates a new instance based on the given ClientConfig and capabilities.
Mac2Driver(HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.mac.Mac2Driver
 
Mac2Driver(HttpCommandExecutor, Capabilities) - Constructor for class io.appium.java_client.mac.Mac2Driver
 
Mac2Options - Class in io.appium.java_client.mac.options
https://github.com/appium/appium-mac2-driver#capabilities
Mac2Options() - Constructor for class io.appium.java_client.mac.options.Mac2Options
 
Mac2Options(Map<String, ?>) - Constructor for class io.appium.java_client.mac.options.Mac2Options
 
Mac2Options(Capabilities) - Constructor for class io.appium.java_client.mac.options.Mac2Options
 
Mac2StartScreenRecordingOptions - Class in io.appium.java_client.mac
 
Mac2StartScreenRecordingOptions() - Constructor for class io.appium.java_client.mac.Mac2StartScreenRecordingOptions
 
Mac2StopScreenRecordingOptions - Class in io.appium.java_client.mac
 
Mac2StopScreenRecordingOptions() - Constructor for class io.appium.java_client.mac.Mac2StopScreenRecordingOptions
 
main() - Static method in class io.appium.java_client.internal.Config
Retrieve a facade for the main config.
makeGsmCall(String, GsmCallActions) - Method in interface io.appium.java_client.android.SupportsSpecialEmulatorCommands
Emulate GSM call event on the connected emulator.
MANNER_MODE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Manner Mode key.
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.
MARIONETTE_PORT_OPTION - Static variable in interface io.appium.java_client.gecko.options.SupportsMarionettePortOption
 
markExtensionAbsence(String) - Method in class io.appium.java_client.AppiumDriver
 
markExtensionAbsence(String) - Method in interface io.appium.java_client.CanRememberExtensionPresence
Marks the given extension as absent for the given driver instance.
MATCH_FEATURES - io.appium.java_client.imagecomparison.ComparisonMode
 
MATCH_TEMPLATE - io.appium.java_client.imagecomparison.ComparisonMode
 
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_TYPING_FREQUENCY_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsMaxTypingFrequencyOption
 
MEDIA_AUDIO_TRACK - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Audio Track key.
MEDIA_CLOSE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Close media key.
MEDIA_EJECT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Eject media key.
MEDIA_FAST_FORWARD - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Fast Forward media key.
MEDIA_NEXT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Play Next media key.
MEDIA_PAUSE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Pause media key.
MEDIA_PLAY - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Play media key.
MEDIA_PLAY_PAUSE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Play/Pause media key.
MEDIA_PREVIOUS - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Play Previous media key.
MEDIA_RECORD - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Record media key.
MEDIA_REWIND - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Rewind media key.
MEDIA_SKIP_BACKWARD - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Skip backward media key.
MEDIA_SKIP_FORWARD - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Skip forward media key.
MEDIA_STEP_BACKWARD - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Step backward media key.
MEDIA_STEP_FORWARD - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Step forward media key.
MEDIA_STOP - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Stop media key.
MEDIA_TOP_MENU - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Media Top Menu key.
MEDIUM - io.appium.java_client.ios.IOSStartScreenRecordingOptions.VideoQuality
 
MENU - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Menu key.
merge(Capabilities) - Method in class io.appium.java_client.remote.options.BaseOptions
 
META_LEFT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Left Meta modifier key.
META_LEFT_ON - io.appium.java_client.android.nativekey.KeyEventMetaModifier
This mask is used to check whether the left META meta key is pressed.
META_MASK - io.appium.java_client.android.nativekey.KeyEventMetaModifier
META_ON - io.appium.java_client.android.nativekey.KeyEventMetaModifier
This mask is used to check whether one of the META meta keys is pressed.
META_RIGHT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Right Meta modifier key.
META_RIGHT_ON - io.appium.java_client.android.nativekey.KeyEventMetaModifier
This mask is used to check whether the right META meta key is pressed.
MethodCallListener - Interface in io.appium.java_client.proxy
 
MINUS - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '-'.
MJPEG_SCALING_FACTOR - io.appium.java_client.Setting
 
MJPEG_SCREENSHOT_URL_OPTION - Static variable in interface io.appium.java_client.android.options.mjpeg.SupportsMjpegScreenshotUrlOption
 
MJPEG_SERVER_FRAMERATE - io.appium.java_client.Setting
 
MJPEG_SERVER_PORT_OPTION - Static variable in interface io.appium.java_client.android.options.mjpeg.SupportsMjpegServerPortOption
 
MJPEG_SERVER_PORT_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsMjpegServerPortOption
 
MJPEG_SERVER_SCREENSHOT_QUALITY - io.appium.java_client.Setting
 
MobileBrowserType - Interface in io.appium.java_client.remote
 
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
 
MobilePlatform - Interface in io.appium.java_client.remote
 
MOCK_LOCATION_APP_OPTION - Static variable in interface io.appium.java_client.android.options.adb.SupportsMockLocationAppOption
 
MODE_3D - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 3D Mode key.
MODERATE - io.appium.java_client.android.GsmSignalStrength
 
MOVE_END - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: End Movement key.
MOVE_HOME - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Home Movement key.
moveTo(PointOption) - Method in class io.appium.java_client.TouchAction
Deprecated.
Moves current touch to a new position.
MOZ_FIREFOX_OPTIONS_OPTION - Static variable in interface io.appium.java_client.gecko.options.SupportsMozFirefoxOptionsOption
 
MS_EXPERIMENTAL_WEBDRIVER_OPTION - Static variable in interface io.appium.java_client.windows.options.SupportsMsExperimentalWebDriverOption
 
MS_WAIT_FOR_APP_LAUNCH_OPTION - Static variable in interface io.appium.java_client.windows.options.SupportsMsWaitForAppLaunchOption
 
MSER - io.appium.java_client.imagecomparison.FeatureDetector
 
MUHENKAN - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Japanese non-conversion key.
MultiTouchAction - Class in io.appium.java_client
Deprecated.
Touch actions are deprecated. Please use W3C Actions instead or the corresponding extension methods for the driver (if available). Check - https://www.youtube.com/watch?v=oAJ7jwMNFVU - https://appiumpro.com/editions/30-ios-specific-touch-action-methods - https://appiumpro.com/editions/29-automating-complex-gestures-with-the-w3c-actions-api for more details.
MultiTouchAction(PerformsTouchActions) - Constructor for class io.appium.java_client.MultiTouchAction
Deprecated.
 
MUSIC - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Music special function key.
MUTE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Mute key.

N

N - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'N' key.
name - Variable in class io.appium.java_client.serverevents.CommandEvent
 
name - Variable in class io.appium.java_client.serverevents.TimedEvent
 
name(String) - Static method in class io.appium.java_client.AppiumBy
For IOS the element name.
NATIVE_MOBILE_SPECIFIC - io.appium.java_client.pagefactory.bys.ContentType
 
NATIVE_WEB_SCREENSHOT_OPTION - Static variable in interface io.appium.java_client.android.options.context.SupportsNativeWebScreenshotOption
 
NATIVE_WEB_TAP - io.appium.java_client.Setting
 
NATIVE_WEB_TAP_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsNativeWebTapOption
 
NATIVE_WEB_TAP_STRICT_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsNativeWebTapStrictOption
 
nativeWebScreenshot() - Method in interface io.appium.java_client.android.options.context.SupportsNativeWebScreenshotOption
Enforce to use screenshoting endpoint provided by UiAutomator framework rather than the one provided by chromedriver.
nativeWebTap() - Method in interface io.appium.java_client.ios.options.webview.SupportsNativeWebTapOption
Enforces native non-javascript-based taps in web context mode.
nativeWebTap(Boolean) - Method in interface io.appium.java_client.ios.HasIOSSettings
Set the `nativeWebTap` setting.
nativeWebTapStrict() - Method in interface io.appium.java_client.ios.options.webview.SupportsNativeWebTapStrictOption
Enforce native taps to be done by XCUITest driver rather than WebDriverAgent.
NAVIGATE_IN - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Navigate in key.
NAVIGATE_NEXT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Navigate to next key.
NAVIGATE_OUT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Navigate out key.
NAVIGATE_PREVIOUS - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Navigate to previous key.
NETWORK_SPEED - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
NETWORK_SPEED_OPTION - Static variable in interface io.appium.java_client.android.options.avd.SupportsNetworkSpeedOption
 
NetworkSpeed - Enum in io.appium.java_client.android
 
networkSpeedCommand(NetworkSpeed) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
Deprecated.
NEW_COMMAND_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsNewCommandTimeoutOption
 
NO_PERMS_CHECKS - io.appium.java_client.service.local.flags.GeneralServerFlag
Bypass Appium’s checks to ensure we can read/write necessary files.
NO_RESET_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsNoResetOption
 
NO_SIGN_OPTION - Static variable in interface io.appium.java_client.android.options.signing.SupportsNoSignOption
 
NO_SUCH_CONTEXT - Static variable in class io.appium.java_client.ErrorCodesMobile
 
NONE_OR_UNKNOWN - io.appium.java_client.android.GsmSignalStrength
 
noReset() - Method in interface io.appium.java_client.remote.options.SupportsNoResetOption
Set the app not to do a reset.
NORMALIZE_TAG_NAMES - io.appium.java_client.Setting
 
normalizeTagNames(boolean) - Method in interface io.appium.java_client.android.HasAndroidSettings
Setting this value to true will enforce source tree dumper to transliterate all class names used as XML tags to the limited set of ASCII characters supported by Apache Harmony lib and used by default in Android to avoid possible XML parsing exceptions caused by XPath lookup.
noSign() - Method in interface io.appium.java_client.android.options.signing.SupportsNoSignOption
Skips application signing.
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
 
NOT_CHARGING - io.appium.java_client.android.AndroidBatteryInfo.BatteryState
 
NOT_INSTALLED - io.appium.java_client.appmanagement.ApplicationState
 
NOT_RUNNING - io.appium.java_client.appmanagement.ApplicationState
 
NOTIFICATION - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Notification key.
NotImplementedException - Exception in io.appium.java_client.proxy
 
NotImplementedException() - Constructor for exception io.appium.java_client.proxy.NotImplementedException
 
NUM - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Number modifier key.
NUM_LOCK - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Num Lock key.
NUM_LOCK_ON - io.appium.java_client.android.nativekey.KeyEventMetaModifier
This mask is used to check whether the NUM LOCK meta key is on.
NUMPAD_0 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad '0' key.
NUMPAD_1 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad '1' key.
NUMPAD_2 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad '2' key.
NUMPAD_3 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad '3' key.
NUMPAD_4 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad '4' key.
NUMPAD_5 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad '5' key.
NUMPAD_6 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad '6' key.
NUMPAD_7 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad '7' key.
NUMPAD_8 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad '8' key.
NUMPAD_9 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad '9' key.
NUMPAD_ADD - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad '+' key (for addition).
NUMPAD_COMMA - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad ',' key (for decimals or digit grouping).
NUMPAD_DIVIDE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad '/' key (for division).
NUMPAD_DOT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad '.' key (for decimals or digit grouping).
NUMPAD_ENTER - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad Enter key.
NUMPAD_EQUALS - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad '=' key.
NUMPAD_LEFT_PAREN - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad '(' key.
NUMPAD_MULTIPLY - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad '*' key (for multiplication).
NUMPAD_RIGHT_PAREN - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad ')' key.
NUMPAD_SUBTRACT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Numeric keypad '-' key (for subtraction).

O

O - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'O' key.
OBJECT_METHOD_NAMES - Static variable in class io.appium.java_client.proxy.Helpers
 
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
 
occurrences - Variable in class io.appium.java_client.serverevents.TimedEvent
 
ofCode(long) - Static method in enum io.appium.java_client.appmanagement.ApplicationState
Creates ApplicationState instance based on the code.
OFF - io.appium.java_client.android.GsmVoiceState
 
OFF - io.appium.java_client.android.PowerACState
 
OFF - io.appium.java_client.ios.options.simulator.PasteboardSyncState
 
ON - io.appium.java_client.android.GsmVoiceState
 
ON - io.appium.java_client.android.PowerACState
 
ON - io.appium.java_client.ios.options.simulator.PasteboardSyncState
 
onClose(int, String) - Method in class io.appium.java_client.ws.StringWebSocketClient
 
onError(Object, Method, Object[], Throwable) - Method in interface io.appium.java_client.proxy.MethodCallListener
The callback to be invoked if a public method or its Call replacement throws an exception.
onError(Throwable) - Method in class io.appium.java_client.ws.StringWebSocketClient
 
onOpen() - Method in class io.appium.java_client.ws.StringWebSocketClient
The callback method invoked on websocket opening.
onText(CharSequence) - Method in class io.appium.java_client.ws.StringWebSocketClient
 
OPEN_NOTIFICATIONS - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
openNotifications() - Method in interface io.appium.java_client.android.HasNotifications
Opens notification drawer on the device under test.
openNotificationsCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
Deprecated.
OPTIONAL_INTENT_ARGUMENTS_OPTION - Static variable in interface io.appium.java_client.android.options.app.SupportsOptionalIntentArgumentsOption
 
ORB - io.appium.java_client.imagecomparison.FeatureDetector
 
ORIENTATION_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsOrientationOption
 
OTHER_APPS_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsOtherAppsOption
 
overrideServerUrl(URL) - Method in class io.appium.java_client.remote.AppiumCommandExecutor
Override the http client in the HttpCommandExecutor class with a new http client instance with the given URL.
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

P - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'P' key.
PAGE_DOWN - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Page Down key.
PAGE_LOAD_STRATEGY_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsPageLoadStrategyOption
 
PAGE_UP - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Page Up key.
PAIRING - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Pairing key.
parameters - Variable in class io.appium.java_client.TouchAction
Deprecated.
 
parseSessionAddress(URL) - Static method in class io.appium.java_client.internal.SessionHelpers
Parses the address of a running remote session.
PASTE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Paste key.
PasteboardSyncState - Enum in io.appium.java_client.ios.options.simulator
 
perform() - Method in class io.appium.java_client.MultiTouchAction
Deprecated.
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
Deprecated.
Perform this chain of actions on the performsTouchActions.
PERFORM_MULTI_TOUCH - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
PERFORM_TOUCH_ACTION - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
performMultiTouchAction(MultiTouchAction) - Method in interface io.appium.java_client.PerformsTouchActions
Deprecated.
PerformsActions<T extends PerformsActions<T>> - Interface in io.appium.java_client
 
PerformsTouchActions - Interface in io.appium.java_client
Deprecated.
PerformsTouchID - Interface in io.appium.java_client.ios
 
performTouchAction(TouchAction) - Method in interface io.appium.java_client.PerformsTouchActions
Deprecated.
performTouchID(boolean) - Method in interface io.appium.java_client.ios.PerformsTouchID
Simulate touchId event on iOS Simulator.
PERIOD - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '.' key.
Permissions - Class in io.appium.java_client.ios.options.simulator
 
Permissions() - Constructor for class io.appium.java_client.ios.options.simulator.Permissions
 
Permissions(String) - Constructor for class io.appium.java_client.ios.options.simulator.Permissions
 
Permissions(Map<String, Object>) - Constructor for class io.appium.java_client.ios.options.simulator.Permissions
 
PERMISSIONS_OPTION - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsPermissionsOption
 
PHOTO - io.appium.java_client.ios.IOSStartScreenRecordingOptions.VideoQuality
 
PICTSYMBOLS - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Picture Symbols modifier key.
PLAINTEXT - io.appium.java_client.clipboard.ClipboardContentType
 
platform - Variable in class io.appium.java_client.pagefactory.bys.builder.AppiumByBuilder
 
PLATFORM_VERSION_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsPlatformVersionOption
 
PLUS - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '+' key.
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.
point(Point) - 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
 
POOR - io.appium.java_client.android.GsmSignalStrength
 
POST - io.appium.java_client.screenrecording.ScreenRecordingUploadOptions.RequestMethod
 
postC(String) - Static method in class io.appium.java_client.MobileCommand
This methods forms POST commands.
POSTRUN_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsPostrunOption
 
POUND - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '#' key.
POWER - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Power key.
POWER_AC_STATE - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
POWER_CAPACITY - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
powerACCommand(PowerACState) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
Deprecated.
PowerACState - Enum in io.appium.java_client.android
 
powerCapacityCommand(int) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
Deprecated.
PowerShellData - Class in io.appium.java_client.windows.options
 
PowerShellData() - Constructor for class io.appium.java_client.windows.options.PowerShellData
 
PowerShellData(Map<String, Object>) - Constructor for class io.appium.java_client.windows.options.PowerShellData
 
PREDISPATCH - io.appium.java_client.android.nativekey.KeyEventFlag
Signifies that the key is being predispatched.
prepareArguments(String[], Object[]) - Static method in class io.appium.java_client.MobileCommand
Deprecated.
Use Map.of(Object, Object, Object, Object)
prepareArguments(String, Object) - Static method in class io.appium.java_client.MobileCommand
Deprecated.
Use Map.of(Object, Object)
PRERUN_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsPrerunOption
 
press(IOSPressOptions) - Method in class io.appium.java_client.ios.IOSTouchAction
Deprecated.
Press action on the screen.
press(PointOption) - Method in class io.appium.java_client.TouchAction
Deprecated.
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
Deprecated.
PressesKey - Interface in io.appium.java_client.android.nativekey
 
pressKey(KeyEvent) - Method in interface io.appium.java_client.android.nativekey.PressesKey
Send a key event to the device under test.
pressKeyCodeCommand(int) - Static method in class io.appium.java_client.MobileCommand
Deprecated.
This helper is deprecated and will be removed in future versions.
pressKeyCodeCommand(int, Integer) - Static method in class io.appium.java_client.MobileCommand
Deprecated.
This helper is deprecated and will be removed in future versions.
PRINT_PAGE_SOURCE_ON_FIND_FAILURE_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsPrintPageSourceOnFindFailureOption
 
printPageSourceOnFindFailure() - Method in interface io.appium.java_client.remote.options.SupportsPrintPageSourceOnFindFailureOption
Set the app to print page source when a find operation fails.
priority() - Method in annotation type io.appium.java_client.pagefactory.AndroidBy
Priority of the searching.
priority() - Method in annotation type io.appium.java_client.pagefactory.AndroidFindAll
Priority of the searching.
priority() - Method in annotation type io.appium.java_client.pagefactory.AndroidFindBy
Priority of the searching.
priority() - Method in annotation type io.appium.java_client.pagefactory.AndroidFindBys
Priority of the searching.
priority() - Method in annotation type io.appium.java_client.pagefactory.iOSBy
Priority of the searching.
priority() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITBy
Priority of the searching.
priority() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITFindAll
Priority of the searching.
priority() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITFindBy
Priority of the searching.
priority() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITFindBys
Priority of the searching.
PROCESS_ARGUMENTS_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsProcessArgumentsOption
 
ProcessArguments - Class in io.appium.java_client.ios.options.wda
 
ProcessArguments(List<String>) - Constructor for class io.appium.java_client.ios.options.wda.ProcessArguments
 
ProcessArguments(List<String>, Map<String, Object>) - Constructor for class io.appium.java_client.ios.options.wda.ProcessArguments
 
ProcessArguments(Map<String, Object>) - Constructor for class io.appium.java_client.ios.options.wda.ProcessArguments
 
PROG_BLUE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Blue "programmable" key.
PROG_GREEN - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Green "programmable" key.
PROG_RED - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Red "programmable" key.
PROG_YELLOW - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Yellow "programmable" key.
propagateIfNotIgnored(Throwable) - Method in class io.appium.java_client.AppiumFluentWait
 
proxy(Proxy) - Method in class io.appium.java_client.AppiumClientConfig
 
PROXY_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsProxyOption
 
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
Deprecated.
PULL_FOLDER - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
pullFile(String) - Method in interface io.appium.java_client.PullsFiles
Pull a file from the remote system.
pullFolder(String) - Method in interface io.appium.java_client.PullsFiles
Pull a folder content from the remote system.
PullsFiles - Interface in io.appium.java_client
 
PUSH_FILE - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
PushesFiles - Interface in io.appium.java_client
 
pushFile(String, byte[]) - Method in interface io.appium.java_client.PushesFiles
Saves base64-encoded data as a file on the remote system.
pushFile(String, File) - Method in interface io.appium.java_client.PushesFiles
Sends the file to the remote device.
pushFileCommand(String, byte[]) - Static method in class io.appium.java_client.MobileCommand
Deprecated.
This helper is deprecated and will be removed in future versions.
PUT - io.appium.java_client.screenrecording.ScreenRecordingUploadOptions.RequestMethod
 

Q

Q - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'Q' key.
QUERY_APP_STATE - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
queryAppState(String) - Method in interface io.appium.java_client.InteractsWithApps
Queries the state of an application.

R

R - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'R' key.
readTimeout(Duration) - Method in class io.appium.java_client.AppiumClientConfig
 
REBOOT - io.appium.java_client.service.local.flags.AndroidServerFlag
 
RECREATE_CHROME_DRIVER_SESSIONS - Static variable in interface io.appium.java_client.android.options.context.SupportsRecreateChromeDriverSessionsOption
 
recreateChromeDriverSessions() - Method in interface io.appium.java_client.android.options.context.SupportsRecreateChromeDriverSessionsOption
Enforce chromedriver sessions to be killed and then recreated instead of just suspending it on context switch.
REDUCE_MOTION_OPTION - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsReduceMotionOption
 
reduceMotion() - Method in interface io.appium.java_client.ios.options.simulator.SupportsReduceMotionOption
Enforce reduce motion accessibility preference.
ReflectionHelpers - Class in io.appium.java_client.internal
 
refreshAdditionalCommands() - Method in class io.appium.java_client.remote.AppiumCommandExecutor
 
RELAXED_SECURITY - io.appium.java_client.service.local.flags.GeneralServerFlag
Disable additional security checks.
release() - Method in class io.appium.java_client.TouchAction
Deprecated.
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.
REMOTE_ADB_HOST_OPTION - Static variable in interface io.appium.java_client.android.options.adb.SupportsRemoteAdbHostOption
 
REMOTE_APPS_CACHE_LIMIT_OPTION - Static variable in interface io.appium.java_client.android.options.app.SupportsRemoteAppsCacheLimitOption
 
REMOVE_APP - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
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.
removeOutPutStream(OutputStream) - Method in class io.appium.java_client.service.local.AppiumDriverLocalService
Remove the outputStream which is receiving server output data.
REPLACE_VALUE - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
replaceElementValue(RemoteWebElement, String) - Method in interface io.appium.java_client.android.CanReplaceElementValue
Sends a text to the given element by replacing its previous content.
replaceElementValueCommand(RemoteWebElement, String) - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
Deprecated.
RESET - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
RESET_LOCATION_SERVICE_OPTION - Static variable in interface io.appium.java_client.ios.options.general.SupportsResetLocationServiceOption
 
RESET_ON_SESSION_START_ONLY_OPTION - Static variable in interface io.appium.java_client.ios.options.other.SupportsResetOnSessionStartOnlyOption
 
resetLocationService() - Method in interface io.appium.java_client.ios.options.general.SupportsResetLocationServiceOption
Set to reset the location service in the session deletion on real device.
RESULT_BUNDLE_PATH_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsResultBundlePathOption
 
RIGHT_BRACKET - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: ']' key.
RO - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Japanese Ro key.
ROAMING - io.appium.java_client.android.GsmVoiceState
 
rotate(DeviceRotation) - Method in interface io.appium.java_client.remote.SupportsRotation
 
rotate(ScreenOrientation) - Method in interface io.appium.java_client.remote.SupportsRotation
 
rotation() - Method in interface io.appium.java_client.remote.SupportsRotation
Get device rotation.
RUN_APP_IN_BACKGROUND - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
runAppInBackground(Duration) - Method in interface io.appium.java_client.InteractsWithApps
Runs the current app in the background for the time requested.
RUNNING_IN_BACKGROUND - io.appium.java_client.appmanagement.ApplicationState
 
RUNNING_IN_BACKGROUND_SUSPENDED - io.appium.java_client.appmanagement.ApplicationState
 
RUNNING_IN_FOREGROUND - io.appium.java_client.appmanagement.ApplicationState
 

S

S - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'S' key.
SAFARI - io.appium.java_client.service.local.flags.IOSServerFlag
Use the safari app.
SAFARI - Static variable in interface io.appium.java_client.remote.AutomationName
 
SAFARI - Static variable in interface io.appium.java_client.remote.MobileBrowserType
 
SAFARI_ALLOW_POPUPS_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsSafariAllowPopupsOption
 
SAFARI_AUTOMATIC_INSPECTION_OPTION - Static variable in interface io.appium.java_client.safari.options.SupportsSafariAutomaticInspectionOption
 
SAFARI_AUTOMATIC_PROFILING_OPTION - Static variable in interface io.appium.java_client.safari.options.SupportsSafariAutomaticProfilingOption
 
SAFARI_DEVICE_NAME_OPTION - Static variable in interface io.appium.java_client.safari.options.SupportsSafariDeviceNameOption
 
SAFARI_DEVICE_TYPE_OPTION - Static variable in interface io.appium.java_client.safari.options.SupportsSafariDeviceTypeOption
 
SAFARI_DEVICE_UDID_OPTION - Static variable in interface io.appium.java_client.safari.options.SupportsSafariDeviceUdidOption
 
SAFARI_GARBAGE_COLLECT_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsSafariGarbageCollectOption
 
SAFARI_IGNORE_FRAUD_WARNING_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsSafariIgnoreFraudWarningOption
 
SAFARI_IGNORE_WEB_HOSTNAMES_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsSafariIgnoreWebHostnamesOption
 
SAFARI_INITIAL_URL_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsSafariInitialUrlOption
 
SAFARI_LOG_ALL_COMMUNICATION_HEX_DUMP_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsSafariLogAllCommunicationHexDumpOption
 
SAFARI_LOG_ALL_COMMUNICATION_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsSafariLogAllCommunicationOption
 
SAFARI_OPEN_LINKS_IN_BACKGROUND_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsSafariOpenLinksInBackgroundOption
 
SAFARI_PLATFORM_BUILD_VERSION_OPTION - Static variable in interface io.appium.java_client.safari.options.SupportsSafariPlatformBuildVersionOption
 
SAFARI_PLATFORM_VERSION_OPTION - Static variable in interface io.appium.java_client.safari.options.SupportsSafariPlatformVersionOption
 
SAFARI_SOCKET_CHUNK_SIZE_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsSafariSocketChunkSizeOption
 
SAFARI_USE_SIMULATOR_OPTION - Static variable in interface io.appium.java_client.safari.options.SupportsSafariUseSimulatorOption
 
SAFARI_WEB_INSPECTOR_MAX_FRAME_LENGTH_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsSafariWebInspectorMaxFrameLengthOption
 
safariAllowPopups() - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariAllowPopupsOption
Enforces to allow javascript to open popups in Safari.
safariAutomaticInspection() - Method in interface io.appium.java_client.safari.options.SupportsSafariAutomaticInspectionOption
Enforces safaridriver to use Automatic Inspection.
safariAutomaticProfiling() - Method in interface io.appium.java_client.safari.options.SupportsSafariAutomaticProfilingOption
Enforces safaridriver to use Automatic Inspection.
SafariDriver - Class in io.appium.java_client.safari
GeckoDriver is an officially supported Appium driver created to automate mobile Safari browser.
SafariDriver(AppiumClientConfig, Capabilities) - Constructor for class io.appium.java_client.safari.SafariDriver
Creates a new instance based on the given ClientConfig and capabilities.
SafariDriver(AppiumDriverLocalService, Capabilities) - Constructor for class io.appium.java_client.safari.SafariDriver
 
SafariDriver(AppiumDriverLocalService, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.safari.SafariDriver
 
SafariDriver(AppiumServiceBuilder, Capabilities) - Constructor for class io.appium.java_client.safari.SafariDriver
 
SafariDriver(AppiumServiceBuilder, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.safari.SafariDriver
 
SafariDriver(URL) - Constructor for class io.appium.java_client.safari.SafariDriver
This is a special constructor used to connect to a running driver instance.
SafariDriver(URL, Capabilities) - Constructor for class io.appium.java_client.safari.SafariDriver
 
SafariDriver(URL, HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.safari.SafariDriver
 
SafariDriver(Capabilities) - Constructor for class io.appium.java_client.safari.SafariDriver
 
SafariDriver(ClientConfig, Capabilities) - Constructor for class io.appium.java_client.safari.SafariDriver
Creates a new instance based on the given ClientConfig and capabilities.
SafariDriver(HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.safari.SafariDriver
 
SafariDriver(HttpCommandExecutor, Capabilities) - Constructor for class io.appium.java_client.safari.SafariDriver
 
safariGarbageCollect() - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariGarbageCollectOption
Enforces to turn on garbage collection when executing scripts on Safari.
safariIgnoreFraudWarning() - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariIgnoreFraudWarningOption
Enforces to prevent Safari from showing a fraudulent website warning.
safariLogAllCommunication() - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariLogAllCommunicationOption
Enforces logging of plists sent to and received from the Web Inspector.
safariLogAllCommunicationHexDump() - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariLogAllCommunicationHexDumpOption
Enforces logging of plists sent to and received from the Web Inspector in hex dump format.
safariOpenLinksInBackground() - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariOpenLinksInBackgroundOption
Enforces Safari to open links in new windows.
SafariOptions - Class in io.appium.java_client.safari.options
https://github.com/appium/appium-safari-driver#usage
SafariOptions() - Constructor for class io.appium.java_client.safari.options.SafariOptions
 
SafariOptions(Map<String, ?>) - Constructor for class io.appium.java_client.safari.options.SafariOptions
 
SafariOptions(Capabilities) - Constructor for class io.appium.java_client.safari.options.SafariOptions
 
safariUseSimulator() - Method in interface io.appium.java_client.safari.options.SupportsSafariUseSimulatorOption
Enforces safaridriver to use iOS Simulator.
save(Path) - Method in class io.appium.java_client.serverevents.ServerEvents
 
SCALE_FACTOR_OPTION - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsScaleFactorOption
 
score(Capabilities) - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
Provides a measure of how strongly this DriverService supports the given capabilities.
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_QUALITY - io.appium.java_client.Setting
 
SCREENSHOT_QUALITY_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsScreenshotQualityOption
 
ScreenshotState - Class in io.appium.java_client
 
ScreenshotState(ComparesImages) - Constructor for class io.appium.java_client.ScreenshotState
 
ScreenshotState(ComparesImages, Supplier<BufferedImage>) - Constructor for class io.appium.java_client.ScreenshotState
The class constructor accepts two arguments.
ScreenshotState.ScreenshotComparisonError - Exception in io.appium.java_client
 
ScreenshotState.ScreenshotComparisonTimeout - Exception in io.appium.java_client
 
ScriptOptions - Class in io.appium.java_client.driverscripts
 
ScriptOptions() - Constructor for class io.appium.java_client.driverscripts.ScriptOptions
 
ScriptType - Enum in io.appium.java_client.driverscripts
 
ScriptValue - Class in io.appium.java_client.driverscripts
 
ScriptValue(Object, Map<String, Object>) - Constructor for class io.appium.java_client.driverscripts.ScriptValue
 
SCROLL_LOCK - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Scroll Lock key.
SCROLL_LOCK_ON - io.appium.java_client.android.nativekey.KeyEventMetaModifier
This mask is used to check whether the SCROLL LOCK meta key is on.
SCSD - io.appium.java_client.android.NetworkSpeed
 
SEARCH - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Search key.
SEARCHING - io.appium.java_client.android.GsmVoiceState
 
SELECTING - io.appium.java_client.android.nativekey.KeyEventMetaModifier
Text is in selection mode.
SEMICOLON - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: ';' key.
SEND_SMS - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
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
Deprecated.
SERVER_STARTUP_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.mac.options.SupportsServerStartupTimeoutOption
 
ServerArgument - Interface in io.appium.java_client.service.local.flags
 
ServerEvents - Class in io.appium.java_client.serverevents
 
ServerEvents() - Constructor for class io.appium.java_client.serverevents.ServerEvents
 
SESSION_OVERRIDE - io.appium.java_client.service.local.flags.GeneralServerFlag
Enables session override (clobbering).
SessionAddress() - Constructor for class io.appium.java_client.internal.SessionHelpers.SessionAddress
 
SessionHelpers - Class in io.appium.java_client.internal
 
SessionHelpers.SessionAddress - Class in io.appium.java_client.internal
 
SET_CLIPBOARD - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
SET_LOCATION - Static variable in class io.appium.java_client.MobileCommand
 
SET_NETWORK_CONNECTION - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
SET_SCREEN_ORIENTATION - Static variable in class io.appium.java_client.MobileCommand
 
SET_SCREEN_ROTATION - Static variable in class io.appium.java_client.MobileCommand
 
SET_SETTINGS - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
SET_VALUE - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
SET_WINDOW_RECT_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsSetWindowRectOption
 
setAbsoluteWebLocations(boolean) - Method in interface io.appium.java_client.ios.options.webview.SupportsAbsoluteWebLocationsOption
This capability will direct the Get Element Location command, when used within webviews, to return coordinates which are relative to the origin of the page, rather than relative to the current scroll offset.
setAcceptInsecureCerts(boolean) - Method in interface io.appium.java_client.remote.options.SupportsAcceptInsecureCertsOption
Set whether untrusted and self-signed TLS certificates are implicitly trusted on navigation for the duration of the session.
setActivityOptions(ActivityOptions) - Method in interface io.appium.java_client.android.options.app.SupportsActivityOptionsOption
The mapping of custom options for the main app activity that is going to be started.
setAdbExecTimeout(Duration) - Method in interface io.appium.java_client.android.options.adb.SupportsAdbExecTimeoutOption
Maximum time to wait until single ADB command is executed.
setAdbPort(int) - Method in interface io.appium.java_client.android.options.adb.SupportsAdbPortOption
Set number of the port where ADB is running.
setAdditionalWebviewBundleIds(List<String>) - Method in interface io.appium.java_client.ios.options.webview.SupportsAdditionalWebviewBundleIdsOption
Array of possible bundle identifiers for webviews.
setAllowDelayAdb(boolean) - Method in interface io.appium.java_client.android.options.adb.SupportsAllowDelayAdbOption
Being set to false prevents emulator to use -delay-adb feature to detect its startup.
setAllowProvisioningDeviceRegistration(boolean) - Method in interface io.appium.java_client.ios.options.wda.SupportsAllowProvisioningDeviceRegistrationOption
Allow xcodebuild to register your destination device on the developer portal if necessary.
setAllowTestPackages(boolean) - Method in interface io.appium.java_client.android.options.app.SupportsAllowTestPackagesOption
If set to true then it would be possible to use packages built with the test flag for the automated testing (literally adds -t flag to the adb install command).
setAndroidInstallTimeout(Duration) - Method in interface io.appium.java_client.android.options.app.SupportsAndroidInstallTimeoutOption
Maximum amount of time to wait until the application under test is installed.
setAndroidStorage(String) - Method in interface io.appium.java_client.gecko.options.SupportsAndroidStorageOption
See https://firefox-source-docs.mozilla.org/testing/geckodriver /Flags.html#code-android-storage-var-android-storage-var-code
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.
setApp(String) - Method in interface io.appium.java_client.remote.options.SupportsAppOption
Set the absolute local path for the location of the App.
setApp(URL) - Method in interface io.appium.java_client.remote.options.SupportsAppOption
Set the remote http URL for the location of the App.
setAppActivity(String) - Method in interface io.appium.java_client.android.options.app.SupportsAppActivityOption
Main application activity identifier.
setAppArguments() - Method in interface io.appium.java_client.windows.options.SupportsAppArgumentsOption
Get application arguments.
setAppArguments(String) - Method in interface io.appium.java_client.windows.options.SupportsAppArgumentsOption
Application arguments string.
setAppInstallStrategy(String) - Method in interface io.appium.java_client.ios.options.app.SupportsAppInstallStrategyOption
Select application installation strategy for real devices.
setAppLocale(AppLocale) - Method in interface io.appium.java_client.android.options.localization.SupportsAppLocaleOption
Sets the locale for the app under test.
setAppPackage(String) - Method in interface io.appium.java_client.android.options.app.SupportsAppPackageOption
Application package identifier to be started.
setAppPushTimeout(Duration) - Method in interface io.appium.java_client.ios.options.app.SupportsAppPushTimeoutOption
The timeout for application upload.
setAppTopLevelWindow(String) - Method in interface io.appium.java_client.windows.options.SupportsAppTopLevelWindowOption
Set the hexadecimal handle of an existing application top level window to attach to, for example 0x12345 (should be of string type).
setAppWaitActivity(String) - Method in interface io.appium.java_client.android.options.app.SupportsAppWaitActivityOption
Identifier of the activity that the driver should wait for (not necessarily the main one).
setAppWaitDuration(Duration) - Method in interface io.appium.java_client.android.options.app.SupportsAppWaitDurationOption
Maximum amount of time to wait until the application under test is started (e.g.
setAppWaitForLaunch(boolean) - Method in interface io.appium.java_client.android.options.app.SupportsAppWaitForLaunchOption
Whether to block until the app under test returns the control to the caller after its activity has been started by Activity Manager (true, the default value) or to continue the test without waiting for that (false).
setAppWaitPackage(String) - Method in interface io.appium.java_client.android.options.app.SupportsAppWaitPackageOption
Identifier of the package that the driver should wait for (not necessarily the main one).
setAppWorkingDir(String) - Method in interface io.appium.java_client.windows.options.SupportsAppWorkingDirOption
Full path to the folder, which is going to be set as the working dir for the application under test.
setArguments(List<String>) - Method in interface io.appium.java_client.mac.options.SupportsArgumentsOption
Array of application command line arguments.
setAutoAcceptAlerts(boolean) - Method in interface io.appium.java_client.ios.options.wda.SupportsAutoAcceptAlertsOption
Accept all iOS alerts automatically if they pop up.
setAutoDismissAlerts(boolean) - Method in interface io.appium.java_client.ios.options.wda.SupportsAutoDismissAlertsOption
Dismiss all iOS alerts automatically if they pop up.
setAutodownloadEnabled(boolean) - Method in interface io.appium.java_client.chromium.options.SupportsAutodownloadOption
Set to false for disabling automatic downloading of Chrome drivers.
setAutoGrantPermissions(boolean) - Method in interface io.appium.java_client.android.options.app.SupportsAutoGrantPermissionsOption
Whether to grant all the requested application permissions automatically when a test starts(true).
setAutomationName(String) - Method in interface io.appium.java_client.remote.options.SupportsAutomationNameOption
Set the automation driver to use.
setAutoWebview(boolean) - Method in interface io.appium.java_client.remote.options.SupportsAutoWebViewOption
Set whether the app moves directly into Webview context.
setAutoWebviewTimeout(Duration) - Method in interface io.appium.java_client.android.options.context.SupportsAutoWebviewTimeoutOption
Set the maximum timeout to wait until a web view is available if autoWebview capability is set to true.
setAvd(String) - Method in interface io.appium.java_client.android.options.avd.SupportsAvdOption
The name of Android emulator to run the test on.
setAvdArgs(String) - Method in interface io.appium.java_client.android.options.avd.SupportsAvdArgsOption
Set emulator command line arguments.
setAvdArgs(List<String>) - Method in interface io.appium.java_client.android.options.avd.SupportsAvdArgsOption
Set emulator command line arguments.
setAvdEnv(Map<String, Object>) - Method in interface io.appium.java_client.android.options.avd.SupportsAvdEnvOption
Set the mapping of emulator environment variables.
setAvdLaunchTimeout(Duration) - Method in interface io.appium.java_client.android.options.avd.SupportsAvdLaunchTimeoutOption
Maximum timeout to wait until Android Emulator is started.
setAvdReadyTimeout(Duration) - Method in interface io.appium.java_client.android.options.avd.SupportsAvdReadyTimeoutOption
Maximum timeout to wait until Android Emulator is fully booted and is ready for usage.
setBootstrapRoot(String) - Method in interface io.appium.java_client.mac.options.SupportsBootstrapRootOption
The full path to WebDriverAgentMac root folder where Xcode project of the server sources lives.
setBrowserVersion(String) - Method in interface io.appium.java_client.remote.options.SupportsBrowserVersionOption
Provide the version number of the browser to automate if there are multiple versions installed on the same machine where the driver is running.
setBuildCheckDisabled(boolean) - Method in interface io.appium.java_client.chromium.options.SupportsBuildCheckOption
Set to true to add the --disable-build-check flag when starting WebDriver.
setBuildToolsVersion(String) - Method in interface io.appium.java_client.android.options.adb.SupportsBuildToolsVersionOption
The version of Android build tools to use.
setBundleId(String) - Method in interface io.appium.java_client.ios.options.app.SupportsBundleIdOption
Bundle identifier of the app under test, for example com.mycompany.myapp.
setBundleId(String) - Method in interface io.appium.java_client.mac.options.SupportsBundleIdOption
The bundle identifier of the application to automate, for example com.apple.TextEdit.
setCalendarAccessAuthorized(boolean) - Method in interface io.appium.java_client.ios.options.simulator.SupportsCalendarAccessAuthorizedOption
Set this to true if you want to enable calendar access on IOS Simulator with given bundleId.
setCalendarFormat(String) - Method in interface io.appium.java_client.ios.options.simulator.SupportsCalendarFormatOption
Set calendar format for the iOS Simulator.
setCapability(String, Object) - Method in class io.appium.java_client.remote.options.BaseOptions
 
setCapability(String, Object) - Method in interface io.appium.java_client.remote.options.CanSetCapability
 
setChromedriverArgs(List<String>) - Method in interface io.appium.java_client.android.options.context.SupportsChromedriverArgsOption
Array of chromedriver [command line arguments](http://www.assertselenium.com/java/list-of-chrome-driver-command-line-arguments/).
setChromedriverChromeMappingFile(String) - Method in interface io.appium.java_client.android.options.context.SupportsChromedriverChromeMappingFileOption
Full path to the chromedrivers mapping file.
setChromedriverDisableBuildCheck(boolean) - Method in interface io.appium.java_client.android.options.context.SupportsChromedriverDisableBuildCheckOption
Being set to true disables the compatibility validation between the current chromedriver and the destination browser/web view.
setChromedriverExecutable(String) - Method in interface io.appium.java_client.android.options.context.SupportsChromedriverExecutableOption
Full path to the chromedriver executable on the server file system.
setChromedriverExecutableDir(String) - Method in interface io.appium.java_client.android.options.context.SupportsChromedriverExecutableDirOption
Full path to the folder where chromedriver executables are located.
setChromedriverPort(int) - Method in interface io.appium.java_client.android.options.context.SupportsChromedriverPortOption
The port number to use for Chromedriver communication.
setChromeDriverPort(int) - Method in interface io.appium.java_client.chromium.options.SupportsChromeDrivePortOption
The port to start WebDriver processes on.
setChromedriverPorts(List<Integer>) - Method in interface io.appium.java_client.android.options.context.SupportsChromedriverPortsOption
Array of possible port numbers to assign for Chromedriver communication.
setChromedriverUseSystemExecutable(boolean) - Method in interface io.appium.java_client.android.options.context.SupportsChromedriverUseSystemExecutableOption
Set it to true in order to enforce the usage of chromedriver, which gets downloaded by Appium automatically upon installation.
setChromeLoggingPrefs(Map<String, Object>) - Method in interface io.appium.java_client.android.options.context.SupportsChromeLoggingPrefsOption
Chrome logging preferences mapping.
setChromeOptions(Map<String, Object>) - Method in interface io.appium.java_client.android.options.context.SupportsChromeOptionsOption
A mapping, that allows to customize chromedriver options.
setClearDeviceLogsOnStart(boolean) - Method in interface io.appium.java_client.android.options.adb.SupportsClearDeviceLogsOnStartOption
If set to true then UiAutomator2 deletes all the existing logs in the device buffer before starting a new test.
setClearSystemFiles(boolean) - Method in interface io.appium.java_client.remote.options.SupportsClearSystemFilesOption
Set whether the app deletes generated files at the end of a session.
setClipboard(ClipboardContentType, byte[]) - Method in interface io.appium.java_client.clipboard.HasClipboard
Set the content of device's clipboard.
setClipboard(String, ClipboardContentType, byte[]) - Method in interface io.appium.java_client.android.HasAndroidClipboard
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) - Method in interface io.appium.java_client.clipboard.HasClipboard
Set the clipboard text.
setClipboardText(String, String) - Method in interface io.appium.java_client.android.HasAndroidClipboard
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
 
setCommandTimeouts(CommandTimeouts) - Method in interface io.appium.java_client.ios.options.other.SupportsCommandTimeoutsOption
Custom timeout(s) in milliseconds for WDA backend commands execution.
setCommandTimeouts(Duration) - Method in interface io.appium.java_client.ios.options.other.SupportsCommandTimeoutsOption
Custom timeout for all WDA backend commands execution.
setConnectHardwareKeyboard(boolean) - Method in interface io.appium.java_client.ios.options.simulator.SupportsConnectHardwareKeyboardOption
Set this option to true in order to enable hardware keyboard in Simulator.
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
Deprecated.
setCreateSessionTimeout(Duration) - Method in interface io.appium.java_client.windows.options.SupportsCreateSessionTimeoutOption
Set the timeout used to retry Appium Windows Driver session startup.
setCustomSSLCert(String) - Method in interface io.appium.java_client.ios.options.simulator.SupportsCustomSslCertOption
Adds a root SSL certificate to IOS Simulator.
setDerivedDataPath(String) - Method in interface io.appium.java_client.ios.options.wda.SupportsDerivedDataPathOption
Use along with usePrebuiltWDA capability and choose where to search for the existing WDA app.
setDeviceName(String) - Method in interface io.appium.java_client.remote.options.SupportsDeviceNameOption
Set the name of the device.
setDisableAutomaticScreenshots(boolean) - Method in interface io.appium.java_client.ios.options.wda.SupportsDisableAutomaticScreenshotsOption
Disable automatic screenshots taken by XCTest at every interaction.
setDisableSuppressAccessibilityService(boolean) - Method in interface io.appium.java_client.android.options.other.SupportsDisableSuppressAccessibilityServiceOption
Being set to true tells the instrumentation process to not suppress accessibility services during the automated test.
setDisableWindowAnimation(boolean) - Method in interface io.appium.java_client.android.options.server.SupportsDisableWindowAnimationOption
Set whether to disable window animations when starting the instrumentation process.
setElementResponseAttributes(String) - Method in interface io.appium.java_client.android.HasAndroidSettings
Which attributes should be returned if compact responses are disabled.
setElementResponseAttributes(String) - Method in interface io.appium.java_client.ios.HasIOSSettings
Which attributes should be returned if compact responses are disabled.
setEnableAsyncExecuteFromHttps(boolean) - Method in interface io.appium.java_client.ios.options.webview.SupportsEnableAsyncExecuteFromHttpsOption
Capability to allow simulators to execute asynchronous JavaScript on pages using HTTPS.
setEnablePerformanceLogging(boolean) - Method in interface io.appium.java_client.remote.options.SupportsEnablePerformanceLoggingOption
Set whether the app logs performance.
setEnforceAppInstall(boolean) - Method in interface io.appium.java_client.remote.options.SupportsEnforceAppInstallOption
Allows setting whether the application under test is always reinstalled even if a newer version of it already exists on the device under test.
setEnforceFreshSimulatorCreation(boolean) - Method in interface io.appium.java_client.ios.options.simulator.SupportsEnforceFreshSimulatorCreationOption
Creates a new simulator in session creation and deletes it in session deletion.
setEnsureWebviewsHavePages(boolean) - Method in interface io.appium.java_client.android.options.context.SupportsEnsureWebviewsHavePagesOption
Whether to skip web views that have no pages from being shown in getContexts output.
setEnvironment(Map<String, String>) - Method in interface io.appium.java_client.mac.options.SupportsEnvironmentOption
A dictionary of environment variables (name->value) that are going to be passed to the application under test on top of environment variables inherited from the parent process.
setEspressoBuildConfig(EspressoBuildConfig) - Method in interface io.appium.java_client.android.options.server.SupportsEspressoBuildConfigOption
This config allows to customize several important properties of Espresso server.
setEspressoBuildConfig(String) - Method in interface io.appium.java_client.android.options.server.SupportsEspressoBuildConfigOption
This config allows to customize several important properties of Espresso server.
setEventTimings(boolean) - Method in interface io.appium.java_client.remote.options.SupportsEventTimingsOption
Set whether the app reports the timings for various Appium-internal events.
setExecutable(String) - Method in interface io.appium.java_client.chromium.options.SupportsExecutableOption
The absolute path to a WebDriver binary executable.
setExecutableDir(String) - Method in interface io.appium.java_client.chromium.options.SupportsExecutableDirOption
A directory within which is found any number of WebDriver binaries.
setExperimentalWebDriver(boolean) - Method in interface io.appium.java_client.windows.options.SupportsMsExperimentalWebDriverOption
Enables experimental features and optimizations.
setExtractChromeAndroidPackageFromContextName(boolean) - Method in interface io.appium.java_client.android.options.context.SupportsExtractChromeAndroidPackageFromContextNameOption
If set to true, tell chromedriver to attach to the android package we have associated with the context name, rather than the package of the application under test.
setForceAppLaunch(boolean) - Method in interface io.appium.java_client.ios.options.wda.SupportsForceAppLaunchOption
Specify if the app should be forcefully restarted if it is already running on session startup.
setForceEspressoRebuild(boolean) - Method in interface io.appium.java_client.android.options.server.SupportsForceEspressoRebuildOption
Whether to always enforce Espresso server rebuild (true).
setForceSimulatorSoftwareKeyboardPresence(boolean) - Method in interface io.appium.java_client.ios.options.simulator.SupportsForceSimulatorSoftwareKeyboardPresenceOption
Set this option to true in order to turn software keyboard on and turn hardware keyboard off in Simulator since Appium 1.22.0.
setFullContextList(boolean) - Method in interface io.appium.java_client.ios.options.webview.SupportsFullContextListOption
Sets to return the detailed information on contexts for the get available context command.
setFullReset(boolean) - Method in interface io.appium.java_client.remote.options.SupportsFullResetOption
Set whether the app does a full reset.
setGpsEnabled(boolean) - Method in interface io.appium.java_client.android.options.avd.SupportsGpsEnabledOption
Sets whether to enable (true) or disable (false) GPS service in the Emulator.
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.
setIgnoreHiddenApiPolicyError(boolean) - Method in interface io.appium.java_client.android.options.adb.SupportsIgnoreHiddenApiPolicyErrorOption
Being set to true ignores a failure while changing hidden API access policies.
setIncludeDeviceCapsToSessionInfo(boolean) - Method in interface io.appium.java_client.ios.options.general.SupportsIncludeDeviceCapsToSessionInfoOption
Whether to include screen information as the result of Get Session Capabilities.
setIncludeSafariInWebviews(boolean) - Method in interface io.appium.java_client.ios.options.webview.SupportsIncludeSafariInWebviewsOption
Add Safari web contexts to the list of contexts available during a native/webview app test.
setIntentAction(String) - Method in interface io.appium.java_client.android.options.app.SupportsIntentActionOption
Set an optional intent action to be applied when starting the given appActivity by Activity Manager.
setIntentCategory(String) - Method in interface io.appium.java_client.android.options.app.SupportsIntentCategoryOption
Set an optional intent category to be applied when starting the given appActivity by Activity Manager.
setIntentFlags(String) - Method in interface io.appium.java_client.android.options.app.SupportsIntentFlagsOption
Set an optional intent flags to be applied when starting the given appActivity by Activity Manager.
setIntentOptions(IntentOptions) - Method in interface io.appium.java_client.android.options.app.SupportsIntentOptionsOption
The mapping of custom options for the intent that is going to be passed to the main app activity.
setIosSimulatorLogsPredicate(String) - Method in interface io.appium.java_client.ios.options.simulator.SupportsIosSimulatorLogsPredicateOption
Set the --predicate flag in the ios simulator logs.
setIsHeadless(boolean) - Method in interface io.appium.java_client.remote.options.SupportsIsHeadlessOption
If set to true then emulator/simulator starts in headless mode (e.g.
setKeepKeyChains(boolean) - Method in interface io.appium.java_client.ios.options.simulator.SupportsKeepKeyChainsOption
Set the capability to true in order to preserve Simulator keychains folder after full reset.
setKeyboardAutocorrection(boolean) - Method in interface io.appium.java_client.ios.HasIOSSettings
Changes the 'Auto-Correction' preference in Keyboards setting.
setKeyboardPrediction(boolean) - Method in interface io.appium.java_client.ios.HasIOSSettings
Changes the 'Predictive' preference in Keyboards setting.
setKeychain(Keychain) - Method in interface io.appium.java_client.ios.options.wda.SupportsKeychainOptions
Provides details to access custom keychain, which contains the private development key exported from the system keychain.
setKeychainsExcludePatterns(String) - Method in interface io.appium.java_client.ios.options.simulator.SupportsKeychainsExcludePatternsOption
This capability accepts comma-separated path patterns, which are going to be excluded from keychains restore while full reset is being performed on Simulator.
setKeystoreConfig(KeystoreConfig) - Method in interface io.appium.java_client.android.options.signing.SupportsKeystoreOptions
Use a custom keystore to sign the app under test.
setLanguage(String) - Method in interface io.appium.java_client.remote.options.SupportsLanguageOption
Set language abbreviation for use in session.
setLaunchWithIdb(boolean) - Method in interface io.appium.java_client.ios.options.other.SupportsLaunchWithIdbOption
Launch WebDriverAgentRunner with idb instead of xcodebuild.
setLocale(String) - Method in interface io.appium.java_client.remote.options.SupportsLocaleOption
Set locale abbreviation for use in session.
setLocaleScript(String) - Method in interface io.appium.java_client.android.options.localization.SupportsLocaleScriptOption
Set canonical name of the locale to be set for the app under test, for example zh-Hans-CN.
setLocalizableStringsDir(String) - Method in interface io.appium.java_client.ios.options.app.SupportsLocalizableStringsDirOption
Where to look for localizable strings in the application bundle.
setLocation(AndroidGeoLocation) - Method in interface io.appium.java_client.android.geolocation.SupportsExtendedGeolocationCommands
Allows to set geo location with extended parameters available for Android platform.
setLocation(Location) - Method in interface io.appium.java_client.remote.SupportsLocation
Sets the current device's geolocation coordinates.
setLocation(Location) - Method in interface io.appium.java_client.remote.SupportsLocation
Deprecated, for removal: This API element is subject to removal in a future version.
This method and whole LocationContext interface are deprecated, use SupportsLocation.setLocation(io.appium.java_client.Location) instead.
setLogcatFilterSpecs(String) - Method in interface io.appium.java_client.android.options.adb.SupportsLogcatFilterSpecsOption
Series of tag[:priority] where tag is a log component tag (or * for all) and priority is: V Verbose, D Debug, I Info, W Warn, E Error, F Fatal, S Silent (supress all output).
setLogcatFormat(String) - Method in interface io.appium.java_client.android.options.adb.SupportsLogcatFormatOption
The log print format, where format is one of: brief process tag thread raw time threadtime long.
setLogPath(String) - Method in interface io.appium.java_client.chromium.options.SupportsLogPathOption
If set, the path to use with the --log-path parameter directing WebDriver to write its log to that path.
setMarionettePort(int) - Method in interface io.appium.java_client.gecko.options.SupportsMarionettePortOption
Selects the port for Geckodriver’s connection to the Marionette remote protocol.
setMaxTypingFrequency(int) - Method in interface io.appium.java_client.ios.options.wda.SupportsMaxTypingFrequencyOption
Maximum frequency of keystrokes for typing and clear.
setMethodCallListeners(MethodCallListener[]) - Method in interface io.appium.java_client.proxy.HasMethodCallListeners
The setter is dynamically created by ByteBuddy to store method call listeners on the instrumented proxy instance.
setMjpegScalingFactor(int) - Method in interface io.appium.java_client.ios.HasIOSSettings
The scale of screenshots in range 1..100.
setMjpegScreenshotUrl(String) - Method in interface io.appium.java_client.android.options.mjpeg.SupportsMjpegScreenshotUrlOption
The URL of a service that provides realtime device screenshots in MJPEG format.
setMjpegScreenshotUrl(URL) - Method in interface io.appium.java_client.android.options.mjpeg.SupportsMjpegScreenshotUrlOption
The URL of a service that provides realtime device screenshots in MJPEG format.
setMjpegServerFramerate(int) - Method in interface io.appium.java_client.ios.HasIOSSettings
The frame rate at which the background screenshots broadcaster should broadcast screenshots in range 1..60.
setMjpegServerPort(int) - Method in interface io.appium.java_client.android.options.mjpeg.SupportsMjpegServerPortOption
The number of the port UiAutomator2 server starts the MJPEG server on.
setMjpegServerPort(int) - Method in interface io.appium.java_client.ios.options.wda.SupportsMjpegServerPortOption
The port number on which WDA broadcasts screenshots stream encoded into MJPEG format from the device under test.
setMjpegServerScreenshotQuality(int) - Method in interface io.appium.java_client.ios.HasIOSSettings
The quality of the screenshots generated by the screenshots broadcaster, The value of 0 represents the maximum compression (or lowest quality) while the value of 100 represents the least compression (or best quality).
setMockLocationApp(String) - Method in interface io.appium.java_client.android.options.adb.SupportsMockLocationAppOption
Sets the package identifier of the app, which is used as a system mock location provider since Appium 1.18.0+.
setMozFirefoxOptions(Map<String, Object>) - Method in interface io.appium.java_client.gecko.options.SupportsMozFirefoxOptionsOption
See https://developer.mozilla.org/en-US/docs/Web/WebDriver/Capabilities/firefoxOptions.
setNativeWebScreenshot(boolean) - Method in interface io.appium.java_client.android.options.context.SupportsNativeWebScreenshotOption
Whether to use screenshoting endpoint provided by UiAutomator framework (true) rather than the one provided by chromedriver (false, the default value).
setNativeWebTap(boolean) - Method in interface io.appium.java_client.ios.options.webview.SupportsNativeWebTapOption
Enable native, non-javascript-based taps being in web context mode.
setNativeWebTapStrict(boolean) - Method in interface io.appium.java_client.ios.options.webview.SupportsNativeWebTapStrictOption
Configure native taps to be done by XCUITest driver rather than WebDriverAgent.
setNetworkSpeed(NetworkSpeed) - Method in interface io.appium.java_client.android.SupportsSpecialEmulatorCommands
Emulate network speed change event on the connected emulator.
setNetworkSpeed(String) - Method in interface io.appium.java_client.android.options.avd.SupportsNetworkSpeedOption
Sets the desired network speed limit for the emulator.
setNewCommandTimeout(Duration) - Method in interface io.appium.java_client.remote.options.SupportsNewCommandTimeoutOption
Set the timeout for new commands.
setNoReset(boolean) - Method in interface io.appium.java_client.remote.options.SupportsNoResetOption
Set whether the app does not do a reset.
setNoSign(boolean) - Method in interface io.appium.java_client.android.options.signing.SupportsNoSignOption
Set it to true in order to skip application signing.
setOptionalIntentArguments(String) - Method in interface io.appium.java_client.android.options.app.SupportsOptionalIntentArgumentsOption
Set an optional intent arguments to be applied when starting the given appActivity by Activity Manager.
setOrientation(ScreenOrientation) - Method in interface io.appium.java_client.remote.options.SupportsOrientationOption
Set the orientation of the screen.
setOtherApps(String) - Method in interface io.appium.java_client.remote.options.SupportsOtherAppsOption
Set the location of the app(s) to install before running a test.
setPageLoadStrategy(PageLoadStrategy) - Method in interface io.appium.java_client.remote.options.SupportsPageLoadStrategyOption
Defines the current session’s page load strategy.
setPermissions(Permissions) - Method in interface io.appium.java_client.ios.options.simulator.SupportsPermissionsOption
Allows setting of permissions for the specified application bundle on Simulator only.
setPlatformName(String) - Method in class io.appium.java_client.remote.options.BaseOptions
Set the kind of mobile device or emulator to use.
setPlatformVersion(String) - Method in interface io.appium.java_client.remote.options.SupportsPlatformVersionOption
Set the version of the platform.
setPostrun(AppleScriptData) - Method in class io.appium.java_client.mac.options.Mac2Options
An object containing either script or command key.
setPostrun(PowerShellData) - Method in class io.appium.java_client.windows.options.WindowsOptions
An object containing either script or command key.
setPostrun(S) - Method in interface io.appium.java_client.remote.options.SupportsPostrunOption
 
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.
setPrerun(AppleScriptData) - Method in class io.appium.java_client.mac.options.Mac2Options
An object containing either script or command key.
setPrerun(PowerShellData) - Method in class io.appium.java_client.windows.options.WindowsOptions
An object containing either script or command key.
setPrerun(S) - Method in interface io.appium.java_client.remote.options.SupportsPrerunOption
 
setPrintPageSourceOnFindFailure(boolean) - Method in interface io.appium.java_client.remote.options.SupportsPrintPageSourceOnFindFailureOption
Set whether the app to print page source when a find operation fails.
setPrivateFieldValue(Class<?>, T, String, Object) - Static method in class io.appium.java_client.internal.ReflectionHelpers
Sets the given value to a private instance field.
setPrivateFieldValue(Class<? extends CommandExecutor>, String, Object) - Method in class io.appium.java_client.remote.AppiumCommandExecutor
 
setProcessArguments(ProcessArguments) - Method in interface io.appium.java_client.ios.options.wda.SupportsProcessArgumentsOption
Provides process arguments and environment which will be sent to the WebDriverAgent server.
setProxy(Proxy) - Method in interface io.appium.java_client.remote.options.SupportsProxyOption
Defines the current session’s proxy configuration.
setRecreateChromeDriverSessions(boolean) - Method in interface io.appium.java_client.android.options.context.SupportsRecreateChromeDriverSessionsOption
If this capability is set to true then chromedriver session is always going to be killed and then recreated instead of just suspending it on context switching.
setReduceMotion(boolean) - Method in interface io.appium.java_client.ios.options.simulator.SupportsReduceMotionOption
It allows to turn on/off reduce motion accessibility preference.
setRemoteAdbHost(String) - Method in interface io.appium.java_client.android.options.adb.SupportsRemoteAdbHostOption
Address of the host where ADB is running (the value of -H ADB command line option).
setRemoteAppsCacheLimit(int) - Method in interface io.appium.java_client.android.options.app.SupportsRemoteAppsCacheLimitOption
Sets the maximum amount of application packages to be cached on the device under test.
setResetLocationService(boolean) - Method in interface io.appium.java_client.ios.options.general.SupportsResetLocationServiceOption
Whether reset the location service in the session deletion on real device.
setResetOnSessionStartOnly(boolean) - Method in interface io.appium.java_client.ios.options.other.SupportsResetOnSessionStartOnlyOption
Whether to perform reset on test session finish (false) or not (true).
setResponseCodec(ResponseCodec<HttpResponse>) - Method in class io.appium.java_client.remote.AppiumCommandExecutor
 
setResultBundlePath(String) - Method in interface io.appium.java_client.ios.options.wda.SupportsResultBundlePathOption
Specify the path to the result bundle path as xcodebuild argument for WebDriverAgent build under a security flag.
setSafariAllowPopups(boolean) - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariAllowPopupsOption
Allow javascript to open new windows in Safari.
setSafariAutomaticInspection(boolean) - Method in interface io.appium.java_client.safari.options.SupportsSafariAutomaticInspectionOption
This capability instructs Safari to preload the Web Inspector and JavaScript debugger in the background prior to returning a newly-created window.
setSafariAutomaticProfiling(boolean) - Method in interface io.appium.java_client.safari.options.SupportsSafariAutomaticProfilingOption
This capability instructs Safari to preload the Web Inspector and start a Timeline recording in the background prior to returning a newly-created window.
setSafariDeviceName(String) - Method in interface io.appium.java_client.safari.options.SupportsSafariDeviceNameOption
safaridriver will only create a session using hosts whose device name matches the value of safari:deviceName.
setSafariDeviceType(String) - Method in interface io.appium.java_client.safari.options.SupportsSafariDeviceTypeOption
If the value of safari:deviceType is 'iPhone', safaridriver will only create a session using an iPhone device or iPhone simulator.
setSafariDeviceUdid(String) - Method in interface io.appium.java_client.safari.options.SupportsSafariDeviceUdidOption
safaridriver will only create a session using hosts whose device UDID matches the value of safari:deviceUDID.
setSafariGarbageCollect(boolean) - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariGarbageCollectOption
Turns on/off Web Inspector garbage collection when executing scripts on Safari.
setSafariIgnoreFraudWarning(boolean) - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariIgnoreFraudWarningOption
Prevent Safari from showing a fraudulent website warning.
setSafariIgnoreWebHostnames(String) - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariIgnoreWebHostnamesOption
Provide a list of hostnames (comma-separated) that the Safari automation tools should ignore.
setSafariInitialUrl(String) - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariInitialUrlOption
Set initial safari url, default is a local welcome page.
setSafariLogAllCommunication(boolean) - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariLogAllCommunicationOption
Log all plists sent to and received from the Web Inspector, as plain text.
setSafariLogAllCommunicationHexDump(boolean) - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariLogAllCommunicationHexDumpOption
Log all communication sent to and received from the Web Inspector, as raw hex dump and printable characters.
setSafariOpenLinksInBackground(boolean) - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariOpenLinksInBackgroundOption
Whether Safari should allow links to open in new windows.
setSafariPlatformBuildVersion(String) - Method in interface io.appium.java_client.safari.options.SupportsSafariPlatformBuildVersionOption
safaridriver will only create a session using hosts whose OS build version matches the value of safari:platformBuildVersion.
setSafariPlatformVersion(String) - Method in interface io.appium.java_client.safari.options.SupportsSafariPlatformVersionOption
safaridriver will only create a session using hosts whose OS version matches the value of safari:platformVersion.
setSafariSocketChunkSize(int) - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariSocketChunkSizeOption
The size, in bytes, of the data to be sent to the Web Inspector on iOS 11+ real devices.
setSafariUseSimulator(boolean) - Method in interface io.appium.java_client.safari.options.SupportsSafariUseSimulatorOption
If the value of safari:useSimulator is true, safaridriver will only use iOS Simulator hosts.
setSafariWebInspectorMaxFrameLength(int) - Method in interface io.appium.java_client.ios.options.webview.SupportsSafariWebInspectorMaxFrameLengthOption
The maximum size in bytes of a single data frame for the Web Inspector.
setScaleFactor(String) - Method in interface io.appium.java_client.ios.options.simulator.SupportsScaleFactorOption
Simulator scale factor.
setScreenshotQuality(int) - Method in interface io.appium.java_client.ios.HasIOSSettings
Changes the quality of phone display screenshots according to XCTest/XCTImageQuality enum.
setScreenshotQuality(int) - Method in interface io.appium.java_client.ios.options.wda.SupportsScreenshotQualityOption
Changes the quality of phone display screenshots following xctest/xctimagequality Default value is 1.
setServerStartupTimeout(Duration) - Method in interface io.appium.java_client.mac.options.SupportsServerStartupTimeoutOption
The timeout to wait util the WebDriverAgentMac project is built and started.
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.
setSetting(String, 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.
setSettings(EnumMap<Setting, Object>) - Method in interface io.appium.java_client.HasSettings
Sets settings for this test session.
setSettings(Map<String, Object>) - Method in interface io.appium.java_client.HasSettings
Sets settings for this test session.
setSettingsCommand(String, Object) - Static method in class io.appium.java_client.MobileCommand
 
setSettingsCommand(Map<String, Object>) - Static method in class io.appium.java_client.MobileCommand
 
setShouldTerminateApp(boolean) - Method in interface io.appium.java_client.ios.options.wda.SupportsShouldTerminateAppOption
Specify if the app should be terminated on session end.
setShouldUseCompactResponses(boolean) - Method in interface io.appium.java_client.android.HasAndroidSettings
Whether to return compact (standards-compliant) and faster responses in find element/s (the default setting).
setShouldUseCompactResponses(boolean) - Method in interface io.appium.java_client.ios.HasIOSSettings
Whether to return compact (standards-compliant) and faster responses from find element/s (the default setting).
setShouldUseSingletonTestManager(boolean) - Method in interface io.appium.java_client.ios.options.wda.SupportsShouldUseSingletonTestManagerOption
Use default proxy for test management within WebDriverAgent.
setShowChromedriverLog(boolean) - Method in interface io.appium.java_client.android.options.context.SupportsShowChromedriverLogOption
If set to true then all the output from chromedriver binary will be forwarded to the Appium server log.
setShowGradleLog(boolean) - Method in interface io.appium.java_client.android.options.server.SupportsShowGradleLogOption
Whether to include Gradle log to the regular server logs while building Espresso server.
setShowIosLog(boolean) - Method in interface io.appium.java_client.ios.options.other.SupportsShowIosLogOption
Whether to show any logs captured from a device in the appium logs.
setShowServerLogs(boolean) - Method in interface io.appium.java_client.mac.options.SupportsShowServerLogsOption
Set it to true in order to include xcodebuild output to the Appium server log.
setShowXcodeLog(boolean) - Method in interface io.appium.java_client.ios.options.wda.SupportsShowXcodeLogOption
Whether to display the output of the Xcode command used to run the tests in Appium logs.
setShutdownOtherSimulators(boolean) - Method in interface io.appium.java_client.ios.options.simulator.SupportsShutdownOtherSimulatorsOption
If this capability set to true and the current device under test is an iOS Simulator then Appium will try to shutdown all the other running Simulators before to start a new session.
setSimpleIsVisibleCheck(boolean) - Method in interface io.appium.java_client.ios.options.wda.SupportsSimpleIsVisibleCheckOption
Use native methods for determining visibility of elements.
setSimulatorDevicesSetPath(String) - Method in interface io.appium.java_client.ios.options.simulator.SupportsSimulatorDevicesSetPathOption
This capability allows to set an alternative path to the simulator devices set in case you have multiple sets deployed on your local system.
setSimulatorPasteboardAutomaticSync(PasteboardSyncState) - Method in interface io.appium.java_client.ios.options.simulator.SupportsSimulatorPasteboardAutomaticSyncOption
Handle the -PasteboardAutomaticSync flag when simulator process launches.
setSimulatorStartupTimeout(Duration) - Method in interface io.appium.java_client.ios.options.simulator.SupportsSimulatorStartupTimeoutOption
Allows to change the default timeout for Simulator startup.
setSimulatorTracePointer(boolean) - Method in interface io.appium.java_client.ios.options.simulator.SupportsSimulatorTracePointerOption
Whether to highlight pointer moves in the Simulator window.
setSimulatorWindowCenter(String) - Method in interface io.appium.java_client.ios.options.simulator.SupportsSimulatorWindowCenterOption
Allows to explicitly set the coordinates of Simulator window center for Xcode9+ SDK.
setSkipAppKill(boolean) - Method in interface io.appium.java_client.mac.options.SupportsSkipAppKillOption
Set whether to skip the termination of the application under test when the testing session quits.
setSkipDeviceInitialization(boolean) - Method in interface io.appium.java_client.android.options.server.SupportsSkipDeviceInitializationOption
If set to true then device startup checks (whether it is ready and whether Settings app is installed) will be canceled on session creation.
setSkipLogCapture(boolean) - Method in interface io.appium.java_client.remote.options.SupportsSkipLogCaptureOption
Skips to start capturing system logs.
setSkipLogcatCapture(boolean) - Method in interface io.appium.java_client.android.options.adb.SupportsSkipLogcatCaptureOption
Being set to true disables automatic logcat output collection during the test run.
setSkipServerInstallation(boolean) - Method in interface io.appium.java_client.android.options.server.SupportsSkipServerInstallationOption
Set whether to skip the server components installation on the device under test and all the related checks.
setSkipUnlock(boolean) - Method in interface io.appium.java_client.android.options.locking.SupportsSkipUnlockOption
Whether to skip the check for lock screen presence (true).
setSuppressKillServer(boolean) - Method in interface io.appium.java_client.android.options.adb.SupportsSuppressKillServerOption
Being set to true prevents the driver from ever killing the ADB server explicitly.
setSystemHost(String) - Method in interface io.appium.java_client.mac.options.SupportsSystemHostOption
The name of the host for the internal server to listen on.
setSystemPort(int) - Method in interface io.appium.java_client.android.options.server.SupportsSystemPortOption
The number of the port the UiAutomator2 or Espresso server is listening on.
setSystemPort(int) - Method in interface io.appium.java_client.gecko.options.SupportsSystemPortOption
The number of the port for the driver to listen on.
setSystemPort(int) - Method in interface io.appium.java_client.mac.options.SupportsSystemPortOption
The number of the port for the internal server to listen on.
setSystemPort(int) - Method in interface io.appium.java_client.windows.options.SupportsSystemPortOption
The port number to execute Appium Windows Driver server listener on, for example 5556.
Setting - Enum in io.appium.java_client
Enums defining constants for Appium Settings which can be set and toggled during a test session.
SETTINGS - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Settings key.
setTrackScrollEvents(boolean) - Method in interface io.appium.java_client.android.HasAndroidSettings
Turn on or off the tracking of scroll events as they happen.
setUdid(String) - Method in interface io.appium.java_client.remote.options.SupportsUdidOption
Set the id of the device.
setUiautomator2ServerInstallTimeout(Duration) - Method in interface io.appium.java_client.android.options.server.SupportsEspressoServerLaunchTimeoutOption
Set the maximum timeout to wait util Espresso is listening on the device.
setUiautomator2ServerInstallTimeout(Duration) - Method in interface io.appium.java_client.android.options.server.SupportsUiautomator2ServerInstallTimeoutOption
Set the maximum timeout to wait util UiAutomator2Server is installed on the device.
setUiautomator2ServerLaunchTimeout(Duration) - Method in interface io.appium.java_client.android.options.server.SupportsUiautomator2ServerLaunchTimeoutOption
Set the maximum timeout to wait util UiAutomator2Server is listening on the device.
setUiautomator2ServerReadTimeout(Duration) - Method in interface io.appium.java_client.android.options.server.SupportsUiautomator2ServerReadTimeoutOption
Set the maximum timeout to wait for a HTTP response from UiAutomator2Server.
setUnhandledPromptBehavior(UnhandledPromptBehavior) - Method in interface io.appium.java_client.remote.options.SupportsUnhandledPromptBehaviorOption
Defines the current session’s page load strategy.
setUninstallOtherPackages(String) - Method in interface io.appium.java_client.android.options.app.SupportsUninstallOtherPackagesOption
Allows to set one or more comma-separated package identifiers to be uninstalled from the device before a test starts.
setUnlockKey(String) - Method in interface io.appium.java_client.android.options.locking.SupportsUnlockKeyOption
Allows to set an unlock key.
setUnlockStrategy(String) - Method in interface io.appium.java_client.android.options.locking.SupportsUnlockStrategyOption
Either 'locksettings' (default) or 'uiautomator'.
setUnlockSuccessTimeout(Duration) - Method in interface io.appium.java_client.android.options.locking.SupportsUnlockSuccessTimeoutOption
Maximum timeout to wait until the device is unlocked.
setUnlockType(String) - Method in interface io.appium.java_client.android.options.locking.SupportsUnlockTypeOption
Set one of the possible types of Android lock screens to unlock.
setUpdatedWdaBundleId(String) - Method in interface io.appium.java_client.ios.options.wda.SupportsUpdatedWdaBundleIdOption
Bundle id to update WDA to before building and launching on real devices.
setUseJSONSource(boolean) - Method in interface io.appium.java_client.ios.options.other.SupportsUseJsonSourceOption
Get JSON source from WDA and transform it to XML on the Appium server side.
setUseNativeCachingStrategy(boolean) - Method in interface io.appium.java_client.ios.options.wda.SupportsUseNativeCachingStrategyOption
Set this capability to false in order to use the custom elements caching strategy.
setUseNewWDA(boolean) - Method in interface io.appium.java_client.ios.options.wda.SupportsUseNewWdaOption
If true, forces uninstall of any existing WebDriverAgent app on device.
setUsePrebuiltWda(boolean) - Method in interface io.appium.java_client.ios.options.wda.SupportsUsePrebuiltWdaOption
Skips the build phase of running the WDA app.
setUserProfile(int) - Method in interface io.appium.java_client.android.options.other.SupportsUserProfileOption
Integer identifier of a user profile.
setUseSimpleBuildTest(boolean) - Method in interface io.appium.java_client.ios.options.wda.SupportsUseSimpleBuildTestOption
Build with build and run test with test in xcodebuild for all Xcode versions if this is true, or build with build-for-testing and run tests with test-without-building for over Xcode 8 if this is false.
setUseSystemExecutable(boolean) - Method in interface io.appium.java_client.chromium.options.SupportsUseSystemExecutableOption
Set to true to use the version of WebDriver bundled with this driver, rather than attempting to download a new one based on the version of the browser under test.
setUseXctestrunFile(boolean) - Method in interface io.appium.java_client.ios.options.wda.SupportsUseXctestrunFileOption
Use Xctestrun file to launch WDA.
setVerbose(boolean) - Method in interface io.appium.java_client.chromium.options.SupportsVerboseOption
Set to true to add the --verbose flag when starting WebDriver.
setVerbosity(Verbosity) - Method in interface io.appium.java_client.gecko.options.SupportsVerbosityOption
The verbosity level of driver logging.
setWaitForAppLaunch(Duration) - Method in interface io.appium.java_client.windows.options.SupportsMsWaitForAppLaunchOption
Similar to createSessionTimeout, but is applied on the server side.
setWaitForIdleTimeout(Duration) - Method in interface io.appium.java_client.ios.options.wda.SupportsWaitForIdleTimeoutOption
The time to wait until the application under test is idling.
setWaitForQuiescence(boolean) - Method in interface io.appium.java_client.ios.options.wda.SupportsWaitForQuiescenceOption
It allows to turn on/off waiting for application quiescence in WebDriverAgent, while performing queries.
setWdaBaseUrl(String) - Method in interface io.appium.java_client.ios.options.wda.SupportsWdaBaseUrlOption
This value, if specified, will be used as a prefix to build a custom WebDriverAgent url.
setWdaBaseUrl(URL) - Method in interface io.appium.java_client.ios.options.wda.SupportsWdaBaseUrlOption
This value, if specified, will be used as a prefix to build a custom WebDriverAgent url.
setWdaConnectionTimeout(Duration) - Method in interface io.appium.java_client.ios.options.wda.SupportsWdaConnectionTimeoutOption
Connection timeout to wait for a response from WebDriverAgent.
setWdaEventloopIdleDelay(Duration) - Method in interface io.appium.java_client.ios.options.wda.SupportsWdaEventloopIdleDelayOption
Delays the invocation of -[XCUIApplicationProcess setEventLoopHasIdled:] by the duration specified with this capability.
setWdaLaunchTimeout(Duration) - Method in interface io.appium.java_client.ios.options.wda.SupportsWdaLaunchTimeoutOption
Timeout to wait for WebDriverAgent to be pingable, e.g.
setWdaLocalPort(int) - Method in interface io.appium.java_client.ios.options.wda.SupportsWdaLocalPortOption
This value, if specified, will be used to forward traffic from Mac host to real ios devices over USB.
setWdaStartupRetries(int) - Method in interface io.appium.java_client.ios.options.wda.SupportsWdaStartupRetriesOption
Number of times to try to build and launch WebDriverAgent onto the device.
setWdaStartupRetryInterval(Duration) - Method in interface io.appium.java_client.ios.options.wda.SupportsWdaStartupRetryIntervalOption
Time interval to wait between tries to build and launch WebDriverAgent.
setWebDriverAgentMacUrl(String) - Method in interface io.appium.java_client.mac.options.SupportsWebDriverAgentMacUrlOption
Set the URL Appium will connect to an existing WebDriverAgentMac instance at this URL instead of starting a new one.
setWebDriverAgentMacUrl(URL) - Method in interface io.appium.java_client.mac.options.SupportsWebDriverAgentMacUrlOption
Set the URL Appium will connect to an existing WebDriverAgentMac instance at this URL instead of starting a new one.
setWebDriverAgentUrl(String) - Method in interface io.appium.java_client.ios.options.wda.SupportsWebDriverAgentUrlOption
If provided, Appium will connect to an existing WebDriverAgent instance at this URL instead of starting a new one.
setWebDriverAgentUrl(URL) - Method in interface io.appium.java_client.ios.options.wda.SupportsWebDriverAgentUrlOption
If provided, Appium will connect to an existing WebDriverAgent instance at this URL instead of starting a new one.
setWebkitResponseTimeout(Duration) - Method in interface io.appium.java_client.ios.options.simulator.SupportsWebkitResponseTimeoutOption
(Real device only) Set the time to wait for a response from WebKit in a Safari session.
setWebkitWebrtc(WebrtcData) - Method in interface io.appium.java_client.safari.options.SupportsWebkitWebrtcOption
This capability allows a test to temporarily change Safari's policies for WebRTC and Media Capture.
setWebviewConnectRetries(int) - Method in interface io.appium.java_client.ios.options.webview.SupportsWebviewConnectRetriesOption
Number of times to send connection message to remote debugger, to get a webview.
setWebviewConnectTimeout(Duration) - Method in interface io.appium.java_client.ios.options.webview.SupportsWebkitResponseTimeoutOption
(Real device only) Set the time to wait for a response from WebKit in a Safari session.
setWebviewConnectTimeout(Duration) - Method in interface io.appium.java_client.ios.options.webview.SupportsWebviewConnectTimeoutOption
The time to wait for the initial presence of webviews in MobileSafari or hybrid apps.
setWebviewDevtoolsPort(int) - Method in interface io.appium.java_client.android.options.context.SupportsWebviewDevtoolsPortOption
The local port number to use for devtools communication.
setWindowRect(boolean) - Method in interface io.appium.java_client.remote.options.SupportsSetWindowRectOption
Indicates whether the remote end supports all of the resizing and repositioning commands.
setXcodeCertificate(XcodeCertificate) - Method in interface io.appium.java_client.ios.options.wda.SupportsXcodeCertificateOptions
Provides a signing certificate for WebDriverAgent compilation.
shake() - Method in interface io.appium.java_client.ios.ShakesDevice
Simulate shaking the Simulator.
SHAKE - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
shakeCommand() - Static method in class io.appium.java_client.ios.IOSMobileCommandHelper
Deprecated.
this helper is deprecated and will be removed in future versions.
ShakesDevice - Interface in io.appium.java_client.ios
 
SHELL - io.appium.java_client.service.local.flags.GeneralServerFlag
Enter REPL mode.
SHIFT_LEFT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Left Shift modifier key.
SHIFT_LEFT_ON - io.appium.java_client.android.nativekey.KeyEventMetaModifier
This mask is used to check whether the left SHIFT meta key is pressed.
SHIFT_MASK - io.appium.java_client.android.nativekey.KeyEventMetaModifier
SHIFT_ON - io.appium.java_client.android.nativekey.KeyEventMetaModifier
This mask is used to check whether one of the SHIFT meta keys is pressed.
SHIFT_RIGHT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Right Shift modifier key.
SHIFT_RIGHT_ON - io.appium.java_client.android.nativekey.KeyEventMetaModifier
This mask is used to check whether the right SHIFT meta key is pressed.
SHOULD_TERMINATE_APP_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsShouldTerminateAppOption
 
SHOULD_USE_COMPACT_RESPONSES - io.appium.java_client.Setting
 
SHOULD_USE_SINGLETON_TEST_MANAGER_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsShouldUseSingletonTestManagerOption
 
shouldUseSingletonTestManager() - Method in interface io.appium.java_client.ios.options.wda.SupportsShouldUseSingletonTestManagerOption
Enforce usage of the default proxy for test management within WebDriverAgent.
SHOW_CHROMEDRIVER_LOG_OPTION - Static variable in interface io.appium.java_client.android.options.context.SupportsShowChromedriverLogOption
 
SHOW_CONFIG - io.appium.java_client.service.local.flags.GeneralServerFlag
Show info about the Appium server configuration and exit.
SHOW_GRADLE_LOG_OPTION - Static variable in interface io.appium.java_client.android.options.server.SupportsShowGradleLogOption
 
SHOW_IOS_LOG_OPTION - Static variable in interface io.appium.java_client.ios.options.other.SupportsShowIosLogOption
 
SHOW_SERVER_LOGS_OPTION - Static variable in interface io.appium.java_client.mac.options.SupportsShowServerLogsOption
 
SHOW_XCODE_LOG_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsShowXcodeLogOption
 
showChromedriverLog() - Method in interface io.appium.java_client.android.options.context.SupportsShowChromedriverLogOption
Enforces all the output from chromedriver binary to be forwarded to the Appium server log.
showGradleLog() - Method in interface io.appium.java_client.android.options.server.SupportsShowGradleLogOption
Enforces inclusion of the Gradle log to the regular server logs.
showIosLog() - Method in interface io.appium.java_client.ios.options.other.SupportsShowIosLogOption
Enforces showing any logs captured from a device in the appium logs.
showServerLogs() - Method in interface io.appium.java_client.mac.options.SupportsShowServerLogsOption
Enforce showing of WDA server logs in the Appium log..
showXcodeLog() - Method in interface io.appium.java_client.ios.options.wda.SupportsShowXcodeLogOption
Enforce to display the output of the Xcode command used to run the tests in Appium logs.
SHUTDOWN_ON_POWER_DISCONNECT - io.appium.java_client.Setting
 
SHUTDOWN_OTHER_SIMULATORS_OPTION - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsShutdownOtherSimulatorsOption
 
shutdownOnPowerDisconnect(boolean) - Method in interface io.appium.java_client.android.HasAndroidSettings
Whether to enable or disable shutdown the server through the broadcast receiver on ACTION_POWER_DISCONNECTED.
shutdownOtherSimulators() - Method in interface io.appium.java_client.ios.options.simulator.SupportsShutdownOtherSimulatorsOption
Enforce shutdown of other booted simulators except of the current one.
SIFT - io.appium.java_client.imagecomparison.FeatureDetector
 
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_IS_VISIBLE_CHECK_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsSimpleIsVisibleCheckOption
 
simpleIsVisibleCheck() - Method in interface io.appium.java_client.ios.options.wda.SupportsSimpleIsVisibleCheckOption
Enforce usage of native methods for determining visibility of elements.
SIMULATOR_DEVICES_SET_PATH_OPTION - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsSimulatorDevicesSetPathOption
 
SIMULATOR_PASTEBOARD_AUTOMATIC_SYNC - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsSimulatorPasteboardAutomaticSyncOption
 
SIMULATOR_STARTUP_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsSimulatorStartupTimeoutOption
 
SIMULATOR_TRACE_POINTER_OPTION - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsSimulatorTracePointerOption
 
SIMULATOR_WINDOW_CENTER_OPTION - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsSimulatorWindowCenterOption
 
simulatorTracePointer() - Method in interface io.appium.java_client.ios.options.simulator.SupportsSimulatorTracePointerOption
Enforce highlight of pointer moves in the Simulator window.
SKIP_APP_KILL_OPTION - Static variable in interface io.appium.java_client.mac.options.SupportsSkipAppKillOption
 
SKIP_DEVICE_INITIALIZATION_OPTION - Static variable in interface io.appium.java_client.android.options.server.SupportsSkipDeviceInitializationOption
 
SKIP_LOG_CAPTURE_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsSkipLogCaptureOption
 
SKIP_LOGCAT_CAPTURE_OPTION - Static variable in interface io.appium.java_client.android.options.adb.SupportsSkipLogcatCaptureOption
 
SKIP_SERVER_INSTALLATION_OPTION - Static variable in interface io.appium.java_client.android.options.server.SupportsSkipServerInstallationOption
 
SKIP_UNLOCK_OPTION - Static variable in interface io.appium.java_client.android.options.locking.SupportsSkipUnlockOption
 
skipAppKill() - Method in interface io.appium.java_client.mac.options.SupportsSkipAppKillOption
Enforces skipping the termination of the application under test when the testing session quits.
skipDeviceInitialization() - Method in interface io.appium.java_client.android.options.server.SupportsSkipDeviceInitializationOption
Disables initial device startup checks by the server.
skipLogCapture() - Method in interface io.appium.java_client.remote.options.SupportsSkipLogCaptureOption
Skips capturing system logs.
skipLogcatCapture() - Method in interface io.appium.java_client.android.options.adb.SupportsSkipLogcatCaptureOption
Disables automatic logcat output collection during the test run.
skipServerInstallation() - Method in interface io.appium.java_client.android.options.server.SupportsSkipServerInstallationOption
Enables skipping of the server components installation on the device under test and all the related checks.
skipUnlock() - Method in interface io.appium.java_client.android.options.locking.SupportsSkipUnlockOption
Skip the check for lock screen presence.
SLASH - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '/' key.
SLEEP - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Sleep key.
Slf4jLogMessageContext - Class in io.appium.java_client.service.local
This class provides context to a Slf4jLogMessageConsumer.
SOFT_KEYBOARD - io.appium.java_client.android.nativekey.KeyEventFlag
This mask is set if the key event was generated by a software keyboard.
SOFT_LEFT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Soft Left key.
SOFT_RIGHT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Soft Right key.
SOFT_SLEEP - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: put device to sleep unless a wakelock is held.
SPACE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Space key.
STAR - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: '*' key.
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
Deprecated.
START_RECORDING_SCREEN - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
START_TRACKING - io.appium.java_client.android.nativekey.KeyEventFlag
Private control to determine when an app is tracking a key sequence.
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() - Method in interface io.appium.java_client.screenrecording.CanRecordScreen
Start asynchronous screen recording process with default options.
startRecordingScreen(T) - Method in interface io.appium.java_client.screenrecording.CanRecordScreen
Start asynchronous screen recording process.
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
 
startScreenRecordingOptions() - Static method in class io.appium.java_client.mac.Mac2StartScreenRecordingOptions
 
startScreenRecordingOptions() - Static method in class io.appium.java_client.windows.WindowsStartScreenRecordingOptions
 
startSession(Capabilities) - Method in class io.appium.java_client.AppiumDriver
 
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.
startTimestamp - Variable in class io.appium.java_client.serverevents.CommandEvent
 
STB_INPUT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Set-top-box input key.
STB_POWER - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Set-top-box power key.
STEM_1 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic stem key 1 for Wear.
STEM_2 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic stem key 2 for Wear.
STEM_3 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Generic stem key 3 for Wear.
STEM_PRIMARY - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Primary stem key for Wear.
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
Deprecated.
stopLogcatBroadcast() - Method in interface io.appium.java_client.android.ListensToLogcatMessages
Stops logcat messages broadcast via web socket.
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.
stopRecordingScreen(T) - Method in interface io.appium.java_client.screenrecording.CanRecordScreen
Gather the output from the previously started screen recording to a media file.
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
 
stopScreenRecordingOptions() - Static method in class io.appium.java_client.mac.Mac2StopScreenRecordingOptions
 
stopScreenRecordingOptions() - Static method in class io.appium.java_client.windows.WindowsStopScreenRecordingOptions
 
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.
STRICT_CAPS - io.appium.java_client.service.local.flags.GeneralServerFlag
Cause sessions to fail if desired caps are sent in that Appium does not recognize as valid for the selected device.
StringWebSocketClient - Class in io.appium.java_client.ws
 
StringWebSocketClient(HttpClient) - Constructor for class io.appium.java_client.ws.StringWebSocketClient
 
SupportsAbsoluteWebLocationsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsAcceptInsecureCertsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsActivityOptionsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.app
 
SupportsAdbExecTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.adb
 
SupportsAdbPortOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.adb
 
SupportsAdditionalWebviewBundleIdsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsAllowDelayAdbOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.adb
 
SupportsAllowProvisioningDeviceRegistrationOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsAllowTestPackagesOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.app
 
SupportsAndroidInstallTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.app
 
SupportsAndroidStorageOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.gecko.options
 
SupportsAppActivityOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.app
 
SupportsAppArgumentsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.windows.options
 
SupportsAppInstallStrategyOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.app
 
SupportsAppLocaleOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.localization
 
SupportsAppOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsAppPackageOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.app
 
SupportsAppPushTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.app
 
SupportsAppTopLevelWindowOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.windows.options
 
SupportsAppWaitActivityOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.app
 
SupportsAppWaitDurationOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.app
 
SupportsAppWaitForLaunchOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.app
 
SupportsAppWaitPackageOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.app
 
SupportsAppWorkingDirOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.windows.options
 
SupportsArgumentsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.mac.options
 
SupportsAutoAcceptAlertsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsAutoDismissAlertsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsAutodownloadOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.chromium.options
 
SupportsAutoGrantPermissionsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.app
 
SupportsAutomationNameOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsAutoWebViewOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsAutoWebviewTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.context
 
SupportsAvdArgsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.avd
 
SupportsAvdEnvOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.avd
 
SupportsAvdLaunchTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.avd
 
SupportsAvdOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.avd
 
SupportsAvdReadyTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.avd
 
SupportsBootstrapRootOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.mac.options
 
SupportsBrowserNameOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsBrowserVersionOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsBuildCheckOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.chromium.options
 
SupportsBuildToolsVersionOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.adb
 
SupportsBundleIdOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.app
 
SupportsBundleIdOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.mac.options
 
SupportsCalendarAccessAuthorizedOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsCalendarFormatOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsChromeDrivePortOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.chromium.options
 
SupportsChromedriverArgsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.context
 
SupportsChromedriverChromeMappingFileOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.context
 
SupportsChromedriverDisableBuildCheckOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.context
 
SupportsChromedriverExecutableDirOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.context
 
SupportsChromedriverExecutableOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.context
 
SupportsChromedriverPortOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.context
 
SupportsChromedriverPortsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.context
 
SupportsChromedriverUseSystemExecutableOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.context
 
SupportsChromeLoggingPrefsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.context
 
SupportsChromeOptionsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.context
 
SupportsClearDeviceLogsOnStartOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.adb
 
SupportsClearSystemFilesOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsCommandTimeoutsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.other
 
SupportsConnectHardwareKeyboardOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsContextSwitching - Interface in io.appium.java_client.remote
 
SupportsCreateSessionTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.windows.options
 
SupportsCustomSslCertOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsDerivedDataPathOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsDeviceNameOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsDisableAutomaticScreenshotsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsDisableSuppressAccessibilityServiceOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.other
 
SupportsDisableWindowAnimationOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.server
 
SupportsEnableAsyncExecuteFromHttpsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsEnablePerformanceLoggingOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsEnforceAppInstallOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsEnforceFreshSimulatorCreationOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsEnsureWebviewsHavePagesOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.context
 
SupportsEnvironmentOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.mac.options
 
SupportsEspressoBuildConfigOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.server
 
SupportsEspressoServerLaunchTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.server
 
SupportsEventTimingsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsExecutableDirOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.chromium.options
 
SupportsExecutableOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.chromium.options
 
SupportsExtendedGeolocationCommands - Interface in io.appium.java_client.android.geolocation
 
SupportsExtractChromeAndroidPackageFromContextNameOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.context
 
SupportsForceAppLaunchOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsForceEspressoRebuildOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.server
 
SupportsForceSimulatorSoftwareKeyboardPresenceOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsFullContextListOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsFullResetOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsGpsEnabledOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.avd
 
SupportsGpsStateManagement - Interface in io.appium.java_client.android
 
SupportsIgnoreHiddenApiPolicyErrorOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.adb
 
SupportsIncludeDeviceCapsToSessionInfoOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.general
 
SupportsIncludeSafariInWebviewsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsIntentActionOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.app
 
SupportsIntentCategoryOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.app
 
SupportsIntentFlagsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.app
 
SupportsIntentOptionsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.app
 
SupportsIosSimulatorLogsPredicateOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsIsHeadlessOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsKeepKeyChainsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsKeychainOptions<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsKeychainsExcludePatternsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsKeystoreOptions<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.signing
 
SupportsLanguageOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsLaunchWithIdbOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.other
 
SupportsLocaleOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsLocaleScriptOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.localization
 
SupportsLocalizableStringsDirOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.app
 
SupportsLocation - Interface in io.appium.java_client.remote
 
SupportsLogcatFilterSpecsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.adb
 
SupportsLogcatFormatOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.adb
 
SupportsLogPathOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.chromium.options
 
SupportsMarionettePortOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.gecko.options
 
SupportsMaxTypingFrequencyOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsMjpegScreenshotUrlOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.mjpeg
 
SupportsMjpegServerPortOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.mjpeg
 
SupportsMjpegServerPortOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsMockLocationAppOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.adb
 
SupportsMozFirefoxOptionsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.gecko.options
 
SupportsMsExperimentalWebDriverOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.windows.options
 
SupportsMsWaitForAppLaunchOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.windows.options
 
SupportsNativeWebScreenshotOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.context
 
SupportsNativeWebTapOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsNativeWebTapStrictOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsNetworkSpeedOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.avd
 
SupportsNetworkStateManagement - Interface in io.appium.java_client.android
 
SupportsNewCommandTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsNoResetOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsNoSignOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.signing
 
SupportsOptionalIntentArgumentsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.app
 
SupportsOrientationOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsOtherAppsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsPageLoadStrategyOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsPermissionsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsPlatformVersionOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsPostrunOption<T extends BaseOptions<T>,​S extends SystemScript<?>> - Interface in io.appium.java_client.remote.options
 
SupportsPrerunOption<T extends BaseOptions<T>,​S extends SystemScript<?>> - Interface in io.appium.java_client.remote.options
 
SupportsPrintPageSourceOnFindFailureOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsProcessArgumentsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsProxyOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsRecreateChromeDriverSessionsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.context
 
SupportsReduceMotionOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsRemoteAdbHostOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.adb
 
SupportsRemoteAppsCacheLimitOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.app
 
SupportsResetLocationServiceOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.general
 
SupportsResetOnSessionStartOnlyOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.other
 
SupportsResultBundlePathOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsRotation - Interface in io.appium.java_client.remote
 
SupportsSafariAllowPopupsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsSafariAutomaticInspectionOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.safari.options
 
SupportsSafariAutomaticProfilingOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.safari.options
 
SupportsSafariDeviceNameOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.safari.options
 
SupportsSafariDeviceTypeOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.safari.options
 
SupportsSafariDeviceUdidOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.safari.options
 
SupportsSafariGarbageCollectOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsSafariIgnoreFraudWarningOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsSafariIgnoreWebHostnamesOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsSafariInitialUrlOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsSafariLogAllCommunicationHexDumpOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsSafariLogAllCommunicationOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsSafariOpenLinksInBackgroundOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsSafariPlatformBuildVersionOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.safari.options
 
SupportsSafariPlatformVersionOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.safari.options
 
SupportsSafariSocketChunkSizeOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsSafariUseSimulatorOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.safari.options
 
SupportsSafariWebInspectorMaxFrameLengthOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsScaleFactorOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsScreenshotQualityOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsServerStartupTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.mac.options
 
SupportsSetWindowRectOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsShouldTerminateAppOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsShouldUseSingletonTestManagerOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsShowChromedriverLogOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.context
 
SupportsShowGradleLogOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.server
 
SupportsShowIosLogOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.other
 
SupportsShowServerLogsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.mac.options
 
SupportsShowXcodeLogOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsShutdownOtherSimulatorsOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsSimpleIsVisibleCheckOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsSimulatorDevicesSetPathOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsSimulatorPasteboardAutomaticSyncOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsSimulatorStartupTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsSimulatorTracePointerOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsSimulatorWindowCenterOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsSkipAppKillOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.mac.options
 
SupportsSkipDeviceInitializationOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.server
 
SupportsSkipLogCaptureOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsSkipLogcatCaptureOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.adb
 
SupportsSkipServerInstallationOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.server
 
SupportsSkipUnlockOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.locking
 
SupportsSpecialEmulatorCommands - Interface in io.appium.java_client.android
 
SupportsSuppressKillServerOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.adb
 
SupportsSystemHostOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.mac.options
 
SupportsSystemPortOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.server
 
SupportsSystemPortOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.gecko.options
 
SupportsSystemPortOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.mac.options
 
SupportsSystemPortOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.windows.options
 
SupportsUdidOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsUiautomator2ServerInstallTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.server
 
SupportsUiautomator2ServerLaunchTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.server
 
SupportsUiautomator2ServerReadTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.server
 
SupportsUnhandledPromptBehaviorOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.remote.options
 
SupportsUninstallOtherPackagesOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.app
 
SupportsUnlockKeyOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.locking
 
SupportsUnlockStrategyOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.locking
 
SupportsUnlockSuccessTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.locking
 
SupportsUnlockTypeOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.locking
 
SupportsUpdatedWdaBundleIdOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsUseJsonSourceOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.other
 
SupportsUseNativeCachingStrategyOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsUseNewWdaOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsUsePrebuiltWdaOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsUserProfileOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.other
 
SupportsUseSimpleBuildTestOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsUseSystemExecutableOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.chromium.options
 
SupportsUseXctestrunFileOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsVerboseOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.chromium.options
 
SupportsVerbosityOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.gecko.options
 
SupportsWaitForIdleTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsWaitForQuiescenceOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsWdaBaseUrlOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsWdaConnectionTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsWdaEventloopIdleDelayOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsWdaLaunchTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsWdaLocalPortOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsWdaStartupRetriesOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsWdaStartupRetryIntervalOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsWebDriverAgentMacUrlOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.mac.options
 
SupportsWebDriverAgentUrlOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SupportsWebkitResponseTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.simulator
 
SupportsWebkitResponseTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsWebkitWebrtcOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.safari.options
 
SupportsWebviewConnectRetriesOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsWebviewConnectTimeoutOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.webview
 
SupportsWebviewDevtoolsPortOption<T extends BaseOptions<T>> - Interface in io.appium.java_client.android.options.context
 
SupportsXcodeCertificateOptions<T extends BaseOptions<T>> - Interface in io.appium.java_client.ios.options.wda
 
SUPPRESS_ADB_KILL_SERVER - io.appium.java_client.service.local.flags.AndroidServerFlag
If set, prevents Appium from killing the adb server instance.
SUPPRESS_KILL_SERVER_OPTION - Static variable in interface io.appium.java_client.android.options.adb.SupportsSuppressKillServerOption
 
suppressKillServer() - Method in interface io.appium.java_client.android.options.adb.SupportsSuppressKillServerOption
Prevents the driver from ever killing the ADB server explicitl.
SWITCH_CHARSET - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Switch Charset modifier key.
SWITCH_TO_CONTEXT - Static variable in class io.appium.java_client.MobileCommand
 
switchTo() - Method in class io.appium.java_client.ios.IOSDriver
 
SYM - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Symbol modifier key.
SYM_LOCKED - io.appium.java_client.android.nativekey.KeyEventMetaModifier
SYM key locked.
SYM_ON - io.appium.java_client.android.nativekey.KeyEventMetaModifier
This mask is used to check whether the SYM meta key is pressed.
SYSRQ - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: System Request / Print Screen key.
SYSTEM - io.appium.java_client.ios.options.simulator.PasteboardSyncState
 
SYSTEM_HOST_OPTION - Static variable in interface io.appium.java_client.mac.options.SupportsSystemHostOption
 
SYSTEM_PORT_OPTION - Static variable in interface io.appium.java_client.android.options.server.SupportsSystemPortOption
 
SYSTEM_PORT_OPTION - Static variable in interface io.appium.java_client.gecko.options.SupportsSystemPortOption
 
SYSTEM_PORT_OPTION - Static variable in interface io.appium.java_client.mac.options.SupportsSystemPortOption
 
SYSTEM_PORT_OPTION - Static variable in interface io.appium.java_client.windows.options.SupportsSystemPortOption
 
SystemScript<T extends SystemScript<T>> - Class in io.appium.java_client.remote.options
 
SystemScript() - Constructor for class io.appium.java_client.remote.options.SystemScript
 
SystemScript(Map<String, Object>) - Constructor for class io.appium.java_client.remote.options.SystemScript
 

T

T - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'T' key.
TAB - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Tab key.
tagName() - Method in annotation type io.appium.java_client.pagefactory.AndroidBy
It is a desired element tag.
tagName() - Method in annotation type io.appium.java_client.pagefactory.AndroidFindBy
It is a desired element tag.
tagName() - Method in annotation type io.appium.java_client.pagefactory.iOSBy
It is a desired element tag.
tagName() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITBy
It is a desired element tag.
tagName() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITFindBy
It is a desired element tag.
TAINTED - io.appium.java_client.android.nativekey.KeyEventFlag
Private flag that indicates when the system has detected that this key event may be inconsistent with respect to the sequence of previously delivered key events, such as when a key up event is sent but the key was not down.
tap(PointOption) - Method in class io.appium.java_client.TouchAction
Deprecated.
Tap on a position.
tap(TapOptions) - Method in class io.appium.java_client.TouchAction
Deprecated.
Tap on an element.
TAP_OUTSIDE - Static variable in interface io.appium.java_client.remote.HideKeyboardStrategy
 
tapOptions() - Static method in class io.appium.java_client.touch.TapOptions
It creates an empty instance of TapOptions.
TapOptions - Class in io.appium.java_client.touch
 
TapOptions() - Constructor for class io.appium.java_client.touch.TapOptions
 
TEMP_DIRECTORY - io.appium.java_client.service.local.flags.GeneralServerFlag
Absolute path to directory Appium can use to manage temporary files, like built-in iOS apps it needs to move around.
TERMINATE_APP - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
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.
test(String) - Method in class io.appium.java_client.remote.options.W3CCapabilityKeys
 
time() - Method in annotation type io.appium.java_client.pagefactory.WithTimeout
Desired waiting duration.
TimedEvent - Class in io.appium.java_client.serverevents
 
TimedEvent() - Constructor for class io.appium.java_client.serverevents.TimedEvent
 
toDouble(Object) - Static method in class io.appium.java_client.internal.CapabilityHelpers
Converts generic capability value to double.
toDuration(Object) - Static method in class io.appium.java_client.internal.CapabilityHelpers
Converts generic capability value to duration.
toDuration(Object, Function<Long, Duration>) - Static method in class io.appium.java_client.internal.CapabilityHelpers
Converts generic capability value to duration.
TOGGLE_AIRPLANE_MODE - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
TOGGLE_DATA - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
TOGGLE_LOCATION_SERVICES - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
TOGGLE_WIFI - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
toggleAirplaneCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
Deprecated.
toggleAirplaneMode() - Method in interface io.appium.java_client.android.SupportsNetworkStateManagement
Toggle Airplane mode and this works on Android versions below 6 and above 10.
toggleData() - Method in interface io.appium.java_client.android.SupportsNetworkStateManagement
Toggle Mobile Data and this works on Emulators and real devices running Android version above 10.
toggleDataCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
Deprecated.
toggleLocationServices() - Method in interface io.appium.java_client.android.SupportsGpsStateManagement
Toggles GPS service state.
toggleLocationServicesCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
Deprecated.
toggleTouchIDEnrollment(boolean) - Method in interface io.appium.java_client.ios.PerformsTouchID
Enrolls touchId in iOS Simulator.
toggleTouchIdEnrollmentCommand(boolean) - Static method in class io.appium.java_client.ios.IOSMobileCommandHelper
Deprecated.
this helper is deprecated and will be removed in future versions.
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
Deprecated.
toInteger(Object) - Static method in class io.appium.java_client.internal.CapabilityHelpers
Converts generic capability value to integer.
toJson() - Method in class io.appium.java_client.remote.options.BaseMapOptionData
 
toLong(Object) - Static method in class io.appium.java_client.internal.CapabilityHelpers
Converts generic capability value to long.
toMap() - Method in class io.appium.java_client.ios.options.wda.ProcessArguments
Returns the data object content as a map.
toMap() - Method in class io.appium.java_client.remote.options.BaseMapOptionData
 
TOOLS_VERSION - Static variable in class io.appium.java_client.android.options.server.EspressoBuildConfig
 
toSafeBoolean(Object) - Static method in class io.appium.java_client.internal.CapabilityHelpers
Converts generic capability value to boolean without throwing exceptions.
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.AppiumBy
 
toString() - Method in class io.appium.java_client.AppiumClientConfig
 
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.pagefactory.bys.ContentMappedBy
 
toString() - Method in class io.appium.java_client.remote.options.BaseMapOptionData
 
toString() - Method in enum io.appium.java_client.remote.options.UnhandledPromptBehavior
 
toString() - Method in enum io.appium.java_client.Setting
 
TOUCH_ID - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
TOUCH_ID_ENROLLMENT - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
TouchAction<T extends TouchAction<T>> - Class in io.appium.java_client
Deprecated.
Touch actions are deprecated. Please use W3C Actions instead or the corresponding extension methods for the driver (if available). Check - https://www.youtube.com/watch?v=oAJ7jwMNFVU - https://appiumpro.com/editions/30-ios-specific-touch-action-methods - https://appiumpro.com/editions/29-automating-complex-gestures-with-the-w3c-actions-api for more details.
TouchAction(PerformsTouchActions) - Constructor for class io.appium.java_client.TouchAction
Deprecated.
 
TouchAction.ActionParameter - Class in io.appium.java_client
Deprecated.
Just holds values to eventually return the parameters required for the mjsonwp.
touchIdCommand(boolean) - Static method in class io.appium.java_client.ios.IOSMobileCommandHelper
Deprecated.
this helper is deprecated and will be removed in future versions.
toUrl(Object) - Static method in class io.appium.java_client.internal.CapabilityHelpers
Converts generic capability value to a url.
toW3cName(String) - Static method in class io.appium.java_client.remote.options.BaseOptions
Adds the 'appium:' prefix to the given capability name if necessary.
TRACE - io.appium.java_client.gecko.options.Verbosity
 
TRACE_DIRECTORY_ABSOLUTE_PATH - io.appium.java_client.service.local.flags.IOSServerFlag
Absolute path to directory Appium use to save ios instruments traces, defaults to /appium-instruments.
TRACE_TEMPLATE_FILE_PATH - io.appium.java_client.service.local.flags.IOSServerFlag
.tracetemplate file to use with Instruments.
TRACK_SCROLL_EVENTS - io.appium.java_client.Setting
 
TRACKING - io.appium.java_client.android.nativekey.KeyEventFlag
Set for ACTION_UP when this event's key value is still being tracked from its initial down.
TV - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: TV key.
TV_ANTENNA_CABLE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Antenna/Cable key.
TV_AUDIO_DESCRIPTION - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Audio description key.
TV_AUDIO_DESCRIPTION_MIX_DOWN - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Audio description mixing volume down key.
TV_AUDIO_DESCRIPTION_MIX_UP - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Audio description mixing volume up key.
TV_CONTENTS_MENU - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Contents menu key.
TV_DATA_SERVICE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: TV data service key.
TV_INPUT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: TV input key.
TV_INPUT_COMPONENT_1 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Component #1 key.
TV_INPUT_COMPONENT_2 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Component #2 key.
TV_INPUT_COMPOSITE_1 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Composite #1 key.
TV_INPUT_COMPOSITE_2 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Composite #2 key.
TV_INPUT_HDMI_1 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: HDMI #1 key.
TV_INPUT_HDMI_2 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: HDMI #2 key.
TV_INPUT_HDMI_3 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: HDMI #3 key.
TV_INPUT_HDMI_4 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: HDMI #4 key.
TV_INPUT_VGA_1 - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: VGA #1 key.
TV_MEDIA_CONTEXT_MENU - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Media context menu key.
TV_NETWORK - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Toggle Network key.
TV_NUMBER_ENTRY - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Number entry key.
TV_POWER - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: TV power key.
TV_RADIO_SERVICE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Radio key.
TV_SATELLITE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Satellite key.
TV_SATELLITE_BS - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: BS key.
TV_SATELLITE_CS - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: CS key.
TV_SATELLITE_SERVICE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: BS/CS key.
TV_TELETEXT - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Teletext key.
TV_TERRESTRIAL_ANALOG - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Analog Terrestrial key.
TV_TERRESTRIAL_DIGITAL - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Digital Terrestrial key.
TV_TIMER_PROGRAMMING - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Timer programming key.
TV_ZOOM_MODE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Zoom mode key.
TVOS - Static variable in interface io.appium.java_client.remote.MobilePlatform
 

U

U - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'U' key.
UDID_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsUdidOption
 
uiAutomator() - Method in annotation type io.appium.java_client.pagefactory.AndroidBy
A String that can build an Android UiSelector or UiScrollable object.
uiAutomator() - Method in annotation type io.appium.java_client.pagefactory.AndroidFindBy
A String that can build an Android UiSelector or UiScrollable object.
uiAutomator() - Method in annotation type io.appium.java_client.pagefactory.iOSBy
It is an iOS UIAutomation string.
UIAUTOMATOR2_SERVER_INSTALL_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.android.options.server.SupportsUiautomator2ServerInstallTimeoutOption
 
UIAUTOMATOR2_SERVER_LAUNCH_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.android.options.server.SupportsUiautomator2ServerLaunchTimeoutOption
 
UIAUTOMATOR2_SERVER_READ_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.android.options.server.SupportsUiautomator2ServerReadTimeoutOption
 
UiAutomator2Options - Class in io.appium.java_client.android.options
https://github.com/appium/appium-uiautomator2-driver#capabilities
UiAutomator2Options() - Constructor for class io.appium.java_client.android.options.UiAutomator2Options
 
UiAutomator2Options(Map<String, ?>) - Constructor for class io.appium.java_client.android.options.UiAutomator2Options
 
UiAutomator2Options(Capabilities) - Constructor for class io.appium.java_client.android.options.UiAutomator2Options
 
UMTS - io.appium.java_client.android.NetworkSpeed
 
UNHANDLED_PROMPT_BEHAVIOR_OPTION - Static variable in interface io.appium.java_client.remote.options.SupportsUnhandledPromptBehaviorOption
 
UnhandledPromptBehavior - Enum in io.appium.java_client.remote.options
 
UNINSTALL_OTHER_PACKAGES_OPTION - Static variable in interface io.appium.java_client.android.options.app.SupportsUninstallOtherPackagesOption
 
UNKNOWN - io.appium.java_client.android.AndroidBatteryInfo.BatteryState
 
UNKNOWN - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Unknown key code.
UNKNOWN - io.appium.java_client.ios.IOSBatteryInfo.BatteryState
 
UNLOCK - Static variable in class io.appium.java_client.MobileCommand
Deprecated.
UNLOCK_KEY_OPTION - Static variable in interface io.appium.java_client.android.options.locking.SupportsUnlockKeyOption
 
UNLOCK_STRATEGY_OPTION - Static variable in interface io.appium.java_client.android.options.locking.SupportsUnlockStrategyOption
 
UNLOCK_SUCCESS_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.android.options.locking.SupportsUnlockSuccessTimeoutOption
 
UNLOCK_TYPE_OPTION - Static variable in interface io.appium.java_client.android.options.locking.SupportsUnlockTypeOption
 
unlockCommand() - Static method in class io.appium.java_client.android.AndroidMobileCommandHelper
Deprecated.
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
Deprecated.
This helper is deprecated and will be removed in future versions.
unpackObjectFromSearchContext(SearchContext, Class<T>) - Static method in class io.appium.java_client.pagefactory.utils.WebDriverUnpackUtility
This method extracts an instance of the given interface from the given SearchContext.
unpackWebDriverFromSearchContext(SearchContext) - Static method in class io.appium.java_client.pagefactory.utils.WebDriverUnpackUtility
This method extract an instance of WebDriver from the given SearchContext.
UNPLUGGED - io.appium.java_client.ios.IOSBatteryInfo.BatteryState
 
UNREGISTERED - io.appium.java_client.android.GsmVoiceState
 
UNSET - Static variable in interface io.appium.java_client.proxy.MethodCallListener
 
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_IMAGE_ELEMENT_POSITION - io.appium.java_client.Setting
 
UPDATED_WDA_BUNDLE_ID_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsUpdatedWdaBundleIdOption
 
uploadOptions() - Static method in class io.appium.java_client.screenrecording.ScreenRecordingUploadOptions
 
URL - io.appium.java_client.clipboard.ClipboardContentType
 
USE_ANY - io.appium.java_client.pagefactory.bys.builder.HowToUseSelectors
 
USE_DRIVERS - io.appium.java_client.service.local.flags.GeneralServerFlag
A comma-separated list of installed driver names that should be active for this server.
USE_JSON_SOURCE_OPTION - Static variable in interface io.appium.java_client.ios.options.other.SupportsUseJsonSourceOption
 
USE_KEYSTORE_OPTION - Static variable in interface io.appium.java_client.android.options.signing.SupportsKeystoreOptions
 
USE_NATIVE_CACHING_STRATEGY_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsUseNativeCachingStrategyOption
 
USE_NEW_WDA_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsUseNewWdaOption
 
USE_ONE - io.appium.java_client.pagefactory.bys.builder.HowToUseSelectors
 
USE_PLUGINS - io.appium.java_client.service.local.flags.GeneralServerFlag
Plugins are little programs which can be added to an Appium installation and activated, for the purpose of extending or modifying the behavior of pretty much any aspect of Appium.
USE_PREBUILT_WDA_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsUsePrebuiltWdaOption
 
USE_SIMPLE_BUILD_TEST_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsUseSimpleBuildTestOption
 
USE_SYSTEM_EXECUTABLE - Static variable in interface io.appium.java_client.chromium.options.SupportsUseSystemExecutableOption
 
USE_XCTESTRUN_FILE_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsUseXctestrunFileOption
 
useContent(ContentType) - Method in class io.appium.java_client.pagefactory.bys.ContentMappedBy
This method sets required content type for the further searching.
useJSONSource() - Method in interface io.appium.java_client.ios.options.other.SupportsUseJsonSourceOption
Enforces getting JSON source from WDA and transform it to XML on the Appium server side.
useNewWDA() - Method in interface io.appium.java_client.ios.options.wda.SupportsUseNewWdaOption
Enforce uninstall of any existing WebDriverAgent app on the device under test.
usePrebuiltWda() - Method in interface io.appium.java_client.ios.options.wda.SupportsUsePrebuiltWdaOption
Enforce to skip the build phase of running the WDA app.
USER_AGENT - Static variable in class io.appium.java_client.internal.filters.AppiumUserAgentFilter
A default User Agent name for Appium Java client.
USER_PROFILE_OPTION - Static variable in interface io.appium.java_client.android.options.other.SupportsUserProfileOption
 
useSimpleBuildTest() - Method in interface io.appium.java_client.ios.options.wda.SupportsUseSimpleBuildTestOption
Enforce usage of simple build test.
useXctestrunFile() - Method in interface io.appium.java_client.ios.options.wda.SupportsUseXctestrunFileOption
Enforce usage of .xctestrun file to launch WDA.
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

V - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'V' key.
value() - Method in annotation type io.appium.java_client.pagefactory.AndroidFindAll
It is a set of AndroidBy strategies which may be used to find the target element.
value() - Method in annotation type io.appium.java_client.pagefactory.AndroidFindByAllSet
An array which builds a sequence of the chained searching for elements or a set of possible locators.
value() - Method in annotation type io.appium.java_client.pagefactory.AndroidFindByChainSet
An array of which builds a sequence of the chained searching for elements or a set of possible locators.
value() - Method in annotation type io.appium.java_client.pagefactory.AndroidFindBys
It is a set of AndroidBy strategies which build the chain of the searching for the target element.
value() - Method in annotation type io.appium.java_client.pagefactory.AndroidFindBySet
An array of which builds a sequence of the chained searching for elements or a set of possible locators.
value() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITFindAll
It is a set of iOSXCUITBy strategies which may be used to find the target element.
value() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITFindByAllSet
An array of which builds a sequence of the chained searching for elements or a set of possible locators.
value() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITFindByChainSet
An array of which builds a sequence of the chained searching for elements or a set of possible locators.
value() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITFindBys
It is a set of iOSXCUITBy strategies which build the chain of the searching for the target element.
value() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITFindBySet
An array of which builds a sequence of the chained searching for elements or a set of possible locators.
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.driverscripts.ScriptType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum io.appium.java_client.gecko.options.Verbosity
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.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.options.simulator.PasteboardSyncState
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.remote.options.UnhandledPromptBehavior
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.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.driverscripts.ScriptType
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.gecko.options.Verbosity
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.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.options.simulator.PasteboardSyncState
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.remote.options.UnhandledPromptBehavior
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.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.
VERBOSE - Static variable in interface io.appium.java_client.chromium.options.SupportsVerboseOption
 
Verbosity - Enum in io.appium.java_client.gecko.options
 
VERBOSITY_OPTION - Static variable in interface io.appium.java_client.gecko.options.SupportsVerbosityOption
 
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.
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.
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.
VERSION_KEY - Static variable in class io.appium.java_client.internal.filters.AppiumUserAgentFilter
 
VIRTUAL_HARD_KEY - io.appium.java_client.android.nativekey.KeyEventFlag
This key event was generated by a virtual (on-screen) hard key area.
VOICE_ASSIST - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Voice Assist key.
VOLUME_DOWN - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Volume Down key.
VOLUME_MUTE - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Volume Mute key.
VOLUME_UP - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Volume Up key.

W

W - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'W' key.
W3CCapabilityKeys - Class in io.appium.java_client.remote.options
 
W3CCapabilityKeys() - Constructor for class io.appium.java_client.remote.options.W3CCapabilityKeys
 
WAIT_ACTION_ACKNOWLEDGMENT_TIMEOUT - io.appium.java_client.Setting
 
WAIT_FOR_IDLE_TIMEOUT - io.appium.java_client.Setting
 
WAIT_FOR_IDLE_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsWaitForIdleTimeoutOption
 
WAIT_FOR_QUIESCENCE_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsWaitForQuiescenceOption
 
WAIT_FOR_SELECTOR_TIMEOUT - io.appium.java_client.Setting
 
WAIT_SCROLL_ACKNOWLEDGMENT_TIMEOUT - io.appium.java_client.Setting
 
waitAction() - Method in class io.appium.java_client.TouchAction
Deprecated.
A wait action, used as a NOP in multi-chaining.
waitAction(WaitOptions) - Method in class io.appium.java_client.TouchAction
Deprecated.
Waits for specified amount of time to pass before continue to next touch action.
waitOptions(Duration) - Static method in class io.appium.java_client.touch.WaitOptions
Creates and instance of WaitOptions.
WaitOptions - Class in io.appium.java_client.touch
 
WaitOptions() - Constructor for class io.appium.java_client.touch.WaitOptions
 
waitUntilAvailable(URL, Duration) - Method in class io.appium.java_client.service.local.AppiumServerAvailabilityChecker
Verifies a possibility of establishing a connection to a running Appium server.
WAKEUP - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Wakeup key.
WDA_BASE_URL_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsWdaBaseUrlOption
 
WDA_CONNECTION_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsWdaConnectionTimeoutOption
 
WDA_EVENTLOOP_IDLE_DELAY_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsWdaEventloopIdleDelayOption
 
WDA_LAUNCH_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsWdaLaunchTimeoutOption
 
WDA_LOCAL_PORT_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsWdaLocalPortOption
 
WDA_STARTUP_RETRIES_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsWdaStartupRetriesOption
 
WDA_STARTUP_RETRY_INTERVAL_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsWdaStartupRetryIntervalOption
 
WEB_DRIVER_AGENT_MAC_URL_OPTION - Static variable in interface io.appium.java_client.mac.options.SupportsWebDriverAgentMacUrlOption
 
WEB_DRIVER_AGENT_URL_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsWebDriverAgentUrlOption
 
WEB_HOOK - io.appium.java_client.service.local.flags.GeneralServerFlag
Also send log output to this HTTP listener.
WEBDRIVERIO - io.appium.java_client.driverscripts.ScriptType
 
WebDriverUnpackUtility - Class in io.appium.java_client.pagefactory.utils
 
WEBKIT_DEBUG_PROXY_PORT - io.appium.java_client.service.local.flags.IOSServerFlag
Local port used for communication with ios-webkit-debug-proxy.
WEBKIT_RESPONSE_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.ios.options.simulator.SupportsWebkitResponseTimeoutOption
 
WEBKIT_RESPONSE_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsWebkitResponseTimeoutOption
 
WEBKIT_WEB_RTC_OPTION - Static variable in interface io.appium.java_client.safari.options.SupportsWebkitWebrtcOption
 
WebrtcData - Class in io.appium.java_client.safari.options
 
WebrtcData() - Constructor for class io.appium.java_client.safari.options.WebrtcData
 
WebrtcData(Map<String, Object>) - Constructor for class io.appium.java_client.safari.options.WebrtcData
 
WEBVIEW_CONNECT_RETRIES_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsWebviewConnectRetriesOption
 
WEBVIEW_CONNECT_TIMEOUT_OPTION - Static variable in interface io.appium.java_client.ios.options.webview.SupportsWebviewConnectTimeoutOption
 
WEBVIEW_DEVTOOLS_PORT_OPTION - Static variable in interface io.appium.java_client.android.options.context.SupportsWebviewDevtoolsPortOption
 
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
 
WidgetInterceptor - Class in io.appium.java_client.pagefactory
 
WidgetInterceptor(CacheableLocator, WeakReference<WebDriver>, WeakReference<WebElement>, Map<ContentType, Constructor<? extends Widget>>, Duration) - Constructor for class io.appium.java_client.pagefactory.WidgetInterceptor
Proxy interceptor class for widgets.
WidgetListInterceptor - Class in io.appium.java_client.pagefactory
 
WidgetListInterceptor(CacheableLocator, WeakReference<WebDriver>, Map<ContentType, Constructor<? extends Widget>>, Class<? extends Widget>, Duration) - Constructor for class io.appium.java_client.pagefactory.WidgetListInterceptor
Proxy interceptor class for lists of widgets.
WIFI_MASK - Static variable in class io.appium.java_client.android.connection.ConnectionState
 
WINDOW - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Window key.
WINDOWS - Static variable in interface io.appium.java_client.remote.AutomationName
 
WINDOWS - Static variable in interface io.appium.java_client.remote.MobilePlatform
 
windowsAutomation() - Method in annotation type io.appium.java_client.pagefactory.OverrideWidget
This property is designed for Windows native content.
WindowsDriver - Class in io.appium.java_client.windows
 
WindowsDriver(AppiumClientConfig, Capabilities) - Constructor for class io.appium.java_client.windows.WindowsDriver
Creates a new instance based on the given ClientConfig and capabilities.
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(URL) - 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(Capabilities) - Constructor for class io.appium.java_client.windows.WindowsDriver
 
WindowsDriver(ClientConfig, Capabilities) - Constructor for class io.appium.java_client.windows.WindowsDriver
Creates a new instance based on the given ClientConfig and capabilities.
WindowsDriver(HttpClient.Factory, Capabilities) - Constructor for class io.appium.java_client.windows.WindowsDriver
 
WindowsDriver(HttpCommandExecutor, Capabilities) - Constructor for class io.appium.java_client.windows.WindowsDriver
 
WindowsOptions - Class in io.appium.java_client.windows.options
WindowsOptions() - Constructor for class io.appium.java_client.windows.options.WindowsOptions
 
WindowsOptions(Map<String, ?>) - Constructor for class io.appium.java_client.windows.options.WindowsOptions
 
WindowsOptions(Capabilities) - Constructor for class io.appium.java_client.windows.options.WindowsOptions
 
WindowsStartScreenRecordingOptions - Class in io.appium.java_client.windows
 
WindowsStartScreenRecordingOptions() - Constructor for class io.appium.java_client.windows.WindowsStartScreenRecordingOptions
 
WindowsStopScreenRecordingOptions - Class in io.appium.java_client.windows
 
WindowsStopScreenRecordingOptions() - Constructor for class io.appium.java_client.windows.WindowsStopScreenRecordingOptions
 
withAction(String) - Method in class io.appium.java_client.android.options.app.IntentOptions
An intent action name.
withAdditionalAndroidTestDependencies(List<String>) - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Set a non-empty array of dependent module names with their versions.
withAdditionalAppDependencies(List<String>) - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Set a non-empty array of dependent module names with their versions.
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.
withAltitude(double) - Method in class io.appium.java_client.android.geolocation.AndroidGeoLocation
Sets geo altitude value.
withAndroidGradlePluginVersion(String) - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Set Gradle plugin version.
withAppiumJS(File) - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
Sets an executable appium.js.
withAppPermissions(String, Map<String, String>) - Method in class io.appium.java_client.ios.options.simulator.Permissions
Since Xcode SDK 11.4 Apple provides native APIs to interact with application settings.
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.
withAudioInput(String) - Method in class io.appium.java_client.windows.WindowsStartScreenRecordingOptions
If provided then the given audio input will be used to record the computer audio along with the desktop video.
withAuthCredentials(String, String) - Method in class io.appium.java_client.screenrecording.ScreenRecordingUploadOptions
Sets the credentials for remote ftp/http authentication (if needed).
withBasePath(String) - Method in class io.appium.java_client.service.local.AppiumDriverLocalService
 
withBitRate(int) - Method in class io.appium.java_client.android.AndroidStartScreenRecordingOptions
The video bit rate for the video, in megabits per second.
withBrowserName(String) - Method in interface io.appium.java_client.remote.options.SupportsBrowserNameOption
Set the browser name to use.
withBuildToolsVersion(String) - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Set Android build tools version to compile the server with.
withCapabilities(Capabilities) - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
Adds capabilities.
withCapabilities(Capabilities, boolean) - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
Adds capabilities.
withCategories(String) - Method in class io.appium.java_client.android.options.app.IntentOptions
Set intent categories.
withClassName(String) - Method in class io.appium.java_client.android.options.app.IntentOptions
The name of a class inside of the application package that will be used as the component for this Intent.
withCommand(String) - Method in class io.appium.java_client.mac.options.AppleScriptData
Allows to provide a single-line AppleScript.
withCommand(String) - Method in class io.appium.java_client.remote.options.SystemScript
 
withCommand(String) - Method in class io.appium.java_client.windows.options.PowerShellData
Allows to provide a single-line PowerShell script.
withCommandTimeout(String, Duration) - Method in class io.appium.java_client.ios.options.other.CommandTimeouts
Sets the timeout for the particular Appium command that is proxied to WDA.
withCompileSdkVersion(String) - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Set Android SDK version to compile the server for.
withComponent(String) - Method in class io.appium.java_client.android.options.app.IntentOptions
Set intent component name with package name prefix to create an explicit intent.
withComposeVersion(String) - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Set the version of the included androidx.compose.ui components to compile the server for.
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.
withCoordinates(Point) - 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(Point) - Method in class io.appium.java_client.touch.offset.PointOption
It defines x and y coordinates.
withCountry(String) - Method in class io.appium.java_client.android.options.localization.AppLocale
Allows to set a country identifier.
withData(String) - Method in class io.appium.java_client.android.options.app.IntentOptions
Set an intent data URI.
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.
withDefaultCommandTimeout(Duration) - Method in class io.appium.java_client.ios.options.other.CommandTimeouts
Sets the default timeout for all Appium commands that are proxied to WDA.
withDetectorName(FeatureDetector) - Method in class io.appium.java_client.imagecomparison.FeaturesMatchingOptions
Sets the detector name for features matching algorithm.
withDeviceId(Integer) - Method in class io.appium.java_client.mac.Mac2StartScreenRecordingOptions
Screen device index to use for the recording.
withDisableIceCandidateFiltering(boolean) - Method in class io.appium.java_client.safari.options.WebrtcData
To protect a user's privacy, Safari normally filters out WebRTC ICE candidates that correspond to internal network addresses when capture devices are not in use.
withDisableInsecureMediaCapture(boolean) - Method in class io.appium.java_client.safari.options.WebrtcData
Normally, Safari refuses to allow media capture over insecure connections.
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.
withEcn(Map<String, String>) - Method in class io.appium.java_client.android.options.app.IntentOptions
Intent component name parameters.
withEf(Map<String, Float>) - Method in class io.appium.java_client.android.options.app.IntentOptions
Intent float parameters.
withEfa(Map<String, List<Float>>) - Method in class io.appium.java_client.android.options.app.IntentOptions
Intent float array parameters.
withEi(Map<String, Integer>) - Method in class io.appium.java_client.android.options.app.IntentOptions
Intent integer parameters.
withEia(Map<String, List<Integer>>) - Method in class io.appium.java_client.android.options.app.IntentOptions
Intent integer array parameters.
withEl(Map<String, Long>) - Method in class io.appium.java_client.android.options.app.IntentOptions
Intent long parameters.
withEla(Map<String, List<Long>>) - Method in class io.appium.java_client.android.options.app.IntentOptions
Intent long array parameters.
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.
withEs(Map<String, String>) - Method in class io.appium.java_client.android.options.app.IntentOptions
Intent string parameters.
withEsn(List<String>) - Method in class io.appium.java_client.android.options.app.IntentOptions
Intent null parameters.
withEu(Map<String, String>) - Method in class io.appium.java_client.android.options.app.IntentOptions
Intent URI-data parameters.
withEz(Map<String, Boolean>) - Method in class io.appium.java_client.android.options.app.IntentOptions
Intent boolean parameters.
withFileFieldName(String) - Method in class io.appium.java_client.screenrecording.ScreenRecordingUploadOptions
Sets the form field name containing the binary payload in multipart/form-data requests.
withFilter(Filter) - Method in class io.appium.java_client.AppiumClientConfig
 
withFlag(KeyEventFlag) - Method in class io.appium.java_client.android.nativekey.KeyEvent
Adds the flag.
withFlags(String) - Method in class io.appium.java_client.android.options.app.IntentOptions
Comma-separated string of intent flag names.
withFormFields(Map<String, Object>) - Method in class io.appium.java_client.screenrecording.ScreenRecordingUploadOptions
Sets additional form fields in multipart/form-data requests.
withFps(int) - Method in class io.appium.java_client.ios.IOSStartScreenRecordingOptions
The Frames Per Second rate of the recorded video.
withFps(int) - Method in class io.appium.java_client.mac.Mac2StartScreenRecordingOptions
The count of frames per second in the resulting video.
withFps(int) - Method in class io.appium.java_client.windows.WindowsStartScreenRecordingOptions
The count of frames per second in the resulting video.
withGoodMatchesFactor(int) - Method in class io.appium.java_client.imagecomparison.FeaturesMatchingOptions
Sets the maximum count of "good" matches (e.
withGradleVersion(String) - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Set Gradle version.
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+.
withHeaders(Map<String, String>) - Method in class io.appium.java_client.screenrecording.ScreenRecordingUploadOptions
Sets additional headers in multipart/form-data requests.
withHttpMethod(ScreenRecordingUploadOptions.RequestMethod) - Method in class io.appium.java_client.screenrecording.ScreenRecordingUploadOptions
Sets the method name for http(s) upload.
withIntFlags(String) - Method in class io.appium.java_client.android.options.app.IntentOptions
Single-string value, which represents intent flags set encoded into an integer.
withIPAddress(String) - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
 
withJvmTarget(String) - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Set the target version of the generated JVM bytecode as a string.
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.
withKotlinVersion(String) - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Kotlin version to compile the server for.
withLanguage(String) - Method in class io.appium.java_client.android.options.localization.AppLocale
Language identifier.
withLatitude(double) - Method in class io.appium.java_client.android.geolocation.AndroidGeoLocation
Sets geo latitude value.
withLaunchDisplayId(int) - Method in class io.appium.java_client.android.options.app.ActivityOptions
Display id which you want to assign to launch the main app activity on.
withLogFile(File) - Method in class io.appium.java_client.service.local.AppiumServiceBuilder
Configures the appium server to write log to the given file.
withLongitude(double) - Method in class io.appium.java_client.android.geolocation.AndroidGeoLocation
Sets geo longitude value.
withMatchFunc(MatchingFunction) - Method in class io.appium.java_client.imagecomparison.FeaturesMatchingOptions
Sets the name of the matching function.
withMatchNeighbourThreshold(int) - Method in class io.appium.java_client.imagecomparison.OccurrenceMatchingOptions
The pixel distance between matches we consider to be part of the same template match.
withMetaModifier(KeyEventMetaModifier) - Method in class io.appium.java_client.android.nativekey.KeyEvent
Adds the meta modifier.
withMinSdk(int) - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Set the minimum Android SDK version to compile the server for.
withPollDelay(Duration) - Method in class io.appium.java_client.AppiumFluentWait
Sets how long to wait before starting to evaluate condition to be true.
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.
withPreset(String) - Method in class io.appium.java_client.mac.Mac2StartScreenRecordingOptions
A preset is a collection of options that will provide a certain encoding speed to compression ratio.
withPreset(String) - Method in class io.appium.java_client.windows.WindowsStartScreenRecordingOptions
A preset is a collection of options that will provide a certain encoding speed to compression ratio.
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).
withRetries() - Method in class io.appium.java_client.AppiumClientConfig
 
withSatellites(int) - Method in class io.appium.java_client.android.geolocation.AndroidGeoLocation
Sets the number of geo satellites being tracked.
withScript(String) - Method in class io.appium.java_client.mac.options.AppleScriptData
Allows to provide a multiline AppleScript.
withScript(String) - Method in class io.appium.java_client.remote.options.SystemScript
 
withScript(String) - Method in class io.appium.java_client.windows.options.PowerShellData
Allows to provide a multiline PowerShell script.
withScriptType(ScriptType) - Method in class io.appium.java_client.driverscripts.ScriptOptions
Sets the script type.
withSourceCompatibility(String) - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Set the minimum version of JVM the project sources are compatible with.
withSpeed(double) - Method in class io.appium.java_client.android.geolocation.AndroidGeoLocation
Sets the movement speed.
withTapsCount(int) - Method in class io.appium.java_client.touch.TapOptions
Set the count of taps to perform.
withTargetCompatibility(String) - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Set the target version of JVM the project sources are compatible with.
withTargetSdk(int) - Method in class io.appium.java_client.android.options.server.EspressoBuildConfig
Set the target Android SDK version to compile the server for.
withThreshold(double) - Method in class io.appium.java_client.imagecomparison.OccurrenceMatchingOptions
At what normalized threshold to reject an occurrence.
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.mac.Mac2StartScreenRecordingOptions
The maximum recording time.
withTimeLimit(Duration) - Method in class io.appium.java_client.screenrecording.BaseStartScreenRecordingOptions
The maximum recording time.
withTimeLimit(Duration) - Method in class io.appium.java_client.windows.WindowsStartScreenRecordingOptions
The maximum recording time.
withTimeout(long) - Method in class io.appium.java_client.driverscripts.ScriptOptions
Sets the script execution timeout.
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
 
withType(String) - Method in class io.appium.java_client.android.options.app.IntentOptions
Intent MIME type.
withUploadOptions(ScreenRecordingUploadOptions) - Method in class io.appium.java_client.android.AndroidStartScreenRecordingOptions
Upload options set for the recorded screen capture.
withUploadOptions(ScreenRecordingUploadOptions) - Method in class io.appium.java_client.ios.IOSStartScreenRecordingOptions
Upload options set for the recorded screen capture.
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.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.
withVariant(String) - Method in class io.appium.java_client.android.options.localization.AppLocale
Allows to set an optional language variant value.
withVideoFilter(String) - Method in class io.appium.java_client.mac.Mac2StartScreenRecordingOptions
The video filter spec to apply for ffmpeg.
withVideoFilter(String) - Method in class io.appium.java_client.windows.WindowsStartScreenRecordingOptions
The video filter spec to apply for ffmpeg.
withVideoFilters(String) - Method in class io.appium.java_client.ios.IOSStartScreenRecordingOptions
The FFMPEG video filters to apply.
withVideoQuality(IOSStartScreenRecordingOptions.VideoQuality) - Method in class io.appium.java_client.ios.IOSStartScreenRecordingOptions
The video encoding quality (low, medium, high, photo - defaults to medium).
withVideoScale(String) - Method in class io.appium.java_client.ios.IOSStartScreenRecordingOptions
The scaling value to apply.
withVideoSize(String) - Method in class io.appium.java_client.android.AndroidStartScreenRecordingOptions
The video size of the generated media file.
withVideoType(String) - Method in class io.appium.java_client.ios.IOSStartScreenRecordingOptions
The video codec type used for encoding of the recorded screen capture.
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.

X

X - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'X' key.
XCODE_ORG_ID_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsXcodeCertificateOptions
 
XCODE_SIGNING_ID_OPTION - Static variable in interface io.appium.java_client.ios.options.wda.SupportsXcodeCertificateOptions
 
XcodeCertificate - Class in io.appium.java_client.ios.options.wda
 
XcodeCertificate(String) - Constructor for class io.appium.java_client.ios.options.wda.XcodeCertificate
 
XcodeCertificate(String, String) - Constructor for class io.appium.java_client.ios.options.wda.XcodeCertificate
 
XCUITestOptions - Class in io.appium.java_client.ios.options
https://github.com/appium/appium-xcuitest-driver#capabilities
XCUITestOptions() - Constructor for class io.appium.java_client.ios.options.XCUITestOptions
 
XCUITestOptions(Map<String, ?>) - Constructor for class io.appium.java_client.ios.options.XCUITestOptions
 
XCUITestOptions(Capabilities) - Constructor for class io.appium.java_client.ios.options.XCUITestOptions
 
xpath() - Method in annotation type io.appium.java_client.pagefactory.AndroidBy
It is a xpath to the target element.
xpath() - Method in annotation type io.appium.java_client.pagefactory.AndroidFindBy
It is a xpath to the target element.
xpath() - Method in annotation type io.appium.java_client.pagefactory.iOSBy
It is a xpath to the target element.
xpath() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITBy
It is a xpath to the target element.
xpath() - Method in annotation type io.appium.java_client.pagefactory.iOSXCUITFindBy
It is a xpath to the target element.

Y

Y - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'Y' key.
YEN - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Japanese Yen key.
YOUI_ENGINE - Static variable in interface io.appium.java_client.remote.AutomationName
 

Z

Z - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: 'Z' key.
ZENKAKU_HANKAKU - io.appium.java_client.android.nativekey.AndroidKey
Key code constant: Japanese full-width / half-width key.
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 Z 
All Classes All Packages