Class: Selenium::WebDriver::Remote::Bridge Private

Inherits:

Object

Object
Selenium::WebDriver::Remote::Bridge

show all

Includes:

Defined in:

rb/lib/selenium/webdriver/remote/bridge.rb,
rb/lib/selenium/webdriver/remote/commands.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Direct Known Subclasses

Android::Bridge, Chrome::Bridge, Firefox::Bridge, IE::Bridge, IPhone::Bridge, Opera::Bridge, Safari::Bridge

Constant Summary

QUIT_ERRORS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

[IOError]

Instance Attribute Summary (collapse)

- (Object) capabilities readonly private
- (Object) context private
- (Object) file_detector private
- (Object) http private

Class Method Summary (collapse)

+ (Object) command(name, verb, url) private

Defines a wrapper method for a command, which ultimately calls #execute.

Instance Method Summary (collapse)

- (Object) acceptAlert private
- (Object) addCookie(cookie) private

cookies.
- (Object) browser private
- (Object) clearElement(element) private
- (Object) clearLocalStorage private
- (Object) clearSessionStorage private
- (Object) click private
- (Object) clickElement(element) private

actions.
- (Object) close private
- (Object) contextClick private
- (Object) create_session(desired_capabilities) private
- (Object) deleteAllCookies private
- (Object) deleteCookie(name) private
- (Object) dismissAlert private
- (Object) doubleClick private
- (Object) dragElement(element, right_by, down_by) private
- (Object) driver_extensions private
- (Object) elementEquals(element, other) private
- (Object) executeAsyncScript(script, *args) private
- (Object) executeScript(script, *args) private

