io.appium.java_client.remote

Interface IOSMobileCapabilityType

All Superinterfaces:

org.openqa.selenium.remote.CapabilityType

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

The list of iOS-specific capabilities. Read: https://github.com/appium/appium/blob/1.5/docs/en/writing-running-appium/caps.md#ios-only

Nested Class Summary

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

org.openqa.selenium.remote.CapabilityType.ForSeleniumServer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALLOW_TOUCHID_ENROLL Enrolls simulator for touch id.
static java.lang.String	APP_NAME The display name of the application under test.
static java.lang.String	AUTO_ACCEPT_ALERTS Accept all iOS alerts automatically if they pop up.
static java.lang.String	AUTO_DISMISS_ALERTS Dismiss all iOS alerts automatically if they pop up.
static java.lang.String	BUNDLE_ID Bundle ID of the app under test.
static java.lang.String	CALENDAR_FORMAT (Sim-only) Calendar format to set for the iOS Simulator.
static java.lang.String	COMMAND_TIMEOUTS Custom timeout(s) in milliseconds for WDA backend commands execution.
static java.lang.String	CONNECT_HARDWARE_KEYBOARD Set this option to true in order to enable hardware keyboard in Simulator.
static java.lang.String	CUSTOM_SSL_CERT Capability to pre-authorize a specific SSL cert in the iOS trust store.
static java.lang.String	INTER_KEY_DELAY The delay, in ms, between keystrokes sent to an element when typing.
static java.lang.String	IOS_INSTALL_PAUSE Time in milliseconds to pause between installing the application and starting WebDriverAgent on the device.
static java.lang.String	KEEP_KEY_CHAINS (Sim-only) Whether to keep keychains (Library/Keychains) when appium session is started/finished.
static java.lang.String	KEYCHAIN_PASSWORD Password for unlocking keychain specified in keychainPath.
static java.lang.String	KEYCHAIN_PATH Full path to the private development key exported from the system keychain.
static java.lang.String	LAUNCH_TIMEOUT Amount of time in ms to wait for instruments before assuming it hung and failing the session.
static java.lang.String	LOCALIZABLE_STRINGS_DIR Where to look for localizable strings.
static java.lang.String	LOCATION_SERVICES_AUTHORIZED (Sim-only) Set location services to be authorized or not authorized for app via plist, so that location services alert doesn't pop up.
static java.lang.String	LOCATION_SERVICES_ENABLED (Sim-only) Force location services to be either on or off.
static java.lang.String	MAX_TYPING_FREQUENCY Maximum frequency of keystrokes for typing and clear.
static java.lang.String	NATIVE_INSTRUMENTS_LIB Use native intruments lib (ie disable instruments-without-delay).
static java.lang.String	NATIVE_WEB_TAP (Sim-only) Enable "real", non-javascript-based web taps in Safari.
static java.lang.String	PREVENT_WDAATTACHMENTS Sets read only permissons to Attachments subfolder of WebDriverAgent root inside Xcode's DerivedData.
static java.lang.String	PROCESS_ARGUMENTS Arguments to pass to the AUT using instruments.
static java.lang.String	RESET_ON_SESSION_START_ONLY Whether to perform reset on test session finish (false) or not (true).
static java.lang.String	SAFARI_ALLOW_POPUPS (Sim-only) Allow javascript to open new windows in Safari.
static java.lang.String	SAFARI_IGNORE_FRAUD_WARNING (Sim-only) Prevent Safari from showing a fraudulent website warning.
static java.lang.String	SAFARI_INITIAL_URL (Sim-only) (>= 8.1) Initial safari url, default is a local welcome page.
static java.lang.String	SAFARI_OPEN_LINKS_IN_BACKGROUND (Sim-only) Whether Safari should allow links to open in new windows.
static java.lang.String	SCALE_FACTOR The capability to direct Appium to set the simulator scale.
static java.lang.String	SCREENSHOT_WAIT_TIMEOUT Max timeout in sec to wait for a screenshot to be generated. default: 10.
static java.lang.String	SEND_KEY_STRATEGY strategy to use to type test into a test field.
static java.lang.String	SHOULD_USE_SINGLETON_TESTMANAGER Use default proxy for test management within WebDriverAgent.
static java.lang.String	SHOW_IOS_LOG Whether to show any logs captured from a device in the appium logs.
static java.lang.String	SHOW_XCODE_LOG Whether to display the output of the Xcode command used to run the tests.If this is true, there will be lots of extra logging at startup.
static java.lang.String	SIMPLE_ISVISIBLE_CHECK Use native methods for determining visibility of elements.
static java.lang.String	START_IWDP Set this to true if you want to start ios_webkit_debug proxy server automatically for accessing webviews on iOS.
static java.lang.String	TAP_WITH_SHORT_PRESS_DURATION The desired capability to specify a length for tapping, if the regular tap is too long for the app under test.
static java.lang.String	UPDATE_WDA_BUNDLEID Bundle id to update WDA to before building and launching on real devices.
static java.lang.String	USE_CARTHAGE_SSL Use SSL to download dependencies for WebDriverAgent.
static java.lang.String	USE_NEW_WDA Forces uninstall of any existing WebDriverAgent app on device.
static java.lang.String	USE_PREBUILT_WDA Skips the build phase of running the WDA app.
static java.lang.String	WAIT_FOR_APP_SCRIPT The ios automation script used to determined if the app has been launched, by default the system wait for the page source not to be empty.
static java.lang.String	WDA_CONNECTION_TIMEOUT Timeout, in ms, for waiting for a resonse from WebDriverAgent.
static java.lang.String	WDA_LAUNCH_TIMEOUT Time, in ms, to wait for WebDriverAgewnt to be pingable.
static java.lang.String	WDA_LOCAL_PORT This value if specified, will be used to forward traffic from Mac host to real ios devices over USB.
static java.lang.String	WDA_STARTUP_RETRIES Number of times to try to build and launch WebDriverAgent onto the device.
static java.lang.String	WDA_STARTUP_RETRY_INTERVAL Time, in ms, to wait between tries to build and launch WebDriverAgent.
static java.lang.String	WEB_DRIVER_AGENT_URL Appium will connect to an existing WebDriverAgent, instance at this URL instead of starting a new one.
static java.lang.String	WEBVIEW_CONNECT_RETRIES Number of times to send connection message to remote debugger, to get webview.
static java.lang.String	XCODE_CONFIG_FILE Full path to an optional Xcode configuration file that specifies the code signing identity and team for running the WebDriverAgent on the real device.
static java.lang.String	XCODE_ORG_ID Apple developer team identifier string.
static java.lang.String	XCODE_SIGNING_ID String representing a signing certificate.

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

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

