io.appium.java_client.ios

Class IOSDriver<T extends org.openqa.selenium.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 TouchableElement RemoteWebElement MobileElement IOSElement

All Implemented Interfaces:

DeviceActionShortcuts, FindsByAccessibilityId<org.openqa.selenium.WebElement>, FindsByIosUIAutomation<T>, GenericFindsByClassName<T>, GenericFindsByCssSelector<T>, GenericFindsById<T>, GenericFindsByLinkText<T>, GenericFindsByName<T>, GenericFindsByTagName<T>, GenericFindsByXPath<T>, GenericSearchContext<T>, HasAppStrings, InteractsWithApps, InteractsWithFiles, GetsNamedTextField<T>, IOSDeviceActionShortcuts, MobileDriver, PerformsTouchActions, ScrollsTo<org.openqa.selenium.WebElement>, TouchShortcuts, org.openqa.selenium.ContextAware, org.openqa.selenium.HasCapabilities, org.openqa.selenium.html5.LocationContext, org.openqa.selenium.interactions.HasInputDevices, org.openqa.selenium.internal.FindsByClassName, org.openqa.selenium.internal.FindsByCssSelector, org.openqa.selenium.internal.FindsById, org.openqa.selenium.internal.FindsByLinkText, org.openqa.selenium.internal.FindsByName, org.openqa.selenium.internal.FindsByTagName, org.openqa.selenium.internal.FindsByXPath, org.openqa.selenium.JavascriptExecutor, org.openqa.selenium.Rotatable, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.WebDriver

public class IOSDriver<T extends org.openqa.selenium.WebElement>
extends AppiumDriver<T>
implements IOSDeviceActionShortcuts, GetsNamedTextField<T>, FindsByIosUIAutomation<T>

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

org.openqa.selenium.WebDriver.ImeHandler, org.openqa.selenium.WebDriver.Navigation, org.openqa.selenium.WebDriver.Options, org.openqa.selenium.WebDriver.TargetLocator, org.openqa.selenium.WebDriver.Timeouts, org.openqa.selenium.WebDriver.Window

Constructor Summary

Constructors

Constructor and Description
IOSDriver(AppiumDriverLocalService service, org.openqa.selenium.Capabilities desiredCapabilities)
IOSDriver(AppiumDriverLocalService service, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities)
IOSDriver(AppiumServiceBuilder builder, org.openqa.selenium.Capabilities desiredCapabilities)
IOSDriver(AppiumServiceBuilder builder, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities)
IOSDriver(org.openqa.selenium.Capabilities desiredCapabilities)
IOSDriver(org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities)
IOSDriver(org.openqa.selenium.remote.HttpCommandExecutor executor, org.openqa.selenium.Capabilities capabilities)
IOSDriver(URL remoteAddress, org.openqa.selenium.Capabilities desiredCapabilities)
IOSDriver(URL remoteAddress, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities)

Method Summary

Methods

Modifier and Type	Method and Description
org.openqa.selenium.remote.Response	execute(String driverCommand, Map<String,?> parameters)
T	findElement(org.openqa.selenium.By by)
T	findElement(String by, String using)
T	findElementByAccessibilityId(String using)
T	findElementByClassName(String using)
T	findElementByCssSelector(String using)
T	findElementById(String id)
T	findElementByIosUIAutomation(String using)
T	findElementByLinkText(String using)
T	findElementByName(String using)
T	findElementByPartialLinkText(String using)
T	findElementByTagName(String using)
T	findElementByXPath(String using)
List<T>	findElementsByIosUIAutomation(String using)
org.openqa.selenium.interactions.Mouse	getMouse() Deprecated.
T	getNamedTextField(String name) Deprecated.
void	hideKeyboard(String keyName) Hides the keyboard by pressing the button specified by keyName if it is showing.
void	hideKeyboard(String strategy, String keyName) Hides the keyboard if it is showing.
void	lockDevice(int seconds) Lock the device (bring it to the lock screen) for a given number of seconds.
T	scrollTo(String text) Deprecated.
T	scrollToExact(String text) Deprecated.
void	shake() Simulate shaking the device.
void	swipe(int startx, int starty, int endx, int endy, int duration) Convenience method for swiping across the screen.

Methods inherited from class io.appium.java_client.AppiumDriver

