io.appium.java_client.ios

Class IOSDriver<T extends WebElement>

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver

io.appium.java_client.AppiumDriver<T>

io.appium.java_client.ios.IOSDriver<T>

Type Parameters:

T - the required type of class which implement WebElement. Instances of the defined type will be returned via findElement* and findElements*. Warning (!!!). Allowed types: WebElement RemoteWebElement MobileElement IOSElement

All Implemented Interfaces:

HasBattery<IOSBatteryInfo>, HasClipboard, ComparesImages, ExecutesDriverScript, ExecutesMethod, FindsByAccessibilityId<T>, FindsByCustom<T>, FindsByFluentSelector<T>, FindsByImage<T>, FindsByIosClassChain<T>, FindsByIosNSPredicate<T>, HasAppStrings, HasDeviceTime, HasOnScreenKeyboard, HasSessionDetails, HidesKeyboard, HidesKeyboardWithKeyName, InteractsWithApps, InteractsWithFiles, HasIOSClipboard, ListensToSyslogMessages, PerformsTouchID, PushesFiles, ShakesDevice, LocksDevice, MobileDriver<T>, PerformsTouchActions, CanRecordScreen, org.openqa.selenium.ContextAware, org.openqa.selenium.HasCapabilities, org.openqa.selenium.html5.LocationContext, org.openqa.selenium.interactions.HasInputDevices, org.openqa.selenium.interactions.Interactive, FindsByClassName, FindsByCssSelector, FindsById, FindsByLinkText, FindsByName, FindsByTagName, FindsByXPath, org.openqa.selenium.JavascriptExecutor, org.openqa.selenium.Rotatable, SearchContext, org.openqa.selenium.TakesScreenshot, WebDriver

public class IOSDriver<T extends WebElement>
extends AppiumDriver<T>
implements HidesKeyboardWithKeyName, ShakesDevice, HasOnScreenKeyboard, LocksDevice, PerformsTouchID, FindsByIosNSPredicate<T>, FindsByIosClassChain<T>, PushesFiles, CanRecordScreen, HasIOSClipboard, ListensToSyslogMessages, HasBattery<IOSBatteryInfo>

iOS driver implementation.

Nested Class Summary

Nested classes/interfaces inherited from class org.openqa.selenium.remote.RemoteWebDriver

org.openqa.selenium.remote.RemoteWebDriver.RemoteTargetLocator, org.openqa.selenium.remote.RemoteWebDriver.RemoteWebDriverOptions, org.openqa.selenium.remote.RemoteWebDriver.When

Nested classes/interfaces inherited from interface org.openqa.selenium.WebDriver

WebDriver.ImeHandler, WebDriver.Navigation, WebDriver.Options, WebDriver.TargetLocator, WebDriver.Timeouts, WebDriver.Window

Constructor Summary

Constructors

Constructor and Description
IOSDriver(AppiumDriverLocalService service, org.openqa.selenium.Capabilities desiredCapabilities) Creates a new instance based on Appium driver local service and capabilities.
IOSDriver(AppiumDriverLocalService service, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities) Creates a new instance based on Appium driver local service, HTTP client factory and capabilities.
IOSDriver(AppiumServiceBuilder builder, org.openqa.selenium.Capabilities desiredCapabilities) Creates a new instance based on Appium service builder and capabilities.
IOSDriver(AppiumServiceBuilder builder, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities) Creates a new instance based on Appium service builder, HTTP client factory and capabilities.
IOSDriver(org.openqa.selenium.Capabilities desiredCapabilities) Creates a new instance based on capabilities.
IOSDriver(org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities) Creates a new instance based on HTTP client factory and capabilities.
IOSDriver(org.openqa.selenium.remote.HttpCommandExecutor executor, org.openqa.selenium.Capabilities capabilities) Creates a new instance based on command executor and capabilities.
IOSDriver(java.net.URL remoteAddress, org.openqa.selenium.Capabilities desiredCapabilities) Creates a new instance based on Appium server URL and capabilities.
IOSDriver(java.net.URL remoteAddress, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities) Creates a new instance based on Appium server URL, HTTP client factory and capabilities.

