class Selenium::WebDriver::Edge::Options

Attributes

extension_paths[R]
in_private[RW]
start_page[RW]

Public Class Methods

new(**opts) click to toggle source

Create a new Options instance for Edge.

@example

options = Selenium::WebDriver::Edge::Options.new(in_private: true)
driver = Selenium::WebDriver.for :edge, options: options

@param [Hash] opts the pre-defined options to create the Edge::Options with @option opts [Boolean] :in_private Start in private mode. Default is false @option opts [Array<String>] :extension_paths A list of full paths to extensions to install on startup @option opts [String] :start_page Default page to start with

@see docs.microsoft.com/en-us/microsoft-edge/webdriver

# File lib/selenium/webdriver/edge/options.rb, line 42
def initialize(**opts)
  @in_private = opts.delete(:in_private) || false
  @extension_paths = opts.delete(:extension_paths) || []
  @start_page = opts.delete(:start_page)
end

Public Instance Methods

add_extension_path(path) click to toggle source

Add an extension by local path.

@example

options = Selenium::WebDriver::Edge::Options.new
options.add_extension_path('C:\path\to\extension')

@param [String] path The local path to the extension folder

# File lib/selenium/webdriver/edge/options.rb, line 58
def add_extension_path(path)
  raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.directory?(path)

  @extension_paths << path
end
as_json(*) click to toggle source

@api private

# File lib/selenium/webdriver/edge/options.rb, line 68
def as_json(*)
  opts = {}

  opts['ms:inPrivate'] = true if @in_private
  opts['ms:extensionPaths'] = @extension_paths if @extension_paths.any?
  opts['ms:startPage'] = @start_page if @start_page

  opts
end