io.appium.java_client.mac

Class Mac2Driver<T extends WebElement>

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver

io.appium.java_client.AppiumDriver<T>

io.appium.java_client.mac.Mac2Driver<T>

All Implemented Interfaces:

ComparesImages, ExecutesDriverScript, ExecutesMethod, FindsByAccessibilityId<T>, FindsByCustom<T>, FindsByFluentSelector<T>, FindsByImage<T>, HasAppStrings, HasDeviceTime, HasSessionDetails, HasSettings, HidesKeyboard, InteractsWithApps, InteractsWithFiles, LogsEvents, FindsByClassChain<T>, FindsByNsPredicate<T>, MobileDriver<T>, PerformsTouchActions, CanRecordScreen, org.openqa.selenium.ContextAware, org.openqa.selenium.HasCapabilities, org.openqa.selenium.html5.LocationContext, org.openqa.selenium.interactions.HasInputDevices, org.openqa.selenium.interactions.Interactive, FindsByClassName, FindsByCssSelector, FindsById, FindsByLinkText, FindsByName, FindsByTagName, FindsByXPath, org.openqa.selenium.JavascriptExecutor, org.openqa.selenium.Rotatable, SearchContext, org.openqa.selenium.TakesScreenshot, WebDriver

public class Mac2Driver<T extends WebElement>
extends AppiumDriver<T>
implements CanRecordScreen, FindsByClassChain<T>, FindsByNsPredicate<T>, HasSettings

Mac2Driver is an officially supported Appium driver created to automate Mac OS apps. The driver uses W3C WebDriver protocol and is built on top of Apple's XCTest automation framework. Read https://github.com/appium/appium-mac2-driver for more details on how to configure and use it.

Since:

Appium 1.20.0

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

WebDriver.ImeHandler, WebDriver.Navigation, WebDriver.Options, WebDriver.TargetLocator, WebDriver.Timeouts, WebDriver.Window

Constructor Summary

Constructors

Constructor and Description
Mac2Driver(AppiumDriverLocalService service, org.openqa.selenium.Capabilities desiredCapabilities)
Mac2Driver(AppiumDriverLocalService service, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities)
Mac2Driver(AppiumServiceBuilder builder, org.openqa.selenium.Capabilities desiredCapabilities)
Mac2Driver(AppiumServiceBuilder builder, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities)
Mac2Driver(org.openqa.selenium.Capabilities desiredCapabilities)
Mac2Driver(org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities)
Mac2Driver(org.openqa.selenium.remote.HttpCommandExecutor executor, org.openqa.selenium.Capabilities capabilities)
Mac2Driver(java.net.URL remoteAddress, org.openqa.selenium.Capabilities desiredCapabilities)
Mac2Driver(java.net.URL remoteAddress, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities desiredCapabilities)

Method Summary

Modifier and Type	Method and Description
org.openqa.selenium.remote.Response	execute(java.lang.String command) Executes JSONWP command and returns a response.
org.openqa.selenium.remote.Response	execute(java.lang.String driverCommand, java.util.Map<java.lang.String,?> parameters) Executes JSONWP command and returns a response.
T	findElement(org.openqa.selenium.By by) Find the first WebElement using the given method.
T	findElement(java.lang.String by, java.lang.String using) Method performs the searching for a single element by some selector defined by string and value of the given selector.
T	findElementByClassName(java.lang.String using)
T	findElementByCssSelector(java.lang.String using) Finds a single element by CSS selector.
T	findElementById(java.lang.String id)
T	findElementByLinkText(java.lang.String using) Finds a single element by link text.
T	findElementByName(java.lang.String using)
T	findElementByPartialLinkText(java.lang.String using) Finds a single element by partial link text.
T	findElementByTagName(java.lang.String using)
T	findElementByXPath(java.lang.String using)
java.lang.String	toString()

Methods inherited from class io.appium.java_client.AppiumDriver