javascript execution.
- (Object) find_element_by(how, what, parent = nil) private
- (Object) find_elements_by(how, what, parent = nil) private
- (Object) get(url) private
- (Object) getActiveElement (also: #switchToActiveElement) private

finding elements.
- (Object) getAlert private

alerts.
- (Object) getAlertText private
- (Object) getAllCookies private
- (Object) getCapabilities private
- (Object) getCurrentUrl private
- (Object) getCurrentWindowHandle private
- (Object) getElementAttribute(element, name) private
- (Object) getElementLocation(element) private
- (Object) getElementLocationOnceScrolledIntoView(element) private
- (Object) getElementSize(element) private
- (Object) getElementTagName(element) private

element properties.
- (Object) getElementText(element) private
- (Object) getElementValue(element) private
- (Object) getElementValueOfCssProperty(element, prop) private
- (Object) getLocalStorageItem(key) private

HTML 5.
- (Object) getLocalStorageKeys private
- (Object) getLocalStorageSize private
- (Object) getLocation private
- (Object) getPageSource private
- (Object) getScreenshot private
- (Object) getSessionStorageItem(key) private
- (Object) getSessionStorageKeys private
- (Object) getSessionStorageSize private
- (Object) getTitle private
- (Object) getVisible private
- (Object) getWindowHandles private

window handling.
- (Object) getWindowPosition(handle = :current) private
- (Object) getWindowSize(handle = :current) private
- (Object) goBack private

navigation.
- (Object) goForward private
- (Bridge) initialize(opts = {}) constructor private

Initializes the bridge with the given server URL.
- (Object) isBrowserOnline private
- (Object) isElementDisplayed(element) private
- (Object) isElementEnabled(element) private
- (Object) isElementSelected(element) private
- (Object) maximizeWindow(handle = :current) private
- (Object) mouseDown private
- (Object) mouseMoveTo(element, x = nil, y = nil) private
- (Object) mouseUp private
- (Object) quit private
- (Object) refresh private
- (Object) removeLocalStorageItem(key) private
- (Object) removeSessionStorageItem(key) private
- (Object) sendKeysToActiveElement(key) private
- (Object) sendKeysToElement(element, keys) private
- (Object) session_id private

Returns the current session ID.
- (Object) setAlertValue(keys) private
- (Object) setBrowserOnline(bool) private
- (Object) setImplicitWaitTimeout(milliseconds) private
- (Object) setLocalStorageItem(key, value) private
- (Object) setLocation(lat, lon, alt) private
- (Object) setScriptTimeout(milliseconds) private
- (Object) setSessionStorageItem(key, value) private
- (Object) setTimeout(type, milliseconds) private
- (Object) setVisible(bool) private
- (Object) setWindowPosition(x, y, handle = :current) private
- (Object) setWindowSize(width, height, handle = :current) private
- (Object) submitElement(element) private
- (Object) switchToDefaultContent private
- (Object) switchToFrame(id) private
- (Object) switchToWindow(name) private
- (Object) touchDoubleTap(element) private
- (Object) touchDown(x, y) private
- (Object) touchElementFlick(element, right_by, down_by, speed) private
- (Object) touchFlick(xspeed, yspeed) private
- (Object) touchLongPress(element) private
- (Object) touchMove(x, y) private
- (Object) touchScroll(element, x, y) private
- (Object) touchSingleTap(element) private
- (Object) touchUp(x, y) private
- (Object) upload(local_file) private

Methods included from BridgeHelper

#element_id_from, #parse_cookie_string, #unwrap_script_result

Constructor Details

- (`Bridge`) initialize(opts = {})

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Initializes the bridge with the given server URL.

Parameters:

url (String) —

url for the remote server
http_client (Object) —

an HTTP client instance that implements the same protocol as Http::Default
desired_capabilities (Capabilities) —

an instance of Remote::Capabilities describing the capabilities you want

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 43

def initialize(opts = {})
  opts = opts.dup

  http_client          = opts.delete(:http_client) { Http::Default.new }
  desired_capabilities = opts.delete(:desired_capabilities) { Capabilities.firefox }
  url                  = opts.delete(:url) { "http://#{Platform.localhost}:4444/wd/hub" }

  unless opts.empty?
    raise ArgumentError, "unknown option#{'s' if opts.size != 1}: #{opts.inspect}"
  end

  if desired_capabilities.kind_of?(Symbol)
    unless Capabilities.respond_to?(desired_capabilities)
      raise Error::WebDriverError, "invalid desired capability: #{desired_capabilities.inspect}"
    end

    desired_capabilities = Capabilities.send(desired_capabilities)
  end

  uri = url.kind_of?(URI) ? url : URI.parse(url)
  uri.path += "/" unless uri.path =~ /\/$/

  http_client.server_url = uri

  @http          = http_client
  @capabilities  = create_session(desired_capabilities)
end

Instance Attribute Details

- (`Object`) capabilities (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



33
34
35

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 33

def capabilities
  @capabilities
end

- (`Object`) context

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



32
33
34

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 32

def context
  @context
end

- (`Object`) file_detector

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



32
33
34

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 32

def file_detector
  @file_detector
end

- (`Object`) http

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



32
33
34

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 32

def http
  @http
end

Class Method Details

+ (`Object`) command(name, verb, url)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Defines a wrapper method for a command, which ultimately calls #execute.

Parameters:

name (Symbol) —

name of the resulting method
url (String) —

a URL template, which can include some arguments, much like the definitions on the server. the :session_id parameter is implicitly handled, but the remainder will become required method arguments.
verb (Symbol) —

the appropriate http verb, such as :get, :post, or :delete



28
29
30

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 28

def self.command(name, verb, url)
  COMMANDS[name] = [verb, url.freeze]
end

Instance Method Details

- (`Object`) acceptAlert

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



126
127
128

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 126

def acceptAlert
  execute :acceptAlert
end

- (`Object`) addCookie(cookie)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



337
338
339

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 337

def addCookie(cookie)
  execute :addCookie, {}, :cookie => cookie
end

- (`Object`) browser

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



71
72
73

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 71

def browser
  @browser ||= @capabilities.browser_name.gsub(" ", "_").to_sym
end

- (`Object`) clearElement(element)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



411
412
413

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 411

def clearElement(element)
  execute :clearElement, :id => element
end

- (`Object`) clearLocalStorage

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



265
266
267

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 265

def clearLocalStorage
  execute :clearLocalStorage
end

- (`Object`) clearSessionStorage

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



289
290
291

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 289

def clearSessionStorage
  execute :clearSessionStorage
end

- (`Object`) click

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



361
362
363

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 361

def click
  execute :click, {}, :button => 0
end

- (`Object`) clickElement(element)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

actions



357
358
359

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 357

def clickElement(element)
  execute :clickElement, :id => element
end

- (`Object`) close

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



194
195
196

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 194

def close
  execute :close
end

- (`Object`) contextClick

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



369
370
371

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 369

def contextClick
  execute :click, {}, :button => 2
end

- (`Object`) create_session(desired_capabilities)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 91

def create_session(desired_capabilities)
  resp = raw_execute :newSession, {}, :desiredCapabilities => desired_capabilities
  @session_id = resp['sessionId'] or raise Error::WebDriverError, 'no sessionId in returned payload'

  Capabilities.json_create resp['value']
end

- (`Object`) deleteAllCookies

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



349
350
351

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 349

def deleteAllCookies
  execute :deleteAllCookies
end

- (`Object`) deleteCookie(name)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



341
342
343

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 341

def deleteCookie(name)
  execute :deleteCookie, :name => name
end

- (`Object`) dismissAlert

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



130
131
132

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 130

def dismissAlert
  execute :dismissAlert
end

- (`Object`) doubleClick

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



365
366
367

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 365

def doubleClick
  execute :doubleClick
end

- (`Object`) dragElement(element, right_by, down_by)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



420
421
422

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 420

def dragElement(element, right_by, down_by)
  execute :dragElement, {:id => element}, :x => right_by, :y => down_by
end

- (`Object`) driver_extensions

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 75

def driver_extensions
  [
    DriverExtensions::HasInputDevices,
    DriverExtensions::UploadsFiles,
    DriverExtensions::TakesScreenshot
  ]
end

- (`Object`) elementEquals(element, other)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 523

def elementEquals(element, other)
  if element.ref == other.ref
    true
  else
    execute :elementEquals, :id => element.ref, :other => other.ref
  end
end

- (`Object`) executeAsyncScript(script, *args)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 326

def executeAsyncScript(script, *args)
  assert_javascript_enabled

  result = execute :executeAsyncScript, {}, :script => script, :args => args
  unwrap_script_result result
end

- (`Object`) executeScript(script, *args)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

javascript execution

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 319

def executeScript(script, *args)
  assert_javascript_enabled

  result = execute :executeScript, {}, :script => script, :args => args
  unwrap_script_result result
end

- (`Object`) find_element_by(how, what, parent = nil)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 540

def find_element_by(how, what, parent = nil)
  if parent
    id = execute :findChildElement, {:id => parent}, {:using => how, :value => what}
  else
    id = execute :findElement, {}, {:using => how, :value => what}
  end

  Element.new self, element_id_from(id)
end

- (`Object`) find_elements_by(how, what, parent = nil)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 550

def find_elements_by(how, what, parent = nil)
  if parent
    ids = execute :findChildElements, {:id => parent}, {:using => how, :value => what}
  else
    ids = execute :findElements, {}, {:using => how, :value => what}
  end

  ids.map { |id| Element.new self, element_id_from(id) }
end

- (`Object`) get(url)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



98
99
100

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 98

def get(url)
  execute :get, {}, :url => url
end

- (`Object`) getActiveElement Also known as: switchToActiveElement

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

finding elements



535
536
537

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 535

def getActiveElement
  Element.new self, element_id_from(execute(:getActiveElement))
end

- (`Object`) getAlert

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

alerts



122
123
124

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 122

def getAlert
  execute :getAlert
end

- (`Object`) getAlertText

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



138
139
140

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 138

def getAlertText
  execute :getAlertText
end

- (`Object`) getAllCookies

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



345
346
347

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 345

def getAllCookies
  execute :getCookies
end

- (`Object`) getCapabilities

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



102
103
104

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 102

def getCapabilities
  Capabilities.json_create execute(:getCapabilities)
end

- (`Object`) getCurrentUrl

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



154
155
156

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 154

def getCurrentUrl
  execute :getCurrentUrl
end

- (`Object`) getCurrentWindowHandle

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



210
211
212

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 210

def getCurrentWindowHandle
  execute :getCurrentWindowHandle
end

- (`Object`) getElementAttribute(element, name)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



478
479
480

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 478

def getElementAttribute(element, name)
  execute :getElementAttribute, :id => element, :name => name
end

- (`Object`) getElementLocation(element)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 490

def getElementLocation(element)
  data = execute :getElementLocation, :id => element

  Point.new data['x'], data['y']
end

- (`Object`) getElementLocationOnceScrolledIntoView(element)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 496

def getElementLocationOnceScrolledIntoView(element)
  data = execute :getElementLocationOnceScrolledIntoView, :id => element

  Point.new data['x'], data['y']
end

- (`Object`) getElementSize(element)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 502

def getElementSize(element)
  data = execute :getElementSize, :id => element

  Dimension.new data['width'], data['height']
end

- (`Object`) getElementTagName(element)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

element properties



474
475
476

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 474

def getElementTagName(element)
  execute :getElementTagName, :id => element
end

- (`Object`) getElementText(element)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



486
487
488

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 486

def getElementText(element)
  execute :getElementText, :id => element
end

- (`Object`) getElementValue(element)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



482
483
484

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 482

def getElementValue(element)
  execute :getElementValue, :id => element
end

- (`Object`) getElementValueOfCssProperty(element, prop)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



519
520
521

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 519

def getElementValueOfCssProperty(element, prop)
  execute :getElementValueOfCssProperty, :id => element, :property_name => prop
end

- (`Object`) getLocalStorageItem(key)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

HTML 5



249
250
251

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 249

def getLocalStorageItem(key)
  execute :getLocalStorageItem, :key => key
end

- (`Object`) getLocalStorageKeys

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



257
258
259

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 257

def getLocalStorageKeys
  execute :getLocalStorageKeys
end

- (`Object`) getLocalStorageSize

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



269
270
271

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 269

def getLocalStorageSize
  execute :getLocalStorageSize
end

- (`Object`) getLocation

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 297

def getLocation
  obj = execute(:getLocation) || {} # android returns null
  Location.new obj['latitude'], obj['longitude'], obj['altitude']
end

- (`Object`) getPageSource

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



162
163
164

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 162

def getPageSource
  execute :getPageSource
end

- (`Object`) getScreenshot

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



241
242
243

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 241

def getScreenshot
  execute :screenshot
end

- (`Object`) getSessionStorageItem(key)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



273
274
275

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 273

def getSessionStorageItem(key)
  execute :getSessionStorageItem, :key => key
end

- (`Object`) getSessionStorageKeys

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



281
282
283

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 281

def getSessionStorageKeys
  execute :getSessionStorageKeys
end

- (`Object`) getSessionStorageSize

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



293
294
295

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 293

def getSessionStorageSize
  execute :getSessionStorageSize
end

- (`Object`) getTitle

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



158
159
160

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 158

def getTitle
  execute :getTitle
end

- (`Object`) getVisible

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



166
167
168

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 166

def getVisible
  execute :getVisible
end

- (`Object`) getWindowHandles

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

window handling



206
207
208

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 206

def getWindowHandles
  execute :getWindowHandles
end

- (`Object`) getWindowPosition(handle = :current)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 235

def getWindowPosition(handle = :current)
  data = execute :getWindowPosition, :window_handle => handle

  Point.new data['x'], data['y']
end

- (`Object`) getWindowSize(handle = :current)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 224

def getWindowSize(handle = :current)
  data = execute :getWindowSize, :window_handle => handle

  Dimension.new data['width'], data['height']
end

- (`Object`) goBack

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

navigation



146
147
148

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 146

def goBack
  execute :goBack
end

- (`Object`) goForward

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



150
151
152

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 150

def goForward
  execute :goForward
end

- (`Object`) isBrowserOnline

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



307
308
309

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 307

def isBrowserOnline
  execute :isBrowserOnline
end

- (`Object`) isElementDisplayed(element)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



516
517
518

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 516

def isElementDisplayed(element)
  execute :isElementDisplayed, :id => element
end

- (`Object`) isElementEnabled(element)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



508
509
510

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 508

def isElementEnabled(element)
  execute :isElementEnabled, :id => element
end

- (`Object`) isElementSelected(element)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



512
513
514

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 512

def isElementSelected(element)
  execute :isElementSelected, :id => element
end

- (`Object`) maximizeWindow(handle = :current)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



220
221
222

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 220

def maximizeWindow(handle = :current)
  execute :maximizeWindow, :window_handle => handle
end

- (`Object`) mouseDown

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



373
374
375

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 373

def mouseDown
  execute :mouseDown
end

- (`Object`) mouseMoveTo(element, x = nil, y = nil)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 381

def mouseMoveTo(element, x = nil, y = nil)
  params = { :element => element }

  if x && y
    params.merge! :xoffset => x, :yoffset => y
  end

  execute :mouseMoveTo, {}, params
end

- (`Object`) mouseUp

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



377
378
379

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 377

def mouseUp
  execute :mouseUp
end

- (`Object`) quit

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 188

def quit
  execute :quit
  http.close
rescue *QUIT_ERRORS
end

- (`Object`) refresh

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



198
199
200

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 198

def refresh
  execute :refresh
end

- (`Object`) removeLocalStorageItem(key)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



253
254
255

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 253

def removeLocalStorageItem(key)
  execute :removeLocalStorageItem, :key => key
end

- (`Object`) removeSessionStorageItem(key)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



277
278
279

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 277

def removeSessionStorageItem(key)
  execute :removeSessionStorageItem, :key => key
end

- (`Object`) sendKeysToActiveElement(key)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



391
392
393

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 391

def sendKeysToActiveElement(key)
  execute :sendKeysToActiveElement, {}, :value => key
end

- (`Object`) sendKeysToElement(element, keys)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 395

def sendKeysToElement(element, keys)
  if @file_detector && local_file = @file_detector.call(keys)
    keys = upload(local_file)
  end

  execute :sendKeysToElement, {:id => element}, {:value => Array(keys)}
end

- (`Object`) session_id

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the current session ID.



87
88
89

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 87

def session_id
  @session_id || raise(Error::WebDriverError, "no current session exists")
end

- (`Object`) setAlertValue(keys)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



134
135
136

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 134

def setAlertValue(keys)
  execute :setAlertValue, {}, :text => keys.to_s
end

- (`Object`) setBrowserOnline(bool)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



311
312
313

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 311

def setBrowserOnline(bool)
  execute :setBrowserOnline, {}, :state => bool
end

- (`Object`) setImplicitWaitTimeout(milliseconds)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



106
107
108

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 106

def setImplicitWaitTimeout(milliseconds)
  execute :implicitlyWait, {}, :ms => milliseconds
end

- (`Object`) setLocalStorageItem(key, value)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



261
262
263

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 261

def setLocalStorageItem(key, value)
  execute :setLocalStorageItem, {}, :key => key, :value => value
end

- (`Object`) setLocation(lat, lon, alt)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 302

def setLocation(lat, lon, alt)
  loc = {:latitude => lat, :longitude => lon, :altitude => alt}
  execute :setLocation, {}, :location => loc
end

- (`Object`) setScriptTimeout(milliseconds)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



110
111
112

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 110

def setScriptTimeout(milliseconds)
  execute :setScriptTimeout, {}, :ms => milliseconds
end

- (`Object`) setSessionStorageItem(key, value)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



285
286
287

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 285

def setSessionStorageItem(key, value)
  execute :setSessionStorageItem, {}, :key => key, :value => value
end

- (`Object`) setTimeout(type, milliseconds)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



114
115
116

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 114

def setTimeout(type, milliseconds)
  execute :setTimeout, {}, :type => type, :ms => milliseconds
end

- (`Object`) setVisible(bool)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



170
171
172

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 170

def setVisible(bool)
  execute :setVisible, {}, bool
end

- (`Object`) setWindowPosition(x, y, handle = :current)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 230

def setWindowPosition(x, y, handle = :current)
  execute :setWindowPosition, {:window_handle => handle},
                               :x => x, :y => y
end

- (`Object`) setWindowSize(width, height, handle = :current)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 214

def setWindowSize(width, height, handle = :current)
  execute :setWindowSize, {:window_handle => handle},
                           :width  => width,
                           :height => height
end

- (`Object`) submitElement(element)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



416
417
418

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 416

def submitElement(element)
  execute :submitElement, :id => element
end

- (`Object`) switchToDefaultContent

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



182
183
184

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 182

def switchToDefaultContent
  execute :switchToFrame, {}, :id => nil
end

- (`Object`) switchToFrame(id)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



178
179
180

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 178

def switchToFrame(id)
  execute :switchToFrame, {}, :id => id
end

- (`Object`) switchToWindow(name)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



174
175
176

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 174

def switchToWindow(name)
  execute :switchToWindow, {}, :name => name
end

- (`Object`) touchDoubleTap(element)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



428
429
430

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 428

def touchDoubleTap(element)
  execute :touchDoubleTap, {}, :element => element
end

- (`Object`) touchDown(x, y)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



436
437
438

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 436

def touchDown(x, y)
  execute :touchDown, {}, :x => x, :y => y
end

- (`Object`) touchElementFlick(element, right_by, down_by, speed)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 462

def touchElementFlick(element, right_by, down_by, speed)
  execute :touchFlick, {}, :element => element,
                           :xoffset => right_by,
                           :yoffset => down_by,
                           :speed   => speed

end

- (`Object`) touchFlick(xspeed, yspeed)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



458
459
460

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 458

def touchFlick(xspeed, yspeed)
  execute :touchFlick, {}, :xspeed => xspeed, :yspeed => yspeed
end

- (`Object`) touchLongPress(element)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



432
433
434

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 432

def touchLongPress(element)
  execute :touchLongPress, {}, :element => element
end

- (`Object`) touchMove(x, y)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



444
445
446

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 444

def touchMove(x, y)
  execute :touchMove, {}, :x => x, :y => y
end

- (`Object`) touchScroll(element, x, y)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 448

def touchScroll(element, x, y)
  if element
    execute :touchScroll, {}, :xoffset => x, :yoffset => y
  else
    execute :touchScroll, {}, :element => element,
                              :xoffset => x,
                              :yoffset => y
  end
end

- (`Object`) touchSingleTap(element)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



424
425
426

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 424

def touchSingleTap(element)
  execute :touchSingleTap, {}, :element => element
end

- (`Object`) touchUp(x, y)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



440
441
442

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 440

def touchUp(x, y)
  execute :touchUp, {}, :x => x, :y => y
end

- (`Object`) upload(local_file)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

# File 'rb/lib/selenium/webdriver/remote/bridge.rb', line 403

def upload(local_file)
  unless File.file?(local_file)
    raise WebDriverError::Error, "you may only upload files: #{local_file.inspect}"
  end

  execute :uploadFile, {}, :file => Zipper.zip_file(local_file)
end

Class: Selenium::WebDriver::Remote::Bridge Private

Direct Known Subclasses

Constant Summary

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Methods included from BridgeHelper

Constructor Details

- (Bridge) initialize(opts = {})

Instance Attribute Details

- (Object) capabilities (readonly)

- (Object) context

- (Object) file_detector

- (Object) http

Class Method Details

+ (Object) command(name, verb, url)

Instance Method Details

- (Object) acceptAlert

- (Object) addCookie(cookie)

- (Object) browser

- (Object) clearElement(element)

- (Object) clearLocalStorage

- (Object) clearSessionStorage

- (Object) click

- (Object) clickElement(element)

- (Object) close

- (Object) contextClick

- (Object) create_session(desired_capabilities)

- (Object) deleteAllCookies

- (Object) deleteCookie(name)

- (Object) dismissAlert

- (Object) doubleClick

- (Object) dragElement(element, right_by, down_by)

- (Object) driver_extensions

- (Object) elementEquals(element, other)

- (Object) executeAsyncScript(script, *args)

- (Object) executeScript(script, *args)

- (Object) find_element_by(how, what, parent = nil)

- (Object) find_elements_by(how, what, parent = nil)

- (Object) get(url)

- (Object) getActiveElement Also known as: switchToActiveElement

- (Object) getAlert

- (Object) getAlertText

- (Object) getAllCookies

- (Object) getCapabilities

- (Object) getCurrentUrl

- (Object) getCurrentWindowHandle

- (Object) getElementAttribute(element, name)

- (Object) getElementLocation(element)

- (Object) getElementLocationOnceScrolledIntoView(element)

- (Object) getElementSize(element)

- (Object) getElementTagName(element)

- (Object) getElementText(element)

- (Object) getElementValue(element)

- (Object) getElementValueOfCssProperty(element, prop)

- (Object) getLocalStorageItem(key)

- (Object) getLocalStorageKeys

- (Object) getLocalStorageSize

- (Object) getLocation

- (Object) getPageSource

- (Object) getScreenshot

- (Object) getSessionStorageItem(key)

- (Object) getSessionStorageKeys

- (Object) getSessionStorageSize

- (Object) getTitle

- (Object) getVisible

- (Object) getWindowHandles

- (Object) getWindowPosition(handle = :current)

- (Object) getWindowSize(handle = :current)

- (Object) goBack

- (Object) goForward

- (Object) isBrowserOnline

- (Object) isElementDisplayed(element)

- (Object) isElementEnabled(element)

- (Object) isElementSelected(element)

- (Object) maximizeWindow(handle = :current)

- (Object) mouseDown

- (Object) mouseMoveTo(element, x = nil, y = nil)

- (Object) mouseUp

- (Object) quit

- (`Bridge`) initialize(opts = {})

- (`Object`) capabilities (readonly)

- (`Object`) context

- (`Object`) file_detector

- (`Object`) http

+ (`Object`) command(name, verb, url)

- (`Object`) acceptAlert

- (`Object`) addCookie(cookie)

- (`Object`) browser

- (`Object`) clearElement(element)

- (`Object`) clearLocalStorage

- (`Object`) clearSessionStorage

- (`Object`) click

- (`Object`) clickElement(element)

- (`Object`) close

- (`Object`) contextClick

- (`Object`) create_session(desired_capabilities)

- (`Object`) deleteAllCookies

- (`Object`) deleteCookie(name)

- (`Object`) dismissAlert

- (`Object`) doubleClick

- (`Object`) dragElement(element, right_by, down_by)

- (`Object`) driver_extensions

- (`Object`) elementEquals(element, other)

- (`Object`) executeAsyncScript(script, *args)

- (`Object`) executeScript(script, *args)

- (`Object`) find_element_by(how, what, parent = nil)

- (`Object`) find_elements_by(how, what, parent = nil)

- (`Object`) get(url)

- (`Object`) getActiveElement Also known as: switchToActiveElement

- (`Object`) getAlert

- (`Object`) getAlertText

- (`Object`) getAllCookies

- (`Object`) getCapabilities

- (`Object`) getCurrentUrl

- (`Object`) getCurrentWindowHandle

- (`Object`) getElementAttribute(element, name)

- (`Object`) getElementLocation(element)

- (`Object`) getElementLocationOnceScrolledIntoView(element)

- (`Object`) getElementSize(element)

- (`Object`) getElementTagName(element)

- (`Object`) getElementText(element)

- (`Object`) getElementValue(element)

- (`Object`) getElementValueOfCssProperty(element, prop)

- (`Object`) getLocalStorageItem(key)

- (`Object`) getLocalStorageKeys

- (`Object`) getLocalStorageSize

- (`Object`) getLocation

- (`Object`) getPageSource

- (`Object`) getScreenshot

- (`Object`) getSessionStorageItem(key)

- (`Object`) getSessionStorageKeys

- (`Object`) getSessionStorageSize

- (`Object`) getTitle

- (`Object`) getVisible

- (`Object`) getWindowHandles

- (`Object`) getWindowPosition(handle = :current)

- (`Object`) getWindowSize(handle = :current)

- (`Object`) goBack

- (`Object`) goForward

- (`Object`) isBrowserOnline

- (`Object`) isElementDisplayed(element)

- (`Object`) isElementEnabled(element)

- (`Object`) isElementSelected(element)

- (`Object`) maximizeWindow(handle = :current)

- (`Object`) mouseDown

- (`Object`) mouseMoveTo(element, x = nil, y = nil)

- (`Object`) mouseUp

- (`Object`) quit

- (`Object`) refresh

- (`Object`) removeLocalStorageItem(key)

- (`Object`) removeSessionStorageItem(key)

- (`Object`) sendKeysToActiveElement(key)

- (`Object`) sendKeysToElement(element, keys)

- (`Object`) session_id

- (`Object`) setAlertValue(keys)

- (`Object`) setBrowserOnline(bool)

- (`Object`) setImplicitWaitTimeout(milliseconds)

- (`Object`) setLocalStorageItem(key, value)

- (`Object`) setLocation(lat, lon, alt)