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:

HasBattery<IOSBatteryInfo>, CanRememberExtensionPresence, HasClipboard, ComparesImages, ExecutesDriverScript, ExecutesMethod, HasAppStrings, HasBrowserCheck, HasDeviceTime, HasOnScreenKeyboard, HasSettings, HidesKeyboard, HidesKeyboardWithKeyName, InteractsWithApps, HasIOSClipboard, HasIOSSettings, ListensToSyslogMessages, PerformsTouchID, ShakesDevice, LocksDevice, LogsEvents, PerformsTouchActions, PullsFiles, PushesFiles, SupportsContextSwitching, SupportsLocation, SupportsRotation, CanRecordScreen, SupportsLegacyAppManagement, org.openqa.selenium.ContextAware, org.openqa.selenium.HasCapabilities, org.openqa.selenium.html5.LocationContext, org.openqa.selenium.interactions.Interactive, org.openqa.selenium.JavascriptExecutor, org.openqa.selenium.PrintsPage, org.openqa.selenium.SearchContext, org.openqa.selenium.TakesScreenshot, org.openqa.selenium.virtualauthenticator.HasVirtualAuthenticator, org.openqa.selenium.WebDriver

public class IOSDriver
extends AppiumDriver
implements SupportsContextSwitching, SupportsRotation, SupportsLocation, HidesKeyboard, HasDeviceTime, PullsFiles, InteractsWithApps, SupportsLegacyAppManagement, HasAppStrings, PerformsTouchActions, HidesKeyboardWithKeyName, ShakesDevice, HasIOSSettings, HasOnScreenKeyboard, LocksDevice, PerformsTouchID, 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

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

locationContext

Constructor Summary

Constructors

Constructor and Description
IOSDriver(AppiumClientConfig appiumClientConfig, org.openqa.selenium.Capabilities capabilities) Creates a new instance based on the given ClientConfig and capabilities.
IOSDriver(AppiumDriverLocalService service, org.openqa.selenium.Capabilities capabilities) 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 capabilities) Creates a new instance based on Appium driver local service, HTTP client factory and capabilities.
IOSDriver(AppiumServiceBuilder builder, org.openqa.selenium.Capabilities capabilities) 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 capabilities) Creates a new instance based on Appium service builder, HTTP client factory and capabilities.
IOSDriver(org.openqa.selenium.Capabilities capabilities) Creates a new instance based on capabilities.
IOSDriver(org.openqa.selenium.remote.http.ClientConfig clientConfig, org.openqa.selenium.Capabilities capabilities) Creates a new instance based on the given ClientConfig and capabilities.
IOSDriver(org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities capabilities) 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 remoteSessionAddress) This is a special constructor used to connect to a running driver instance.
IOSDriver(java.net.URL remoteAddress, org.openqa.selenium.Capabilities capabilities) 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 capabilities) Creates a new instance based on Appium server URL, HTTP client factory and capabilities.

Method Summary

Modifier and Type	Method and Description
IOSBatteryInfo	getBatteryInfo() Retrieves battery info from the device under test.
org.openqa.selenium.remote.html5.RemoteLocationContext	getLocationContext()
StringWebSocketClient	getSyslogClient()
org.openqa.selenium.WebDriver.TargetLocator	switchTo()

Methods inherited from class io.appium.java_client.AppiumDriver

addCommand, assertExtensionExists, ensureAutomationName, ensurePlatformAndAutomationNames, ensurePlatformName, execute, execute, getExecuteMethod, getRemoteAddress, getScreenshotAs, getStatus, markExtensionAbsence, startSession

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

addVirtualAuthenticator, builder, close, execute, executeAsyncScript, executeScript, findElement, findElement, findElements, findElements, findElements, get, getCapabilities, getCommandExecutor, getCurrentUrl, getElementConverter, getErrorHandler, getFileDetector, getPageSource, getSessionId, getTitle, getWindowHandle, getWindowHandles, log, manage, navigate, perform, print, quit, removeVirtualAuthenticator, resetInputState, setCommandExecutor, setElementConverter, setErrorHandler, setFileDetector, setFoundBy, setLogLevel, setSessionId, 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.remote.SupportsContextSwitching

context, getContext, getContextHandles

Methods inherited from interface io.appium.java_client.remote.SupportsRotation

getOrientation, rotate, rotate, rotation

Methods inherited from interface io.appium.java_client.remote.SupportsLocation

location, setLocation

Methods inherited from interface org.openqa.selenium.WebDriver

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

Methods inherited from interface io.appium.java_client.HasDeviceTime

getDeviceTime, getDeviceTime

Methods inherited from interface io.appium.java_client.PullsFiles

pullFile, pullFolder