Field Detail

CALENDAR_FORMAT

static final java.lang.String CALENDAR_FORMAT

(Sim-only) Calendar format to set for the iOS Simulator.

See Also:

Constant Field Values

BUNDLE_ID

static final java.lang.String BUNDLE_ID

Bundle ID of the app under test. Useful for starting an app on a real device or for using other caps which require the bundle ID during test startup. To run a test on a real device using the bundle ID, you may omit the 'app' capability, but you must provide 'udid'.

See Also:

Constant Field Values

LAUNCH_TIMEOUT

static final java.lang.String LAUNCH_TIMEOUT

Amount of time in ms to wait for instruments before assuming it hung and failing the session.

See Also:

Constant Field Values

LOCATION_SERVICES_ENABLED

static final java.lang.String LOCATION_SERVICES_ENABLED

(Sim-only) Force location services to be either on or off. Default is to keep current sim setting.

See Also:

Constant Field Values

LOCATION_SERVICES_AUTHORIZED

static final java.lang.String LOCATION_SERVICES_AUTHORIZED

(Sim-only) Set location services to be authorized or not authorized for app via plist, so that location services alert doesn't pop up. Default is to keep current sim setting. Note that if you use this setting you MUST also use the bundleId capability to send in your app's bundle ID.

See Also:

