Package io.appium.java_client.gecko

Class GeckoDriver

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver

io.appium.java_client.AppiumDriver

io.appium.java_client.gecko.GeckoDriver

All Implemented Interfaces:

CanRememberExtensionPresence, ComparesImages, ExecutesDriverScript, ExecutesMethod, HasBrowserCheck, HasSettings, LogsEvents, 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

public class GeckoDriver
extends AppiumDriver

GeckoDriver is an officially supported Appium driver created to automate Mobile browsers and web views based on the Gecko engine. The driver uses W3C WebDriver protocol and is built on top of Mozilla's geckodriver server. Read https://github.com/appium/appium-geckodriver 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

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	Description
GeckoDriver(AppiumClientConfig appiumClientConfig, org.openqa.selenium.Capabilities capabilities)	Creates a new instance based on the given ClientConfig and capabilities.
GeckoDriver(AppiumDriverLocalService service, org.openqa.selenium.Capabilities capabilities)
GeckoDriver(AppiumDriverLocalService service, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities capabilities)
GeckoDriver(AppiumServiceBuilder builder, org.openqa.selenium.Capabilities capabilities)
GeckoDriver(AppiumServiceBuilder builder, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities capabilities)
GeckoDriver(java.net.URL remoteSessionAddress, java.lang.String platformName)	This is a special constructor used to connect to a running driver instance.
GeckoDriver(java.net.URL remoteAddress, org.openqa.selenium.Capabilities capabilities)
GeckoDriver(java.net.URL remoteAddress, org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities capabilities)
GeckoDriver(org.openqa.selenium.Capabilities capabilities)
GeckoDriver(org.openqa.selenium.remote.http.ClientConfig clientConfig, org.openqa.selenium.Capabilities capabilities)	Creates a new instance based on the given ClientConfig and capabilities.
GeckoDriver(org.openqa.selenium.remote.http.HttpClient.Factory httpClientFactory, org.openqa.selenium.Capabilities capabilities)
GeckoDriver(org.openqa.selenium.remote.HttpCommandExecutor executor, org.openqa.selenium.Capabilities capabilities)

Method Summary

Methods inherited from class io.appium.java_client.AppiumDriver

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

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

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

isBrowser

Methods inherited from interface org.openqa.selenium.HasCapabilities

getCapabilities

Methods inherited from interface org.openqa.selenium.HasDownloads

requireDownloadsEnabled

Methods inherited from interface io.appium.java_client.HasSettings

getSettings, setSetting, setSetting, setSettings, setSettings

Methods inherited from interface org.openqa.selenium.JavascriptExecutor

executeScript, getPinnedScripts, pin, unpin

Methods inherited from interface io.appium.java_client.LogsEvents

getEvents, logEvent

Constructor Detail

GeckoDriver

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

GeckoDriver

public GeckoDriver(java.net.URL remoteAddress,
                   org.openqa.selenium.Capabilities capabilities)

GeckoDriver

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

GeckoDriver

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

GeckoDriver

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

GeckoDriver

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

GeckoDriver

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

GeckoDriver

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

GeckoDriver

public GeckoDriver(java.net.URL remoteSessionAddress,
                   java.lang.String platformName)

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.

platformName - The name of the target platform.

GeckoDriver

public GeckoDriver(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));
 GeckoOptions options = new GeckoOptions();
 GeckoDriver driver = new GeckoDriver(clientConfig, options);

 

Parameters:

clientConfig - take a look at ClientConfig

capabilities - take a look at Capabilities

GeckoDriver

public GeckoDriver(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));
 GeckoOptions options = new GeckoOptions();
 GeckoDriver driver = new GeckoDriver(options, appiumClientConfig);

 

Parameters:

appiumClientConfig - take a look at AppiumClientConfig

capabilities - take a look at Capabilities

GeckoDriver

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