Class Input

javascript/selenium-webdriver/bidi/input.js:27–104

* Represents commands and events related to the Input module (simulated user input). * Described in https://w3c.github.io/webdriver-bidi/#module-input.

 * Described in https://w3c.github.io/webdriver-bidi/#module-input.
 */
class Input {
  constructor(driver) {
    this._driver = driver
  }

  async init() {
    if (!(await this._driver.getCapabilities()).get('webSocketUrl')) {
      throw Error('WebDriver instance must support BiDi protocol')
    }

    this.bidi = await this._driver.getBidi()
  }

  /**
   * Performs the specified actions on the given browsing context.
   *
   * @param {string} browsingContextId - The ID of the browsing context.
   * @param {Array} actions - The actions to be performed.
   * @returns {Promise} A promise that resolves with the response from the server.
   */
  async perform(browsingContextId, actions) {
    const _actions = await updateActions(actions)

    const command = {
      method: 'input.performActions',
      params: {
        context: browsingContextId,
        actions: _actions,
      },
    }

    return await this.bidi.send(command)
  }

  /**
   * Resets the input state in the specified browsing context.
   *
   * @param {string} browsingContextId - The ID of the browsing context.
   * @returns {Promise} A promise that resolves when the release actions are sent.
   */
  async release(browsingContextId) {
    const command = {
      method: 'input.releaseActions',
      params: {
        context: browsingContextId,
      },
    }
    return await this.bidi.send(command)
  }

  /**
   * Sets the files property of a given input element.
   *
   * @param {string} browsingContextId - The ID of the browsing context.
   * @param {string | ReferenceValue} element - The ID of the element or a ReferenceValue object representing the element.
   * @param {string | string[]} files - The file path or an array of file paths to be set.
   * @throws {Error} If the element is not a string or a ReferenceValue.
   * @returns {Promise<void>} A promise that resolves when the files are set.