Constant Field Values

AUTO_ACCEPT_ALERTS

static final java.lang.String AUTO_ACCEPT_ALERTS

Accept all iOS alerts automatically if they pop up. This includes privacy access permission alerts (e.g., location, contacts, photos). Default is false.

See Also:

Constant Field Values

AUTO_DISMISS_ALERTS

static final java.lang.String AUTO_DISMISS_ALERTS

Dismiss all iOS alerts automatically if they pop up. This includes privacy access permission alerts (e.g., location, contacts, photos). Default is false.

See Also:

Constant Field Values

NATIVE_INSTRUMENTS_LIB

static final java.lang.String NATIVE_INSTRUMENTS_LIB

Use native intruments lib (ie disable instruments-without-delay).

See Also:

Constant Field Values

NATIVE_WEB_TAP

static final java.lang.String NATIVE_WEB_TAP

(Sim-only) Enable "real", non-javascript-based web taps in Safari. Default: false. Warning: depending on viewport size/ratio this might not accurately tap an element.

See Also:

Constant Field Values

SAFARI_INITIAL_URL

static final java.lang.String SAFARI_INITIAL_URL

(Sim-only) (>= 8.1) Initial safari url, default is a local welcome page.

See Also:

Constant Field Values

SAFARI_ALLOW_POPUPS

static final java.lang.String SAFARI_ALLOW_POPUPS

(Sim-only) Allow javascript to open new windows in Safari. Default keeps current sim setting.

See Also:

Constant Field Values

SAFARI_IGNORE_FRAUD_WARNING

static final java.lang.String SAFARI_IGNORE_FRAUD_WARNING

(Sim-only) Prevent Safari from showing a fraudulent website warning. Default keeps current sim setting.

See Also:

Constant Field Values

SAFARI_OPEN_LINKS_IN_BACKGROUND

static final java.lang.String SAFARI_OPEN_LINKS_IN_BACKGROUND

(Sim-only) Whether Safari should allow links to open in new windows. Default keeps current sim setting.

See Also:

Constant Field Values

KEEP_KEY_CHAINS

static final java.lang.String KEEP_KEY_CHAINS

(Sim-only) Whether to keep keychains (Library/Keychains) when appium session is started/finished.

See Also:

Constant Field Values

LOCALIZABLE_STRINGS_DIR

static final java.lang.String LOCALIZABLE_STRINGS_DIR

Where to look for localizable strings. Default en.lproj.

See Also:

Constant Field Values

PROCESS_ARGUMENTS

static final java.lang.String PROCESS_ARGUMENTS

Arguments to pass to the AUT using instruments.

See Also:

Constant Field Values

INTER_KEY_DELAY

static final java.lang.String INTER_KEY_DELAY

The delay, in ms, between keystrokes sent to an element when typing.

See Also:

Constant Field Values

SHOW_IOS_LOG

static final java.lang.String SHOW_IOS_LOG

Whether to show any logs captured from a device in the appium logs. Default false.

See Also:

Constant Field Values

SEND_KEY_STRATEGY

static final java.lang.String SEND_KEY_STRATEGY

strategy to use to type test into a test field. Simulator default: oneByOne. Real device default: grouped.

See Also:

Constant Field Values

SCREENSHOT_WAIT_TIMEOUT

static final java.lang.String SCREENSHOT_WAIT_TIMEOUT

Max timeout in sec to wait for a screenshot to be generated. default: 10.

See Also:

Constant Field Values

WAIT_FOR_APP_SCRIPT

static final java.lang.String WAIT_FOR_APP_SCRIPT

The ios automation script used to determined if the app has been launched, by default the system wait for the page source not to be empty. The result must be a boolean.

See Also:

Constant Field Values

