API Docs for: 0.0.6
Show:

FirefoxDriver.Marionette Class

Defined in: lib/marionette.js:32
Module: FirefoxDriver

Firefox Autotest (Marionette) connection handler & request executor

Methods

_loadCommands

() private chainable

Defined in lib/marionette.js:148

Loads the marionette commands from the commands library

_onData

(
  • data
)
private chainable

Defined in lib/marionette.js:237

Handles the incoming data from the marionette sockets

Parameters:

  • data Buffer

_onError

(
  • err
)
private chainable

Defined in lib/marionette.js:221

Will be called if a socket error occurs

Parameters:

  • err Buffer

_parseMessage

(
  • data
)
Object private

Defined in lib/marionette.js:291

Parses a marionette response message

Parameters:

  • data Buffer

Returns:

Object:

message

_parseRequestKey

(
  • placeholder
  • params
)
String private

Defined in lib/marionette.js:164

Templating function that replaces placeholders in commands with their actual values

Parameters:

  • placeholder String
  • params Object

Returns:

String:

content

_sendCommand

(
  • command
  • deferred
)
private chainable

Defined in lib/marionette.js:307

Issues a command to the marionette server Generates a reference to the last called command, so that we are able to call the right receiver function for the response from marionette

Parameters:

  • command Object
  • deferred Q.promise

addCommand

(
  • command
)
Object public

Defined in lib/marionette.js:111

Generates a function & an event listener for every marionette command

Parameters:

  • command Object

Returns:

Object:

command

connect

(
  • marionettePort
)
Q.promise public

Defined in lib/marionette.js:80

Opens the marionette socket

Parameters:

  • marionettePort Integer

Returns:

Q.promise:

promise

kill

() Q.promise public

Defined in lib/marionette.js:96

Closes the marionette socket & cleans up

Returns:

Q.promise:

promise