Class EdgeDriverService

Namespace

OpenQA.Selenium.Edge

Assembly

WebDriver.dll

Exposes the service provided by the native MicrosoftWebDriver executable.

public sealed class EdgeDriverService : DriverService, ICommandServer, IDisposable

Inheritance

object

DriverService

EdgeDriverService

Implements

ICommandServer

IDisposable

Inherited Members

DriverService.Dispose()

DriverService.Start()

DriverService.ServiceUrl

DriverService.HostName

DriverService.Port

DriverService.SuppressInitialDiagnosticInformation

DriverService.IsRunning

DriverService.HideCommandPromptWindow

DriverService.ProcessId

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

CommandLineArguments

Gets the command-line arguments for the driver service.

protected override string CommandLineArguments { get; }

Property Value

string

HasShutdown

Gets a value indicating whether the service has a shutdown API that can be called to terminate it gracefully before forcing a termination.

protected override bool HasShutdown { get; }

Property Value

bool

Host

Gets or sets the value of the host adapter on which the Edge driver service should listen for connections.

public string Host { get; set; }

Property Value

string

Package

Gets or sets the value of the package the Edge driver service will launch and automate.

public string Package { get; set; }

Property Value

string

TerminationTimeout

Gets a value indicating the time to wait for the service to terminate before forcing it to terminate.

protected override TimeSpan TerminationTimeout { get; }

Property Value

TimeSpan

UseSpecCompliantProtocol

Gets or sets a value indicating whether the EdgeDriverService instance should use the a protocol dialect compliant with the W3C WebDriver Specification.

public bool? UseSpecCompliantProtocol { get; set; }

Property Value

bool?

Remarks

Setting this property to a non-null value for driver executables matched to versions of Windows before the 2018 Fall Creators Update will result in a the driver executable shutting down without execution, and all commands will fail. Do not set this property unless you are certain your version of the MicrosoftWebDriver.exe supports the --w3c and --jwp command-line arguments.

UseVerboseLogging

Gets or sets a value indicating whether the service should use verbose logging.

public bool UseVerboseLogging { get; set; }

Property Value

bool

Methods

CreateDefaultService()

Creates a default instance of the EdgeDriverService.

public static EdgeDriverService CreateDefaultService()

Returns

EdgeDriverService

A EdgeDriverService that implements default settings.

CreateDefaultService(string)

Creates a default instance of the EdgeDriverService using a specified path to the EdgeDriver executable.

public static EdgeDriverService CreateDefaultService(string driverPath)

Parameters

driverPath string

The directory containing the EdgeDriver executable.

Returns

EdgeDriverService

A EdgeDriverService using a random port.

CreateDefaultService(string, string)

Creates a default instance of the EdgeDriverService using a specified path to the EdgeDriver executable with the given name.

public static EdgeDriverService CreateDefaultService(string driverPath, string driverExecutableFileName)

Parameters

driverPath string

The directory containing the EdgeDriver executable.

driverExecutableFileName string

The name of the EdgeDriver executable file.

Returns

EdgeDriverService

A EdgeDriverService using a random port.

CreateDefaultService(string, string, int)

Creates a default instance of the EdgeDriverService using a specified path to the EdgeDriver executable with the given name and listening port.

public static EdgeDriverService CreateDefaultService(string driverPath, string driverExecutableFileName, int port)

Parameters

driverPath string

The directory containing the EdgeDriver executable.

driverExecutableFileName string

The name of the EdgeDriver executable file

port int

The port number on which the driver will listen

Returns

EdgeDriverService

A EdgeDriverService using the specified port.