WEBVIEW_CONNECT_RETRIES

static final java.lang.String WEBVIEW_CONNECT_RETRIES

Number of times to send connection message to remote debugger, to get webview. Default: 8.

See Also:

Constant Field Values

APP_NAME

static final java.lang.String APP_NAME

The display name of the application under test. Used to automate backgrounding the app in iOS 9+.

See Also:

Constant Field Values

CUSTOM_SSL_CERT

static final java.lang.String CUSTOM_SSL_CERT

Capability to pre-authorize a specific SSL cert in the iOS trust store.

See Also:

Constant Field Values

TAP_WITH_SHORT_PRESS_DURATION

static final java.lang.String TAP_WITH_SHORT_PRESS_DURATION

The desired capability to specify a length for tapping, if the regular tap is too long for the app under test. The XCUITest specific capability.

See Also:

Constant Field Values

SCALE_FACTOR

static final java.lang.String SCALE_FACTOR

The capability to direct Appium to set the simulator scale. The XCUITest specific capability.

See Also:

Constant Field Values

WDA_LOCAL_PORT

static final java.lang.String WDA_LOCAL_PORT

This value if specified, will be used to forward traffic from Mac host to real ios devices over USB. Default value is same as port number used by WDA on device. eg: 8100

See Also:

Constant Field Values

SHOW_XCODE_LOG

static final java.lang.String SHOW_XCODE_LOG

Whether to display the output of the Xcode command used to run the tests.If this is true, there will be lots of extra logging at startup. Defaults to false

See Also:

Constant Field Values

IOS_INSTALL_PAUSE

static final java.lang.String IOS_INSTALL_PAUSE

Time in milliseconds to pause between installing the application and starting WebDriverAgent on the device. Used particularly for larger applications. Defaults to 0

See Also:

Constant Field Values

XCODE_CONFIG_FILE

static final java.lang.String XCODE_CONFIG_FILE

Full path to an optional Xcode configuration file that specifies the code signing identity and team for running the WebDriverAgent on the real device. e.g., /path/to/myconfig.xcconfig

See Also:

Constant Field Values

KEYCHAIN_PASSWORD

static final java.lang.String KEYCHAIN_PASSWORD

Password for unlocking keychain specified in keychainPath.

See Also:

Constant Field Values

USE_PREBUILT_WDA

static final java.lang.String USE_PREBUILT_WDA

Skips the build phase of running the WDA app. Building is then the responsibility of the user. Only works for Xcode 8+. Defaults to false

See Also:

Constant Field Values

PREVENT_WDAATTACHMENTS

static final java.lang.String PREVENT_WDAATTACHMENTS

Sets read only permissons to Attachments subfolder of WebDriverAgent root inside Xcode's DerivedData. This is necessary to prevent XCTest framework from creating tons of unnecessary screenshots and logs, which are impossible to shutdown using programming interfaces provided by Apple

See Also:

Constant Field Values

WEB_DRIVER_AGENT_URL

static final java.lang.String WEB_DRIVER_AGENT_URL

Appium will connect to an existing WebDriverAgent, instance at this URL instead of starting a new one. eg : http://localhost:8100

See Also:

Constant Field Values

KEYCHAIN_PATH

static final java.lang.String KEYCHAIN_PATH

Full path to the private development key exported from the system keychain. Used in conjunction with keychainPassword when testing on real devices. e.g., /path/to/MyPrivateKey.p12

See Also:

Constant Field Values

USE_NEW_WDA

static final java.lang.String USE_NEW_WDA

Forces uninstall of any existing WebDriverAgent app on device. This can provide stability in some situations. Defaults to false.

See Also:

Constant Field Values

WDA_LAUNCH_TIMEOUT

static final java.lang.String WDA_LAUNCH_TIMEOUT

Time, in ms, to wait for WebDriverAgewnt to be pingable. Defaults to 60000ms.

See Also:

Constant Field Values

WDA_CONNECTION_TIMEOUT