context, findElements, findElements, findElementsByAccessibilityId, findElementsByClassName, findElementsByCssSelector, findElementsById, findElementsByLinkText, findElementsByName, findElementsByPartialLinkText, findElementsByTagName, findElementsByXPath, getContext, getContextHandles, getExecuteMethod, getOrientation, getRemoteAddress, getStatus, isBrowser, location, rotate, rotate, rotation, setLocation, startSession, substituteMobilePlatform, updateDefaultPlatformName

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

builder, close, executeAsyncScript, executeScript, get, getCapabilities, getCommandExecutor, getCurrentUrl, getElementConverter, getErrorHandler, getFileDetector, getKeyboard, getMouse, getPageSource, getScreenshotAs, getSessionId, getTitle, getWindowHandle, getWindowHandles, log, manage, navigate, perform, quit, resetInputState, setCommandExecutor, setElementConverter, setErrorHandler, setFileDetector, setFoundBy, setLogLevel, setSessionId, switchTo

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.screenrecording.CanRecordScreen

startRecordingScreen, startRecordingScreen, stopRecordingScreen, stopRecordingScreen

Methods inherited from interface io.appium.java_client.mac.FindsByClassChain

findElementByClassChain, findElementsByClassChain

Methods inherited from interface io.appium.java_client.mac.FindsByNsPredicate

findElementByNsPredicate, findElementsByNsPredicate

Methods inherited from interface io.appium.java_client.FindsByFluentSelector

findElement, findElements

Methods inherited from interface io.appium.java_client.HasSettings

getSettings, setSetting, setSetting, setSettings, setSettings

Methods inherited from interface io.appium.java_client.ExecutesMethod

execute, execute

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

findElementByImage, findElementsByImage

Methods inherited from interface io.appium.java_client.FindsByCustom

findElementByCustom, findElementsByCustom

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 org.openqa.selenium.WebDriver

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

Methods inherited from interface io.appium.java_client.PerformsTouchActions

performMultiTouchAction, performTouchAction

Methods inherited from interface io.appium.java_client.FindsByAccessibilityId

findElementByAccessibilityId

Methods inherited from interface io.appium.java_client.HidesKeyboard

hideKeyboard

Methods inherited from interface io.appium.java_client.HasDeviceTime

getDeviceTime, getDeviceTime

Methods inherited from interface io.appium.java_client.InteractsWithFiles

pullFile, pullFolder

Methods inherited from interface io.appium.java_client.InteractsWithApps

activateApp, activateApp, closeApp, installApp, installApp, isAppInstalled, launchApp, queryAppState, removeApp, removeApp, resetApp, runAppInBackground, terminateApp, terminateApp

Methods inherited from interface io.appium.java_client.HasAppStrings

getAppStringMap, getAppStringMap, getAppStringMap

Methods inherited from interface io.appium.java_client.HasSessionDetails

getAllSessionDetails, getAutomationName, getPlatformName, getSessionDetail, getSessionDetails

Constructor Detail

Mac2Driver

public Mac2Driver(org.openqa.selenium.remote.HttpCommandExecutor executor,
                  org.openqa.selenium.Capabilities capabilities)

Mac2Driver

public Mac2Driver(java.net.URL remoteAddress,
                  org.openqa.selenium.Capabilities desiredCapabilities)

Mac2Driver

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

Mac2Driver

public Mac2Driver(AppiumDriverLocalService service,
                  org.openqa.selenium.Capabilities desiredCapabilities)

Mac2Driver

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

Mac2Driver

public Mac2Driver(AppiumServiceBuilder builder,
                  org.openqa.selenium.Capabilities desiredCapabilities)

Mac2Driver

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

Mac2Driver

public Mac2Driver(org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory,
                  org.openqa.selenium.Capabilities desiredCapabilities)

Mac2Driver

public Mac2Driver(org.openqa.selenium.Capabilities desiredCapabilities)

Method Detail

execute

public org.openqa.selenium.remote.Response execute(java.lang.String driverCommand,
                                                   java.util.Map<java.lang.String,?> parameters)

Description copied from interface: ExecutesMethod

