Package io.appium.java_client.android

Class AndroidDriver

    • Constructor Detail

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

      • AndroidDriver

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

      • 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.Capabilities capabilities)
        Creates a new instance based on capabilities.
        Parameters:
        capabilities - take a look at Capabilities

    • Method Detail

      • endTestCoverage

        public void endTestCoverage​(java.lang.String intent,
                            java.lang.String path)
        Get test-coverage data.
        Parameters:
        intent - intent to broadcast.
        path - path to .ec file.

      • openNotifications

        public void openNotifications()
        Open the notification shade, on Android devices.

      • toggleLocationServices

        public void toggleLocationServices()

      • getLocationContext

        public org.openqa.selenium.remote.html5.RemoteLocationContext getLocationContext()
        Specified by:
        getLocationContext in interface SupportsLocation

      • ignoreUnimportantViews

        public default io.appium.java_client.android.HasAndroidSettings ignoreUnimportantViews​(java.lang.Boolean compress)
        Set the `ignoreUnimportantViews` setting. *Android-only method*. Sets whether Android devices should use `setCompressedLayoutHeirarchy()` which ignores all views which are marked IMPORTANT_FOR_ACCESSIBILITY_NO or IMPORTANT_FOR_ACCESSIBILITY_AUTO (and have been deemed not important by the system), in an attempt to make things less confusing or faster.
        Parameters:
        compress - ignores unimportant views if true, doesn't ignore otherwise.
        Returns:
        self instance for chaining

      • configuratorSetWaitForIdleTimeout

        public default io.appium.java_client.android.HasAndroidSettings configuratorSetWaitForIdleTimeout​(java.time.Duration timeout)
        invoke setWaitForIdleTimeout in com.android.uiautomator.core.Configurator.
        Parameters:
        timeout - A negative value would reset to its default value. Minimum time unit resolution is one millisecond
        Returns:
        self instance for chaining

      • configuratorSetWaitForSelectorTimeout

        public default io.appium.java_client.android.HasAndroidSettings configuratorSetWaitForSelectorTimeout​(java.time.Duration timeout)
        invoke setWaitForSelectorTimeout in com.android.uiautomator.core.Configurator.
        Parameters:
        timeout - A negative value would reset to its default value. Minimum time unit resolution is one millisecond
        Returns:
        self instance for chaining

      • configuratorSetScrollAcknowledgmentTimeout

        public default io.appium.java_client.android.HasAndroidSettings configuratorSetScrollAcknowledgmentTimeout​(java.time.Duration timeout)
        invoke setScrollAcknowledgmentTimeout in com.android.uiautomator.core.Configurator.
        Parameters:
        timeout - A negative value would reset to its default value. Minimum time unit resolution is one millisecond
        Returns:
        self instance for chaining

      • configuratorSetKeyInjectionDelay

        public default io.appium.java_client.android.HasAndroidSettings configuratorSetKeyInjectionDelay​(java.time.Duration delay)
        invoke configuratorSetKeyInjectionDelay in com.android.uiautomator.core.Configurator.
        Parameters:
        delay - A negative value would reset to its default value. Minimum time unit resolution is one millisecond
        Returns:
        self instance for chaining

      • configuratorSetActionAcknowledgmentTimeout

        public default io.appium.java_client.android.HasAndroidSettings configuratorSetActionAcknowledgmentTimeout​(java.time.Duration timeout)
        invoke setActionAcknowledgmentTimeout in com.android.uiautomator.core.Configurator.
        Parameters:
        timeout - A negative value would reset to its default value. Minimum time unit resolution is one millisecond
        Returns:
        self instance for chaining

      • normalizeTagNames

        public default io.appium.java_client.android.HasAndroidSettings normalizeTagNames​(boolean enabled)
        Setting this value to true will enforce source tree dumper to transliterate all class names used as XML tags to the limited set of ASCII characters supported by Apache Harmony lib and used by default in Android to avoid possible XML parsing exceptions caused by XPath lookup. The Unicode to ASCII transliteration is based on JUnidecode library (https://github.com/gcardone/junidecode). Works for UIAutomator2 only.
        Parameters:
        enabled - Either true or false. The default value if false.
        Returns:
        self instance for chaining

      • setShouldUseCompactResponses

        public default io.appium.java_client.android.HasAndroidSettings setShouldUseCompactResponses​(boolean enabled)
        Whether to return compact (standards-compliant) and faster responses in find element/s (the default setting). If set to false then the response may also contain other available element attributes.
        Parameters:
        enabled - Either true or false. The default value if true.
        Returns:
        self instance for chaining

      • setElementResponseAttributes

        public default io.appium.java_client.android.HasAndroidSettings setElementResponseAttributes​(java.lang.String attrNames)
        Which attributes should be returned if compact responses are disabled. It works only if shouldUseCompactResponses is false. Defaults to "" (empty string).
        Parameters:
        attrNames - The comma-separated list of fields to return with each element.
        Returns:
        self instance for chaining

      • allowInvisibleElements

        public default io.appium.java_client.android.HasAndroidSettings allowInvisibleElements​(boolean enabled)
        Set whether the source output/xpath search should consider all elements, visible and invisible. Disabling this setting speeds up source and xml search. Works for UIAutomator2 only.
        Parameters:
        enabled - Either true or false. The default value if false.
        Returns:
        self instance for chaining

      • enableNotificationListener

        public default io.appium.java_client.android.HasAndroidSettings enableNotificationListener​(boolean enabled)
        Whether to enable or disable the notification listener. No toast notifications are going to be added into page source output if this setting is disabled. Works for UIAutomator2 only.
        Parameters:
        enabled - Either true or false. The default value if true.
        Returns:
        self instance for chaining

      • shutdownOnPowerDisconnect

        public default io.appium.java_client.android.HasAndroidSettings shutdownOnPowerDisconnect​(boolean enabled)
        Whether to enable or disable shutdown the server through the broadcast receiver on ACTION_POWER_DISCONNECTED.
        Parameters:
        enabled - Either true or false. The default value if true.
        Returns:
        self instance for chaining

      • setTrackScrollEvents

        public default io.appium.java_client.android.HasAndroidSettings setTrackScrollEvents​(boolean enabled)
        Turn on or off the tracking of scroll events as they happen. If true, a field lastScrollData is added to the results of getSession, which can then be used to check on scroll progress. Turning this feature off significantly increases touch action performance.
        Parameters:
        enabled - Either true or false. The default value if true.
        Returns:
        self instance for chaining