Method Summary

Modifier and Type	Method and Description
org.openqa.selenium.remote.Response	execute(java.lang.String command) Executes JSONWP command and returns a response.
org.openqa.selenium.remote.Response	execute(java.lang.String driverCommand, java.util.Map<java.lang.String,?> parameters) Executes JSONWP command and returns a response.
T	findElement(org.openqa.selenium.By by) Find the first WebElement using the given method.
T	findElement(java.lang.String by, java.lang.String using) Method performs the searching for a single element by some selector defined by string and value of the given selector.
T	findElementByClassName(java.lang.String using)
T	findElementByCssSelector(java.lang.String using) Finds a single element by CSS selector.
T	findElementById(java.lang.String id)
T	findElementByLinkText(java.lang.String using) Finds a single element by link text.
T	findElementByName(java.lang.String using)
T	findElementByPartialLinkText(java.lang.String using) Finds a single element by partial link text.
T	findElementByTagName(java.lang.String using)
T	findElementByXPath(java.lang.String using)
IOSBatteryInfo	getBatteryInfo() Retrieves battery info from the device under test.
StringWebSocketClient	getSyslogClient()
default io.appium.java_client.ios.HasIOSSettings	nativeWebTap(java.lang.Boolean enabled) Set the `nativeWebTap` setting.
void	runAppInBackground(java.time.Duration duration) Runs the current app as a background app for the number of seconds or minimizes the app.
default io.appium.java_client.ios.HasIOSSettings	setElementResponseAttributes(java.lang.String attrNames) Which attributes should be returned if compact responses are disabled.
default io.appium.java_client.ios.HasIOSSettings	setKeyboardAutocorrection(boolean enabled) Changes the 'Auto-Correction' preference in Keyboards setting.
default io.appium.java_client.ios.HasIOSSettings	setKeyboardPrediction(boolean enabled) Changes the 'Predictive' preference in Keyboards setting.
default io.appium.java_client.ios.HasIOSSettings	setMjpegScalingFactor(int scale) The scale of screenshots in range 1..100.
default io.appium.java_client.ios.HasIOSSettings	setMjpegServerFramerate(int framerate) The frame rate at which the background screenshots broadcaster should broadcast screenshots in range 1..60.
default io.appium.java_client.ios.HasIOSSettings	setMjpegServerScreenshotQuality(int quality) 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).
default io.appium.java_client.ios.HasIOSSettings	setScreenshotQuality(int quality) Changes the quality of phone display screenshots according to XCTest/XCTImageQuality enum.
default io.appium.java_client.ios.HasIOSSettings	setShouldUseCompactResponses(boolean enabled) Whether to return compact (standards-compliant) and faster responses from find element/s (the default setting).
WebDriver.TargetLocator	switchTo() Send future commands to a different frame or window.
java.lang.String	toString()

Methods inherited from class io.appium.java_client.AppiumDriver

context, findElements, findElements, findElementsByAccessibilityId, findElementsByClassName, findElementsByCssSelector, findElementsById, findElementsByLinkText, findElementsByName, findElementsByPartialLinkText, findElementsByTagName, findElementsByXPath, getContext, getContextHandles, getExecuteMethod, getOrientation, getRemoteAddress, getStatus, isBrowser, location, rotate, rotate, rotation, setLocation, startSession, substituteMobilePlatform, updateDefaultPlatformName

Methods inherited from class org.openqa.selenium.remote.RemoteWebDriver

builder, close, executeAsyncScript, executeScript, get, getCapabilities, getCommandExecutor, getCurrentUrl, getElementConverter, getErrorHandler, getFileDetector, getKeyboard, getMouse, getPageSource, getScreenshotAs, getSessionId, getTitle, getWindowHandle, getWindowHandles, log, manage, navigate, perform, quit, resetInputState, setCommandExecutor, setElementConverter, setErrorHandler, setFileDetector, setFoundBy, setLogLevel, setSessionId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.appium.java_client.HidesKeyboardWithKeyName