Executes JSONWP command and returns a response.

Specified by:

execute in interface ExecutesMethod

Overrides:

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

Parameters:

driverCommand - a JSONWP command

parameters - map of command parameters

Returns:

a result response

execute

public org.openqa.selenium.remote.Response execute(java.lang.String command)

Description copied from interface: ExecutesMethod

Executes JSONWP command and returns a response.

Specified by:

execute in interface ExecutesMethod

Overrides:

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

Parameters:

command - a JSONWP command

Returns:

a result response

findElement

public T findElement(org.openqa.selenium.By by)

Description copied from interface: WebDriver

Find the first WebElement using the given method. This method is affected by the 'implicit wait' times in force at the time of execution. The findElement(..) invocation will return a matching row, or try again repeatedly until the configured timeout is reached. findElement should not be used to look for non-present elements, use WebDriver.findElements(By) and assert zero length response instead.

Specified by:

findElement in interface MobileDriver<T extends WebElement>

Specified by:

findElement in interface SearchContext

Specified by:

findElement in interface WebDriver

Overrides:

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

Parameters:

by - The locating mechanism

Returns:

The first matching element on the current page

See Also:

By, WebDriver.Timeouts

findElement

public T findElement(java.lang.String by,
                     java.lang.String using)

Description copied from interface: FindsByFluentSelector

Method performs the searching for a single element by some selector defined by string and value of the given selector.

Specified by:

findElement in interface FindsByFluentSelector<T extends WebElement>

Overrides:

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

Parameters:

by - is a string selector

using - is a value of the given selector

Returns:

the first found element

findElementById

public T findElementById(java.lang.String id)

Specified by:

findElementById in interface MobileDriver<T extends WebElement>

Specified by:

findElementById in interface FindsById

Overrides:

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

findElementByLinkText

public T findElementByLinkText(java.lang.String using)
                        throws org.openqa.selenium.WebDriverException

Finds a single element by link text.

Specified by:

findElementByLinkText in interface MobileDriver<T extends WebElement>

Specified by:

findElementByLinkText in interface FindsByLinkText

Overrides:

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

Throws:

org.openqa.selenium.WebDriverException - This method doesn't work against native app UI.

findElementByPartialLinkText

public T findElementByPartialLinkText(java.lang.String using)
                               throws org.openqa.selenium.WebDriverException

Finds a single element by partial link text.

Specified by:

findElementByPartialLinkText in interface MobileDriver<T extends WebElement>

Specified by:

findElementByPartialLinkText in interface FindsByLinkText

Overrides:

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

Throws:

org.openqa.selenium.WebDriverException - This method doesn't work against native app UI.

findElementByTagName

public T findElementByTagName(java.lang.String using)

Specified by:

findElementByTagName in interface MobileDriver<T extends WebElement>

Specified by:

findElementByTagName in interface FindsByTagName

Overrides:

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

findElementByName

public T findElementByName(java.lang.String using)

Specified by:

findElementByName in interface MobileDriver<T extends WebElement>

Specified by:

findElementByName in interface FindsByName

Overrides:

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

findElementByClassName

public T findElementByClassName(java.lang.String using)

Specified by:

findElementByClassName in interface MobileDriver<T extends WebElement>

Specified by:

findElementByClassName in interface FindsByClassName

Overrides:

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

findElementByCssSelector

public T findElementByCssSelector(java.lang.String using)
                           throws org.openqa.selenium.WebDriverException

Finds a single element by CSS selector.

Specified by:

findElementByCssSelector in interface MobileDriver<T extends WebElement>

Specified by:

findElementByCssSelector in interface FindsByCssSelector

Overrides:

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

Throws:

org.openqa.selenium.WebDriverException - This method doesn't work against native app UI.

findElementByXPath

public T findElementByXPath(java.lang.String using)

Specified by:

findElementByXPath in interface MobileDriver<T extends WebElement>

Specified by:

findElementByXPath in interface FindsByXPath

Overrides:

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

toString

public java.lang.String toString()

Overrides:

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