static final java.lang.String WDA_CONNECTION_TIMEOUT

Timeout, in ms, for waiting for a resonse from WebDriverAgent. Defaults to 240000ms.

See Also:

Constant Field Values

XCODE_ORG_ID

static final java.lang.String XCODE_ORG_ID

Apple developer team identifier string. Must be used in conjunction with xcodeSigningId to take effect. e.g., JWL241K123

See Also:

Constant Field Values

XCODE_SIGNING_ID

static final java.lang.String XCODE_SIGNING_ID

String representing a signing certificate. Must be used in conjunction with xcodeOrgId. This is usually just iPhone Developer.

See Also:

Constant Field Values

UPDATE_WDA_BUNDLEID

static final java.lang.String UPDATE_WDA_BUNDLEID

Bundle id to update WDA to before building and launching on real devices. This bundle id must be associated with a valid provisioning profile. e.g., io.appium.WebDriverAgentRunner.

See Also:

Constant Field Values

RESET_ON_SESSION_START_ONLY

static final java.lang.String RESET_ON_SESSION_START_ONLY

Whether to perform reset on test session finish (false) or not (true). Keeping this variable set to true and Simulator running (the default behaviour since version 1.6.4) may significantly shorten the duratiuon of test session initialization. Defaults to true.

See Also:

Constant Field Values

COMMAND_TIMEOUTS

static final java.lang.String COMMAND_TIMEOUTS

Custom timeout(s) in milliseconds for WDA backend commands execution.

See Also:

Constant Field Values

WDA_STARTUP_RETRIES

static final java.lang.String WDA_STARTUP_RETRIES

Number of times to try to build and launch WebDriverAgent onto the device. Defaults to 2.

See Also:

Constant Field Values

WDA_STARTUP_RETRY_INTERVAL

static final java.lang.String WDA_STARTUP_RETRY_INTERVAL

Time, in ms, to wait between tries to build and launch WebDriverAgent. Defaults to 10000ms.

See Also:

Constant Field Values

CONNECT_HARDWARE_KEYBOARD

static final java.lang.String CONNECT_HARDWARE_KEYBOARD

Set this option to true in order to enable hardware keyboard in Simulator. It is set to false by default, because this helps to workaround some XCTest bugs.

See Also:

Constant Field Values

MAX_TYPING_FREQUENCY

static final java.lang.String MAX_TYPING_FREQUENCY

Maximum frequency of keystrokes for typing and clear. If your tests are failing because of typing errors, you may want to adjust this. Defaults to 60 keystrokes per minute.

See Also:

Constant Field Values

SIMPLE_ISVISIBLE_CHECK

static final java.lang.String SIMPLE_ISVISIBLE_CHECK

Use native methods for determining visibility of elements. In some cases this takes a long time. Setting this capability to false will cause the system to use the position and size of elements to make sure they are visible on the screen. This can, however, lead to false results in some situations. Defaults to false, except iOS 9.3, where it defaults to true.

See Also:

Constant Field Values

USE_CARTHAGE_SSL

static final java.lang.String USE_CARTHAGE_SSL

Use SSL to download dependencies for WebDriverAgent. Defaults to false.

See Also:

Constant Field Values

SHOULD_USE_SINGLETON_TESTMANAGER

static final java.lang.String SHOULD_USE_SINGLETON_TESTMANAGER

Use default proxy for test management within WebDriverAgent. Setting this to false sometimes helps with socket hangup problems. Defaults to true.

See Also:

Constant Field Values

START_IWDP

static final java.lang.String START_IWDP

Set this to true if you want to start ios_webkit_debug proxy server automatically for accessing webviews on iOS. The capatibility only works for real device automation. Defaults to false.

See Also:

Constant Field Values

ALLOW_TOUCHID_ENROLL

static final java.lang.String ALLOW_TOUCHID_ENROLL

Enrolls simulator for touch id. Defaults to false.

See Also:

Constant Field Values