hideKeyboard, hideKeyboard

Methods inherited from interface io.appium.java_client.HidesKeyboard

hideKeyboard

Methods inherited from interface io.appium.java_client.ios.ShakesDevice

shake

Methods inherited from interface io.appium.java_client.HasSettings

getSettings, setSetting

Methods inherited from interface io.appium.java_client.HasOnScreenKeyboard

isKeyboardShown

Methods inherited from interface io.appium.java_client.LocksDevice

isDeviceLocked, lockDevice, lockDevice, unlockDevice

Methods inherited from interface io.appium.java_client.ios.PerformsTouchID

performTouchID, toggleTouchIDEnrollment

Methods inherited from interface io.appium.java_client.FindsByIosNSPredicate

findElementByIosNsPredicate, findElementsByIosNsPredicate

Methods inherited from interface io.appium.java_client.FindsByIosClassChain

findElementByIosClassChain, findElementsByIosClassChain

Methods inherited from interface io.appium.java_client.FindsByFluentSelector

findElement, findElements

Methods inherited from interface io.appium.java_client.ios.PushesFiles

pushFile, pushFile

Methods inherited from interface io.appium.java_client.screenrecording.CanRecordScreen

startRecordingScreen, startRecordingScreen, stopRecordingScreen, stopRecordingScreen

Methods inherited from interface io.appium.java_client.ios.HasIOSClipboard

getClipboardImage, getClipboardUrl, setClipboardImage, setClipboardUrl

Methods inherited from interface io.appium.java_client.clipboard.HasClipboard

getClipboard, getClipboardText, setClipboard, setClipboardText

Methods inherited from interface io.appium.java_client.ios.ListensToSyslogMessages

addSyslogConnectionListener, addSyslogDisconnectionListener, addSyslogErrorsListener, addSyslogMessagesListener, removeAllSyslogListeners, startSyslogBroadcast, startSyslogBroadcast, startSyslogBroadcast, stopSyslogBroadcast

Methods inherited from interface io.appium.java_client.ComparesImages

findImageOccurrence, findImageOccurrence, findImageOccurrence, findImageOccurrence, getImagesSimilarity, getImagesSimilarity, getImagesSimilarity, getImagesSimilarity, matchImagesFeatures, matchImagesFeatures, matchImagesFeatures, matchImagesFeatures

Methods inherited from interface io.appium.java_client.FindsByImage

findElementByImage, findElementsByImage

Methods inherited from interface io.appium.java_client.FindsByCustom

findElementByCustom, findElementsByCustom

Methods inherited from interface io.appium.java_client.ExecutesDriverScript

executeDriverScript, executeDriverScript

Methods inherited from interface org.openqa.selenium.WebDriver

close, get, getCurrentUrl, getPageSource, getTitle, getWindowHandle, getWindowHandles, manage, navigate, quit

Methods inherited from interface io.appium.java_client.PerformsTouchActions

performMultiTouchAction, performTouchAction

Methods inherited from interface io.appium.java_client.FindsByAccessibilityId

findElementByAccessibilityId

Methods inherited from interface io.appium.java_client.HasDeviceTime

getDeviceTime, getDeviceTime

Methods inherited from interface io.appium.java_client.InteractsWithFiles

pullFile, pullFolder

Methods inherited from interface io.appium.java_client.InteractsWithApps

activateApp, activateApp, closeApp, installApp, installApp, isAppInstalled, launchApp, queryAppState, removeApp, removeApp, resetApp, terminateApp, terminateApp

Methods inherited from interface io.appium.java_client.HasAppStrings

getAppStringMap, getAppStringMap, getAppStringMap

Methods inherited from interface io.appium.java_client.HasSessionDetails

getAllSessionDetails, getAutomationName, getPlatformName, getSessionDetail, getSessionDetails

Constructor Detail

IOSDriver

public IOSDriver(org.openqa.selenium.remote.HttpCommandExecutor executor,
                 org.openqa.selenium.Capabilities capabilities)

Creates a new instance based on command executor and capabilities.

