Class ElectronDriver

java.lang.Object

org.openqa.selenium.remote.RemoteWebDriver

org.openqa.selenium.chromium.ChromiumDriver

org.openqa.selenium.chrome.ElectronDriver

All Implemented Interfaces:

HasBiDi, HasCasting, HasCdp, HasLaunchApp, HasNetworkConditions, HasPermissions, HasDevTools, HasFederatedCredentialManagement, HasAuthentication, HasCapabilities, HasDownloads, Interactive, JavascriptExecutor, HasLogEvents, PrintsPage, SearchContext, TakesScreenshot, HasVirtualAuthenticator, WebDriver

public class ElectronDriver
extends ChromiumDriver

A WebDriver implementation that controls an Electron application running on the local machine. Driver lifecycle and discovery are managed by ChromeDriverService.

Casting and Chrome DevTools Protocol commands are not supported on Electron sessions.

See Also:

• ElectronOptions

Nested Class Summary

Nested classes/interfaces inherited from class RemoteWebDriver

RemoteWebDriver.RemoteTargetLocator, RemoteWebDriver.RemoteWebDriverOptions, RemoteWebDriver.When

Nested classes/interfaces inherited from interface HasDownloads

HasDownloads.DownloadedFile

Nested classes/interfaces inherited from interface WebDriver

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

Field Summary

Fields inherited from class ChromiumDriver

casting, cdp, IS_CHROMIUM_BROWSER

Fields inherited from class RemoteWebDriver

capabilities

Constructor Summary

Constructors

Constructor	Description
ElectronDriver(ChromeDriverService service, ElectronOptions options)
ElectronDriver(ChromeDriverService service, ElectronOptions options, ClientConfig clientConfig)
ElectronDriver(ElectronOptions options)
ElectronDriver(ElectronOptions options, ClientConfig clientConfig)

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	executeCdpCommand(String commandName, Map<String,Object> parameters)	Execute a Chrome DevTools Protocol command and get returned result.
String	getCastIssueMessage()
List<Map<String,String>>	getCastSinks()	Returns the list of cast sinks (Cast devices) available to the Chrome media router.
void	selectCastSink(String deviceName)	Selects a cast sink (Cast device) as the recipient of media router intents (connect or play).
void	startDesktopMirroring(String deviceName)	Initiates desktop mirroring for the current browser tab on the specified device.
void	startTabMirroring(String deviceName)	Initiates tab mirroring for the current browser tab on the specified device.
void	stopCasting(String deviceName)	Stops casting from media router to the specified device, if connected.

Methods inherited from class ChromiumDriver

deleteNetworkConditions, executeScript, getCapabilities, getNetworkConditions, getPinnedScripts, launchApp, maybeGetDevTools, onLogEvent, pin, register, setFileDetector, setNetworkConditions, setPermission, unpin

Methods inherited from class RemoteWebDriver

addVirtualAuthenticator, builder, close, deleteDownloadableFiles, downloadFile, execute, execute, execute, executeAsyncScript, executeScript, findElement, findElements, findElements, fireSessionEvent, fireSessionEvent, get, getClientConfig, getCommandExecutor, getCurrentUrl, getDownloadableFiles, getDownloadedFiles, getElementConverter, getErrorHandler, getExecuteMethod, getFederatedCredentialManagementDialog, getFileDetector, getHandle, getPageSource, getScreenshotAs, getSessionId, getTitle, getWindowHandle, getWindowHandles, isDownloadsEnabled, log, manage, maybeGetBiDi, navigate, network, perform, print, quit, removeVirtualAuthenticator, resetCooldown, resetInputState, script, setCommandExecutor, setDelayEnabled, setElementConverter, setErrorHandler, setFoundBy, setLogLevel, setSessionId, startSession, switchTo, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface HasAuthentication

register

Methods inherited from interface HasBiDi

getBiDi, getHandle, maybeGetBiDi

Methods inherited from interface HasDevTools

getDevTools

Methods inherited from interface HasDownloads

requireDownloadsEnabled

Constructor Details

ElectronDriver

public ElectronDriver(ElectronOptions options)

ElectronDriver

public ElectronDriver(ElectronOptions options,
 ClientConfig clientConfig)

ElectronDriver

public ElectronDriver(ChromeDriverService service,
 ElectronOptions options)

ElectronDriver

public ElectronDriver(ChromeDriverService service,
 ElectronOptions options,
 ClientConfig clientConfig)

Method Details

getCastSinks

public List<Map<String,String>> getCastSinks()

Description copied from interface: HasCasting

Returns the list of cast sinks (Cast devices) available to the Chrome media router.

Specified by:

getCastSinks in interface HasCasting

Overrides:

getCastSinks in class ChromiumDriver

Returns:

list of ID / Name pairs of available cast sink targets

getCastIssueMessage

public String getCastIssueMessage()

Specified by:

getCastIssueMessage in interface HasCasting

Overrides:

getCastIssueMessage in class ChromiumDriver

Returns:

an error message if there is any issue in a Cast session.

selectCastSink

public void selectCastSink(String deviceName)

Description copied from interface: HasCasting

Selects a cast sink (Cast device) as the recipient of media router intents (connect or play).

Specified by:

selectCastSink in interface HasCasting

Overrides:

selectCastSink in class ChromiumDriver

Parameters:

deviceName - name of the target device.

startDesktopMirroring

public void startDesktopMirroring(String deviceName)

Description copied from interface: HasCasting

Initiates desktop mirroring for the current browser tab on the specified device.

Specified by:

startDesktopMirroring in interface HasCasting

Overrides:

startDesktopMirroring in class ChromiumDriver

Parameters:

deviceName - name of the target device.

startTabMirroring

public void startTabMirroring(String deviceName)

Description copied from interface: HasCasting

Initiates tab mirroring for the current browser tab on the specified device.

Specified by:

startTabMirroring in interface HasCasting

Overrides:

startTabMirroring in class ChromiumDriver

Parameters:

deviceName - name of the target device.

stopCasting

public void stopCasting(String deviceName)

Description copied from interface: HasCasting

Stops casting from media router to the specified device, if connected.

Specified by:

stopCasting in interface HasCasting

Overrides:

stopCasting in class ChromiumDriver

Parameters:

deviceName - name of the target device.

executeCdpCommand

public Map<String,Object> executeCdpCommand(String commandName,
 Map<String,Object> parameters)

Description copied from interface: HasCdp

Execute a Chrome DevTools Protocol command and get returned result. The command and command args should follow chrome devtools protocol domains/commands.

It is strongly encouraged to use DevTools API instead of this

Specified by:

executeCdpCommand in interface HasCdp

Overrides:

executeCdpCommand in class ChromiumDriver

Parameters:

commandName - the command to execute with Chrome Dev Tools.

parameters - any information needed to execute the Dev Tools command.

Returns:

the name and value of the response.