io.appium.java_client.ios

Class IOSDriver

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver

io.appium.java_client.AppiumDriver

io.appium.java_client.ios.IOSDriver

All Implemented Interfaces:

DeviceActionShortcuts, FindsByAccessibilityId, FindsByIosUIAutomation, InteractsWithApps, InteractsWithFiles, GetsNamedTextField, IOSDeviceActionShortcuts, MobileDriver, PerformsTouchActions, ScrollsTo, 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
extends AppiumDriver
implements IOSDeviceActionShortcuts, GetsNamedTextField, FindsByIosUIAutomation

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

Field Summary

Fields inherited from class io.appium.java_client.AppiumDriver

KEY_CODE, PATH

Constructor Summary

Constructors

Constructor and Description
IOSDriver(URL remoteAddress, org.openqa.selenium.Capabilities desiredCapabilities)

Method Summary

Methods

Modifier and Type	Method and Description
org.openqa.selenium.WebElement	findElementByIosUIAutomation(String using)
List<org.openqa.selenium.WebElement>	findElementsByIosUIAutomation(String using)
org.openqa.selenium.WebElement	getNamedTextField(String name) In iOS apps, named TextFields have the same accessibility Id as their containing TableElement.
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.
MobileElement	scrollTo(String text) Scroll to the element whose 'text' attribute contains the input text.
MobileElement	scrollToExact(String text) Scroll to the element whose 'text' attribute is equal to the input text.
void	shake() Simulate shaking the device

Methods inherited from class io.appium.java_client.AppiumDriver

_isNotNullOrEmpty, _isNotNullOrEmpty, closeApp, context, execute, execute, findElementByAccessibilityId, findElementsByAccessibilityId, getCommandImmutableMap, getCommandImmutableMap, getContext, getContextHandles, getExecuteMethod, getOrientation, getRemoteAddress, getSettings, hideKeyboard, installApp, isAppInstalled, launchApp, location, lockScreen, performMultiTouchAction, performTouchAction, pinch, pinch, pullFile, pullFolder, removeApp, resetApp, rotate, runAppInBackground, sendKeyEvent, setLocation, setSetting, substituteMobilePlatform, swipe, tap, tap, zoom, zoom

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

close, executeAsyncScript, executeScript, findElement, findElement, findElementByClassName, findElementByCssSelector, findElementById, findElementByLinkText, findElementByName, findElementByPartialLinkText, findElementByTagName, findElementByXPath, findElements, findElements, findElementsByClassName, findElementsByCssSelector, findElementsById, findElementsByLinkText, findElementsByName, findElementsByPartialLinkText, findElementsByTagName, findElementsByXPath, get, getCapabilities, getCommandExecutor, getCurrentUrl, getElementConverter, getErrorHandler, getFileDetector, getKeyboard, getMouse, getPageSource, getRemoteStatus, getScreenshotAs, getSessionId, getTitle, 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

hideKeyboard, sendKeyEvent

Methods inherited from interface org.openqa.selenium.WebDriver

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

Constructor Detail

IOSDriver

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

Method Detail

scrollTo

public MobileElement scrollTo(String text)

Scroll to the element whose 'text' attribute contains the input text. This scrolling happens within the first UIATableView on the UI. Use the method on IOSElement to scroll from a different ScrollView.

Specified by:

scrollTo in interface ScrollsTo

Parameters:

text - input text contained in text attribute

scrollToExact

public MobileElement scrollToExact(String text)

Scroll to the element whose 'text' attribute is equal to the input text. This scrolling happens within the first UIATableView on the UI. Use the method on IOSElement to scroll from a different ScrollView.

Specified by:

scrollToExact in interface ScrollsTo

Parameters:

text - input text to match

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

public org.openqa.selenium.WebElement getNamedTextField(String name)

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.

Specified by:

getNamedTextField in interface GetsNamedTextField

Parameters:

name - accessiblity id of TextField

Returns:

The textfield with the given accessibility id

See Also:

GetsNamedTextField.getNamedTextField(String)

findElementByIosUIAutomation

public org.openqa.selenium.WebElement findElementByIosUIAutomation(String using)

Specified by:

findElementByIosUIAutomation in interface FindsByIosUIAutomation

findElementsByIosUIAutomation

public List<org.openqa.selenium.WebElement> findElementsByIosUIAutomation(String using)

Specified by:

findElementsByIosUIAutomation in interface FindsByIosUIAutomation