Parameters:

executor - is an instance of HttpCommandExecutor or class that extends it. Default commands or another vendor-specific commands may be specified there.

capabilities - take a look at Capabilities

IOSDriver

public IOSDriver(java.net.URL remoteAddress,
                 org.openqa.selenium.Capabilities desiredCapabilities)

Creates a new instance based on Appium server URL and capabilities.

Parameters:

remoteAddress - is the address of remotely/locally started Appium server

desiredCapabilities - take a look at Capabilities

IOSDriver

public IOSDriver(java.net.URL remoteAddress,
                 org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory,
                 org.openqa.selenium.Capabilities desiredCapabilities)

Creates a new instance based on Appium server URL, HTTP client factory and capabilities.

Parameters:

remoteAddress - is the address of remotely/locally started Appium server

httpClientFactory - take a look at HttpClient.Factory

desiredCapabilities - take a look at Capabilities

IOSDriver

public IOSDriver(AppiumDriverLocalService service,
                 org.openqa.selenium.Capabilities desiredCapabilities)

Creates a new instance based on Appium driver local service and capabilities.

Parameters:

service - take a look at AppiumDriverLocalService

desiredCapabilities - take a look at Capabilities

IOSDriver

public IOSDriver(AppiumDriverLocalService service,
                 org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory,
                 org.openqa.selenium.Capabilities desiredCapabilities)

Creates a new instance based on Appium driver local service, HTTP client factory and capabilities.

Parameters:

service - take a look at AppiumDriverLocalService

httpClientFactory - take a look at HttpClient.Factory

desiredCapabilities - take a look at Capabilities

IOSDriver

public IOSDriver(AppiumServiceBuilder builder,
                 org.openqa.selenium.Capabilities desiredCapabilities)

Creates a new instance based on Appium service builder and capabilities.

Parameters:

builder - take a look at AppiumServiceBuilder

desiredCapabilities - take a look at Capabilities

IOSDriver

public IOSDriver(AppiumServiceBuilder builder,
                 org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory,
                 org.openqa.selenium.Capabilities desiredCapabilities)

Creates a new instance based on Appium service builder, HTTP client factory and capabilities.

Parameters:

builder - take a look at AppiumServiceBuilder

httpClientFactory - take a look at HttpClient.Factory

desiredCapabilities - take a look at Capabilities

IOSDriver

public IOSDriver(org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory,
                 org.openqa.selenium.Capabilities desiredCapabilities)

Creates a new instance based on HTTP client factory and capabilities.

Parameters:

httpClientFactory - take a look at HttpClient.Factory

desiredCapabilities - take a look at Capabilities

IOSDriver

public IOSDriver(org.openqa.selenium.Capabilities desiredCapabilities)

Creates a new instance based on capabilities.

Parameters:

desiredCapabilities - take a look at Capabilities

Method Detail

runAppInBackground

public void runAppInBackground(java.time.Duration duration)

Runs the current app as a background app for the number of seconds or minimizes the app.

Specified by:

runAppInBackground in interface InteractsWithApps

Parameters:

duration - The time to run App in background.

switchTo

public WebDriver.TargetLocator switchTo()

Description copied from interface: WebDriver

Send future commands to a different frame or window.

Specified by:

switchTo in interface WebDriver

Overrides:

switchTo in class org.openqa.selenium.remote.RemoteWebDriver

Returns:

A TargetLocator which can be used to select a frame or window

See Also:

WebDriver.TargetLocator

getBatteryInfo

public IOSBatteryInfo getBatteryInfo()

Description copied from interface: HasBattery

Retrieves battery info from the device under test.

Specified by:

getBatteryInfo in interface HasBattery<IOSBatteryInfo>

Returns:

BatteryInfo instance, containing the battery information

getSyslogClient

public StringWebSocketClient getSyslogClient()

Specified by:

getSyslogClient in interface ListensToSyslogMessages

nativeWebTap

public io.appium.java_client.ios.HasIOSSettings nativeWebTap(java.lang.Boolean enabled)

