Package io.appium.java_client.android

Class AndroidDriver

java.lang.Object
org.openqa.selenium.remote.RemoteWebDriver
io.appium.java_client.AppiumDriver
io.appium.java_client.android.AndroidDriver
All Implemented Interfaces:
AuthenticatesByFinger, CanReplaceElementValue, HasNetworkConnection, SupportsExtendedGeolocationCommands, HasAndroidClipboard, HasAndroidDeviceDetails, HasAndroidSettings, HasNotifications, HasSupportedPerformanceDataType, ListensToLogcatMessages, PressesKey, StartsActivity, SupportsGpsStateManagement, SupportsNetworkStateManagement, SupportsSpecialEmulatorCommands, HasBattery<AndroidBatteryInfo>, CanRememberExtensionPresence, HasClipboard, ComparesImages, ExecuteCDPCommand, ExecutesDriverScript, ExecutesMethod, HasAppStrings, HasBrowserCheck, HasDeviceTime, HasOnScreenKeyboard, HasSettings, HidesKeyboard, InteractsWithApps, 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:
FlutterAndroidDriver
public class AndroidDriver extends AppiumDriver implements PressesKey, SupportsRotation, SupportsContextSwitching, SupportsLocation, PerformsTouchActions, HidesKeyboard, HasDeviceTime, PullsFiles, InteractsWithApps, HasAppStrings, HasNetworkConnection, PushesFiles, StartsActivity, LocksDevice, HasAndroidSettings, HasAndroidDeviceDetails, HasSupportedPerformanceDataType, AuthenticatesByFinger, HasOnScreenKeyboard, CanRecordScreen, SupportsSpecialEmulatorCommands, SupportsNetworkStateManagement, ListensToLogcatMessages, HasAndroidClipboard, HasBattery<AndroidBatteryInfo>, ExecuteCDPCommand, CanReplaceElementValue, SupportsGpsStateManagement, HasNotifications, SupportsExtendedGeolocationCommands
Android driver implementation.

  • Constructor Details

    • AndroidDriver

      public AndroidDriver(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

    • AndroidDriver

      public AndroidDriver(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

    • AndroidDriver

      public AndroidDriver(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

    • AndroidDriver

      public AndroidDriver(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

    • AndroidDriver

      public AndroidDriver(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

    • AndroidDriver

      public AndroidDriver(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

    • AndroidDriver

      public AndroidDriver(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

    • AndroidDriver

      public AndroidDriver(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

    • AndroidDriver

      public AndroidDriver(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));
 UiAutomator2Options options = new UiAutomator2Options();
 AndroidDriver driver = new AndroidDriver(clientConfig, options);
      Parameters:
      clientConfig - take a look at ClientConfig
      capabilities - take a look at Capabilities

    • AndroidDriver

      public AndroidDriver(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));
 UiAutomator2Options options = new UiAutomator2Options();
 AndroidDriver driver = new AndroidDriver(appiumClientConfig, options);
      Parameters:
      appiumClientConfig - take a look at AppiumClientConfig
      capabilities - take a look at Capabilities

    • AndroidDriver

      public AndroidDriver(org.openqa.selenium.Capabilities capabilities)
      Creates a new instance based on capabilities.
      Parameters:
      capabilities - take a look at Capabilities

    • AndroidDriver

      public AndroidDriver(URL remoteSessionAddress, String automationName)
      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.
      automationName - The name of the target automation.

  • Method Details