Methods inherited from interface io.appium.java_client.InteractsWithApps

activateApp, activateApp, installApp, installApp, isAppInstalled, queryAppState, removeApp, removeApp, runAppInBackground, terminateApp, terminateApp

Methods inherited from interface io.appium.java_client.SupportsLegacyAppManagement

closeApp, launchApp, resetApp

Methods inherited from interface io.appium.java_client.HasAppStrings

getAppStringMap, getAppStringMap, getAppStringMap

Methods inherited from interface io.appium.java_client.PerformsTouchActions

performMultiTouchAction, performTouchAction

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

assertExtensionExists, markExtensionAbsence

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

shake

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

nativeWebTap, setElementResponseAttributes, setKeyboardAutocorrection, setKeyboardPrediction, setMjpegScalingFactor, setMjpegServerFramerate, setMjpegServerScreenshotQuality, setScreenshotQuality, setShouldUseCompactResponses

Methods inherited from interface io.appium.java_client.HasSettings

getSettings, setSetting, setSetting, setSettings, setSettings

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

executeDriverScript, executeDriverScript

Methods inherited from interface io.appium.java_client.LogsEvents

getEvents, logEvent

Methods inherited from interface io.appium.java_client.HasBrowserCheck

isBrowser

Methods inherited from interface org.openqa.selenium.HasCapabilities

getCapabilities

Methods inherited from interface org.openqa.selenium.JavascriptExecutor

executeScript, getPinnedScripts, pin, unpin

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

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

Parameters:

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

capabilities - take a look at Capabilities

IOSDriver

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

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

capabilities - take a look at Capabilities

IOSDriver

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

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

Parameters:

service - take a look at AppiumDriverLocalService

capabilities - take a look at Capabilities

IOSDriver

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

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

capabilities - take a look at Capabilities

IOSDriver

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

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

Parameters:

builder - take a look at AppiumServiceBuilder

capabilities - take a look at Capabilities

IOSDriver

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

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

capabilities - take a look at Capabilities

IOSDriver

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

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

Parameters:

httpClientFactory - take a look at HttpClient.Factory

capabilities - take a look at Capabilities

IOSDriver

public IOSDriver(org.openqa.selenium.remote.http.ClientConfig clientConfig,
                 org.openqa.selenium.Capabilities capabilities)

Creates a new instance based on the given ClientConfig and capabilities. The HTTP client is default client generated by HttpCommandExecutor.getDefaultClientFactory(). For example:

 ClientConfig clientConfig = ClientConfig.defaultConfig()
     .baseUri(URI.create("WebDriver URL"))
     .readTimeout(Duration.ofMinutes(5));
 XCUITestOptions options = new XCUITestOptions();
 IOSDriver driver = new IOSDriver(clientConfig, options);

 

Parameters:

clientConfig - take a look at ClientConfig

capabilities - take a look at Capabilities

IOSDriver

public IOSDriver(AppiumClientConfig appiumClientConfig,
                 org.openqa.selenium.Capabilities capabilities)

Creates a new instance based on the given ClientConfig and capabilities. The HTTP client is default client generated by HttpCommandExecutor.getDefaultClientFactory(). For example:

 AppiumClientConfig appiumClientConfig = AppiumClientConfig.defaultConfig()
     .directConnect(true)
     .baseUri(URI.create("WebDriver URL"))
     .readTimeout(Duration.ofMinutes(5));
 XCUITestOptions options = new XCUITestOptions();
 IOSDriver driver = new IOSDriver(options, appiumClientConfig);

 

Parameters:

appiumClientConfig - take a look at AppiumClientConfig

capabilities - take a look at Capabilities

IOSDriver

public IOSDriver(java.net.URL remoteSessionAddress)

This is a special constructor used to connect to a running driver instance. It does not do any necessary verifications, but rather assumes the given driver session is already running at `remoteSessionAddress`. The maintenance of driver state(s) is the caller's responsibility. !!! This API is supposed to be used for **debugging purposes only**.

Parameters:

remoteSessionAddress - The address of the **running** session including the session identifier.

IOSDriver

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

Creates a new instance based on capabilities.

Parameters:

capabilities - take a look at Capabilities

Method Detail

switchTo

public org.openqa.selenium.WebDriver.TargetLocator switchTo()

Specified by:

switchTo in interface org.openqa.selenium.WebDriver

Overrides:

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

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

getLocationContext

public org.openqa.selenium.remote.html5.RemoteLocationContext getLocationContext()

Specified by:

getLocationContext in interface SupportsLocation

getSyslogClient

public StringWebSocketClient getSyslogClient()

Specified by:

getSyslogClient in interface ListensToSyslogMessages