Set the `nativeWebTap` setting. *iOS-only method*. Sets whether Safari/webviews should convert element taps into x/y taps.

Parameters:

enabled - turns nativeWebTap on if true, off if false

Returns:

self instance for chaining

setShouldUseCompactResponses

public io.appium.java_client.ios.HasIOSSettings setShouldUseCompactResponses(boolean enabled)

Whether to return compact (standards-compliant) and faster responses from find element/s (the default setting). If set to false then the response may also contain other available element attributes.

Parameters:

enabled - Either true or false. The default value if true.

Returns:

self instance for chaining

setElementResponseAttributes

public io.appium.java_client.ios.HasIOSSettings setElementResponseAttributes(java.lang.String attrNames)

Which attributes should be returned if compact responses are disabled. It works only if shouldUseCompactResponses is set to false. Defaults to "type,label" string.

Parameters:

attrNames - The comma-separated list of fields to return with each element.

Returns:

self instance for chaining

setMjpegServerScreenshotQuality

public io.appium.java_client.ios.HasIOSSettings setMjpegServerScreenshotQuality(int quality)

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).

Parameters:

quality - An integer in range 0..100. The default value is 25.

Returns:

self instance for chaining

setMjpegServerFramerate

public io.appium.java_client.ios.HasIOSSettings setMjpegServerFramerate(int framerate)

The frame rate at which the background screenshots broadcaster should broadcast screenshots in range 1..60. The default value is 10 (Frames Per Second). Setting zero value will cause the frame rate to be at its maximum possible value.

Parameters:

framerate - An integer in range 1..60. The default value is 10.

Returns:

self instance for chaining

setScreenshotQuality

public io.appium.java_client.ios.HasIOSSettings setScreenshotQuality(int quality)

Changes the quality of phone display screenshots according to XCTest/XCTImageQuality enum. Sometimes setting this value to the maximum possible quality may crash XCTest because of lack of the memory (lossless screenshot require more space).

Parameters:

quality - An integer in range 0..2. The default value is 1.

Returns:

self instance for chaining

setMjpegScalingFactor

public io.appium.java_client.ios.HasIOSSettings setMjpegScalingFactor(int scale)

The scale of screenshots in range 1..100. The default value is 100, no scaling

Parameters:

scale - An integer in range 1..100. The default value is 100.

Returns:

self instance for chaining

setKeyboardAutocorrection

public io.appium.java_client.ios.HasIOSSettings setKeyboardAutocorrection(boolean enabled)

Changes the 'Auto-Correction' preference in Keyboards setting.

Parameters:

enabled - Either true or false. Defaults to false when WDA starts as xctest.

Returns:

self instance for chaining

setKeyboardPrediction

public io.appium.java_client.ios.HasIOSSettings setKeyboardPrediction(boolean enabled)

Changes the 'Predictive' preference in Keyboards setting.

Parameters:

enabled - Either true or false. Defaults to false when WDA starts as xctest.

Returns:

self instance for chaining

execute

public org.openqa.selenium.remote.Response execute(java.lang.String driverCommand,
                                                   java.util.Map<java.lang.String,?> parameters)

Description copied from interface: ExecutesMethod

Executes JSONWP command and returns a response.

Specified by:

execute in interface ExecutesMethod

Overrides:

execute in class org.openqa.selenium.remote.RemoteWebDriver

Parameters:

driverCommand - a JSONWP command

parameters - map of command parameters

Returns:

a result response

execute

public org.openqa.selenium.remote.Response execute(java.lang.String command)

Description copied from interface: ExecutesMethod

Executes JSONWP command and returns a response.

Specified by:

execute in interface ExecutesMethod

Overrides:

execute in class org.openqa.selenium.remote.RemoteWebDriver

Parameters:

command - a JSONWP command

Returns:

a result response

findElement

public T findElement(org.openqa.selenium.By by)

Description copied from interface: WebDriver

Find the first WebElement using the given method. This method is affected by the 'implicit wait' times in force at the time of execution. The findElement(..) invocation will return a matching row, or try again repeatedly until the configured timeout is reached. findElement should not be used to look for non-present elements, use WebDriver.findElements(By) and assert zero length response instead.

