hideKeyboard.js

import util from "util";
import BaseCommand from "../../base-mobile-command";
import settings from "../../settings";

const MAX_TIMEOUT = settings.COMMAND_MAX_TIMEOUT;
const WAIT_INTERVAL = settings.WAIT_INTERVAL;

const HideKeyboard = function (nightwatch = null) {
  BaseCommand.call(this, nightwatch);
  this.cmd = "hidekeyboard";
};

util.inherits(HideKeyboard, BaseCommand);

HideKeyboard.prototype.do = function (value) {
  this.pass({ actual: value });
};

/* eslint-disable no-magic-numbers */
HideKeyboard.prototype.checkConditions = function () {
  const self = this;

  const options = {
    path: `/session/${this.client.sessionId}/appium/device/hide_keyboard`,
    method: "POST",
    data: {}
  };

  self.protocol(options, (result) => {
    if (result.status === 0) {
      // sucessful
      self.seenCount += 1;
    } else if (result.status === -1 &&
      result.errorStatus === 13) {
      // method not implement, fail immediately
      self.fail({
        code: settings.FAILURE_REASONS.BUILTIN_COMMAND_NOT_SUPPORTED,
        message: self.failureMessage
      });
    }

    const elapsed = (new Date()).getTime() - self.startTime;
    if (self.seenCount >= 1 || elapsed > MAX_TIMEOUT) {
      if (self.seenCount >= 1) {
        const elapse = (new Date()).getTime();
        self.time.executeAsyncTime = elapse - self.startTime;
        self.time.seleniumCallTime = 0;
        self.do(result.value);
      } else {
        self.fail({
          code: settings.FAILURE_REASONS.BUILTIN_COMMAND_TIMEOUT,
          message: self.failureMessage
        });
      }
    } else {
      setTimeout(self.checkConditions, WAIT_INTERVAL);
    }
  });
};

HideKeyboard.prototype.command = function (using, selector, cb) {
  this.selector = selector;
  this.using = using;
  this.cb = cb;

  this.successMessage = "Keyboard was hidden after %d milliseconds.";
  this.failureMessage = "Keyboard wasn't hidden after %d milliseconds.";

  this.startTime = (new Date()).getTime();

  // Track how many times selector is successfully checked by /element protocol
  this.seenCount = 0;
  this.checkConditions();

  return this;
};

module.exports = HideKeyboard;