API Docs for: 0.0.6
Show:

FirefoxDriver.Commands.WebDriver.Ime Class

Defined in: lib/commands/webdriver/ime.js:27
Module: FirefoxDriver

Ime related WebDriver endpoints see JsonWireProtocol

Methods

activatedEngine

(
  • sessionId
)

Defined in lib/commands/webdriver/ime.js:97

Indicates whether IME input is active at the moment

Parameters:

  • sessionId GET

    ID of the session to route the command to

activateEngine

(
  • sessionId
  • engine
)

Defined in lib/commands/webdriver/ime.js:125

Make an engines that is available (appears on the list returned by getAvailableEngines) active. After this call, the engine will be added to the list of engines loaded in the IME daemon and the input sent using sendKeys will be converted by the active engine. Note that this is a platform-independent method of activating IME (the platform-specific way being using keyboard shortcuts)

Parameters:

  • sessionId GET

    ID of the session to route the command to

  • engine POST

    Name of the engine to activate

activeEngine

(
  • sessionId
)

Defined in lib/commands/webdriver/ime.js:82

Get the name of the active IME engine. The name string is platform specific.

Parameters:

  • sessionId GET

    ID of the session to route the command to

availableEngines

(
  • sessionId
)

Defined in lib/commands/webdriver/ime.js:67

List all available engines on the machine. To use an engine, it has to be present in this list.

Parameters:

  • sessionId GET

    ID of the session to route the command to

deactivateEngine

(
  • sessionId
)

Defined in lib/commands/webdriver/ime.js:111

De-activates the currently-active IME engine

Parameters:

  • sessionId GET

    ID of the session to route the command to

status

() 200

Defined in lib/commands/webdriver/ime.js:38

Query the server's current status. The server should respond with a general "HTTP 200 OK" response if it is alive and accepting commands. The response body should be a JSON object describing the state of the server. All server implementations should return two basic objects describing the server's current platform and when the server was built. All fields are optional; if omitted, the client should assume the value is uknown. Furthermore, server implementations may include additional fields not listed here.

Returns:

200:

Always up