Specified by:

findElement in interface MobileDriver<T extends WebElement>

Specified by:

findElement in interface SearchContext

Specified by:

findElement in interface WebDriver

Overrides:

findElement in class org.openqa.selenium.remote.RemoteWebDriver

Parameters:

by - The locating mechanism

Returns:

The first matching element on the current page

See Also:

By, WebDriver.Timeouts

findElement

public T findElement(java.lang.String by,
                     java.lang.String using)

Description copied from interface: FindsByFluentSelector

Method performs the searching for a single element by some selector defined by string and value of the given selector.

Specified by:

findElement in interface FindsByFluentSelector<T extends WebElement>

Overrides:

findElement in class org.openqa.selenium.remote.RemoteWebDriver

Parameters:

by - is a string selector

using - is a value of the given selector

Returns:

the first found element

findElementById

public T findElementById(java.lang.String id)

Specified by:

findElementById in interface MobileDriver<T extends WebElement>

Specified by:

findElementById in interface FindsById

Overrides:

findElementById in class org.openqa.selenium.remote.RemoteWebDriver

findElementByLinkText

public T findElementByLinkText(java.lang.String using)
                        throws org.openqa.selenium.WebDriverException

Finds a single element by link text.

Specified by:

findElementByLinkText in interface MobileDriver<T extends WebElement>

Specified by:

findElementByLinkText in interface FindsByLinkText

Overrides:

findElementByLinkText in class org.openqa.selenium.remote.RemoteWebDriver

Throws:

org.openqa.selenium.WebDriverException - This method doesn't work against native app UI.

findElementByPartialLinkText

public T findElementByPartialLinkText(java.lang.String using)
                               throws org.openqa.selenium.WebDriverException

Finds a single element by partial link text.

Specified by:

findElementByPartialLinkText in interface MobileDriver<T extends WebElement>

Specified by:

findElementByPartialLinkText in interface FindsByLinkText

Overrides:

findElementByPartialLinkText in class org.openqa.selenium.remote.RemoteWebDriver

Throws:

org.openqa.selenium.WebDriverException - This method doesn't work against native app UI.

findElementByTagName

public T findElementByTagName(java.lang.String using)

Specified by:

findElementByTagName in interface MobileDriver<T extends WebElement>

Specified by:

findElementByTagName in interface FindsByTagName

Overrides:

findElementByTagName in class org.openqa.selenium.remote.RemoteWebDriver

findElementByName

public T findElementByName(java.lang.String using)

Specified by:

findElementByName in interface MobileDriver<T extends WebElement>

Specified by:

findElementByName in interface FindsByName

Overrides:

findElementByName in class org.openqa.selenium.remote.RemoteWebDriver

findElementByClassName

public T findElementByClassName(java.lang.String using)

Specified by:

findElementByClassName in interface MobileDriver<T extends WebElement>

Specified by:

findElementByClassName in interface FindsByClassName

Overrides:

findElementByClassName in class org.openqa.selenium.remote.RemoteWebDriver

findElementByCssSelector

public T findElementByCssSelector(java.lang.String using)
                           throws org.openqa.selenium.WebDriverException

Finds a single element by CSS selector.

Specified by:

findElementByCssSelector in interface MobileDriver<T extends WebElement>

Specified by:

findElementByCssSelector in interface FindsByCssSelector

Overrides:

findElementByCssSelector in class org.openqa.selenium.remote.RemoteWebDriver

Throws:

org.openqa.selenium.WebDriverException - This method doesn't work against native app UI.

findElementByXPath

public T findElementByXPath(java.lang.String using)

Specified by:

findElementByXPath in interface MobileDriver<T extends WebElement>

Specified by:

findElementByXPath in interface FindsByXPath

Overrides:

findElementByXPath in class org.openqa.selenium.remote.RemoteWebDriver

toString

public java.lang.String toString()

Overrides:

toString in class org.openqa.selenium.remote.RemoteWebDriver