Package 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, org.openqa.selenium.bidi.HasBiDi, org.openqa.selenium.federatedcredentialmanagement.HasFederatedCredentialManagement, org.openqa.selenium.HasCapabilities, org.openqa.selenium.HasDownloads, 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
Direct Known Subclasses:
FlutterIOSDriver
public class IOSDriver extends AppiumDriver implements SupportsContextSwitching, SupportsRotation, SupportsLocation, HidesKeyboard, HasDeviceTime, PullsFiles, InteractsWithApps, HasAppStrings, PerformsTouchActions, HidesKeyboardWithKeyName, ShakesDevice, HasIOSSettings, HasOnScreenKeyboard, LocksDevice, PerformsTouchID, PushesFiles, CanRecordScreen, HasIOSClipboard, ListensToSyslogMessages, HasBattery<IOSBatteryInfo>
iOS driver implementation.

  • Constructor Details

    • 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(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(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(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 Details

    • 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

    • getSyslogClient

      public StringWebSocketClient getSyslogClient()
      Specified by:
      getSyslogClient in interface ListensToSyslogMessages