nightwatch/lib/api/protocol/appium/setGeolocation.js

Easy to use Node.js based end-to-end testing solution for web applications using the W3C WebDriver API.

const ProtocolAction = require('../_base-action.js');

/**
 * Set the current geolocation of the mobile device.
 *
 * @example
 * module.exports = {
 *   'set geolocation to Tokyo, Japan': function (app) {
 *     app
 *       .appium.setGeolocation({latitude: 35.689487, longitude: 139.691706, altitude: 5});
 *   },
 *
 *   'set geolocation to Tokyo, Japan with ES6 async/await': async function (app) {
 *     await app.appium.setGeolocation({latitude: 35.689487, longitude: 139.691706});
 *   }
 * };
 *
 * @syntax .appium.setGeolocation({latitude, longitude, altitude}, [callback])
 * @method setGeolocation
 * @param {object} [coordinates] `latitude` and `longitude` are required; `altitude` is optional. All should be of type `number`.
 * @param {function} [callback] Optional callback function to be called when the command finishes.
 * @see appium.getGeolocation
 * @api protocol.appium
 */
module.exports = class Session extends ProtocolAction {
  static get isTraceable() {
    return true;
  }

  command(coordinates = {}, callback) {
    if (!('latitude' in coordinates && 'longitude' in coordinates)) {
      throw new Error('Please provide both latitude and longitude while using setGeolocation.');
    }

    return this.transportActions.setDeviceGeolocation(coordinates, callback);
  }
};