closeApp, context, doSwipe, execute, findElements, findElements, findElementsByAccessibilityId, findElementsByClassName, findElementsByCssSelector, findElementsById, findElementsByLinkText, findElementsByName, findElementsByPartialLinkText, findElementsByTagName, findElementsByXPath, getAppStringMap, getAppStringMap, getAppStringMap, getCommandImmutableMap, getCommandImmutableMap, getContext, getContextHandles, getDeviceTime, getExecuteMethod, getOrientation, getRemoteAddress, getSettings, hideKeyboard, installApp, isAppInstalled, launchApp, location, performMultiTouchAction, performTouchAction, pinch, pinch, pullFile, pullFolder, removeApp, resetApp, rotate, runAppInBackground, setLocation, setSetting, substituteMobilePlatform, tap, tap, zoom, zoom

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

close, executeAsyncScript, executeScript, get, getCapabilities, getCommandExecutor, getCurrentUrl, getElementConverter, getErrorHandler, getFileDetector, getKeyboard, getPageSource, getScreenshotAs, getSessionId, getTitle, getW3CStandardComplianceLevel, getWindowHandle, getWindowHandles, log, manage, navigate, quit, setCommandExecutor, setElementConverter, setErrorHandler, setFileDetector, setFoundBy, setLogLevel, setSessionId, startClient, startSession, startSession, stopClient, switchTo, toString

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

getDeviceTime, hideKeyboard

Methods inherited from interface org.openqa.selenium.WebDriver

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

Constructor Detail

IOSDriver

public IOSDriver(org.openqa.selenium.remote.HttpCommandExecutor executor,
         org.openqa.selenium.Capabilities 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(URL remoteAddress,
         org.openqa.selenium.Capabilities desiredCapabilities)

Parameters:

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

desiredCapabilities - take a look at Capabilities

IOSDriver

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

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)

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)

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)

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)

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)

Parameters:

httpClientFactory - take a look at HttpClient.Factory

desiredCapabilities - take a look at Capabilities

IOSDriver

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

Parameters:

desiredCapabilities - take a look at Capabilities

Method Detail

swipe

public void swipe(int startx,
         int starty,
         int endx,
         int endy,
         int duration)

Description copied from interface: TouchShortcuts

Convenience method for swiping across the screen.

Specified by:

swipe in interface TouchShortcuts

Specified by:

swipe in class AppiumDriver<T extends org.openqa.selenium.WebElement>

Parameters:

startx - starting x coordinate.

starty - starting y coordinate.

endx - ending x coordinate.

endy - ending y coordinate.

duration - amount of time in milliseconds for the entire swipe action to take

See Also:

TouchShortcuts.swipe(int, int, int, int, int).

scrollTo

@Deprecated
public T scrollTo(String text)

Deprecated.

This method is deprecated because it is not consistent and it is going to be removed. It is workaround actually. Recommended to use instead: AppiumDriver.swipe(int, int, int, int, int) MobileElement.swipe(SwipeElementDirection, int) MobileElement.swipe(SwipeElementDirection, int, int, int) or search for elements using MobileBy.ByIosUIAutomation

Specified by:

scrollTo in interface ScrollsTo<org.openqa.selenium.WebElement>

Parameters:

text - description or text of an element scroll to

Returns:

an element that matches

scrollToExact

@Deprecated
public T scrollToExact(String text)

Deprecated.

This method is deprecated because it is not consistent and it is going to be removed. It is workaround actually. Recommended to use instead: AppiumDriver.swipe(int, int, int, int, int) MobileElement.swipe(SwipeElementDirection, int) MobileElement.swipe(SwipeElementDirection, int, int, int) or search for elements using MobileBy.ByIosUIAutomation

Specified by:

scrollToExact in interface ScrollsTo<org.openqa.selenium.WebElement>

Parameters:

text - description or text of an element scroll to

Returns:

an element that matches

hideKeyboard

public void hideKeyboard(String strategy,
                String keyName)

Description copied from interface: IOSDeviceActionShortcuts

Hides the keyboard if it is showing. Available strategies are PRESS_KEY and TAP_OUTSIDE. One taps outside the keyboard, the other presses a key of your choosing (probably the 'Done' key). Hiding the keyboard often depends on the way an app is implemented, no single strategy always works.

Specified by:

hideKeyboard in interface IOSDeviceActionShortcuts

Parameters:

strategy - HideKeyboardStrategy.

keyName - a String, representing the text displayed on the button of the keyboard you want to press. For example: "Done".

See Also:

IOSDeviceActionShortcuts.hideKeyboard(String, String).

hideKeyboard

public void hideKeyboard(String keyName)

Description copied from interface: IOSDeviceActionShortcuts

Hides the keyboard by pressing the button specified by keyName if it is showing.

Specified by:

hideKeyboard in interface IOSDeviceActionShortcuts

Parameters:

keyName - The button pressed by the mobile driver to attempt hiding the keyboard.

See Also:

IOSDeviceActionShortcuts.hideKeyboard(String).

shake

public void shake()

Description copied from interface: IOSDeviceActionShortcuts

Simulate shaking the device.

Specified by:

shake in interface IOSDeviceActionShortcuts

See Also:

IOSDeviceActionShortcuts.shake().

getNamedTextField

@Deprecated
public T getNamedTextField(String name)

Deprecated.

Description copied from interface: GetsNamedTextField

In iOS apps, named TextFields have the same accessibility Id as their containing TableElement. This is a convenience method for getting the named TextField, rather than its containing element. * This method is deprecated and it is going to be removed further.

Specified by:

getNamedTextField in interface GetsNamedTextField<T extends org.openqa.selenium.WebElement>

Parameters:

name - accessiblity id of TextField

Returns:

The textfield with the given accessibility id

findElementByIosUIAutomation

public T findElementByIosUIAutomation(String using)
                                                                      throws org.openqa.selenium.WebDriverException

Specified by:

findElementByIosUIAutomation in interface FindsByIosUIAutomation<T extends org.openqa.selenium.WebElement>

Throws:

org.openqa.selenium.WebDriverException - This method is not applicable with browser/webview UI.

findElementsByIosUIAutomation

public List<T> findElementsByIosUIAutomation(String using)
                                                                             throws org.openqa.selenium.WebDriverException

Specified by:

findElementsByIosUIAutomation in interface FindsByIosUIAutomation<T extends org.openqa.selenium.WebElement>

Throws:

org.openqa.selenium.WebDriverException - This method is not applicable with browser/webview UI.

lockDevice

public void lockDevice(int seconds)

Lock the device (bring it to the lock screen) for a given number of seconds.

Parameters:

seconds - number of seconds to lock the screen for

execute

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

Specified by:

execute in interface MobileDriver

Overrides:

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

findElement

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

Specified by:

findElement in interface GenericSearchContext<T extends org.openqa.selenium.WebElement>

Specified by:

findElement in interface org.openqa.selenium.SearchContext

Specified by:

findElement in interface org.openqa.selenium.WebDriver

Overrides:

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

findElement

public T findElement(String by,
            String using)

Overrides:

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

findElementById

public T findElementById(String id)

Specified by:

findElementById in interface GenericFindsById<T extends org.openqa.selenium.WebElement>

Specified by:

findElementById in interface org.openqa.selenium.internal.FindsById

Overrides:

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

findElementByLinkText

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

Specified by:

findElementByLinkText in interface GenericFindsByLinkText<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByLinkText in interface org.openqa.selenium.internal.FindsByLinkText

Overrides:

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

Throws:

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

findElementByPartialLinkText

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

Specified by:

findElementByPartialLinkText in interface GenericFindsByLinkText<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByPartialLinkText in interface org.openqa.selenium.internal.FindsByLinkText

Overrides:

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

Throws:

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

findElementByTagName

public T findElementByTagName(String using)

Specified by:

findElementByTagName in interface GenericFindsByTagName<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByTagName in interface org.openqa.selenium.internal.FindsByTagName

Overrides:

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

findElementByName

public T findElementByName(String using)

Specified by:

findElementByName in interface GenericFindsByName<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByName in interface org.openqa.selenium.internal.FindsByName

Overrides:

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

findElementByClassName

public T findElementByClassName(String using)

Specified by:

findElementByClassName in interface GenericFindsByClassName<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByClassName in interface org.openqa.selenium.internal.FindsByClassName

Overrides:

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

findElementByCssSelector

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

Specified by:

findElementByCssSelector in interface GenericFindsByCssSelector<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByCssSelector in interface org.openqa.selenium.internal.FindsByCssSelector

Overrides:

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

Throws:

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

findElementByXPath

public T findElementByXPath(String using)

Specified by:

findElementByXPath in interface GenericFindsByXPath<T extends org.openqa.selenium.WebElement>

Specified by:

findElementByXPath in interface org.openqa.selenium.internal.FindsByXPath

Overrides:

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

findElementByAccessibilityId

public T findElementByAccessibilityId(String using)
                                                                      throws org.openqa.selenium.WebDriverException

Specified by:

findElementByAccessibilityId in interface FindsByAccessibilityId<org.openqa.selenium.WebElement>

Throws:

org.openqa.selenium.WebDriverException - This method is not applicable with browser/webview UI.

getMouse

@Deprecated
public org.openqa.selenium.interactions.Mouse getMouse()

Deprecated.

Mouse doesn't work on mobile devices and emulators.

Specified by:

getMouse in interface org.openqa.selenium.interactions.HasInputDevices

Overrides:

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