How to use driver.isLocked method in Appium

...223        return this.skip();224      }225      try {226        await driver.lock();227        (await driver.isLocked()).should.be.true;228      } finally {229        await driver.unlock();230      }231      (await driver.isLocked()).should.be.false;232    });233  });234  describe.skip('contexts -', function () {235    before(async function () {236      let el = await driver.elementByAccessibilityId('Web View');237      await driver.execute('mobile: scroll', {element: el, toVisible: true});238      await el.click();239    });240    after(async function () {241      await driver.back();242      await driver.execute('mobile: scroll', {direction: 'up'});243    });244    it('should start a session, navigate to url, get title', async function () {245      let contexts;...

...106];107async function ensureUnlocked (driver) {108  // on Travis the device is sometimes not unlocked109  await retryInterval(10, 1000, async function () {110    if (!await driver.isLocked()) {111      return;112    }113    console.log(`\n\nDevice locked. Attempting to unlock`); // eslint-disable-line114    await driver.unlock();115    // trigger another iteration116    throw new Error(`The device is locked.`);117  });118}119describe('keyboard', function () {120  this.retries(3);121  describe('ascii', function () {122    let driver;123    before(async function () {124      driver = new AndroidDriver();...

1import Framework from './framework';2class JsOxygenFramework extends Framework {3  get language () {4    return 'js';5  }6  wrapWithBoilerplate (code) {7    let caps = JSON.stringify(this.caps);8    let url = JSON.stringify(`${this.scheme}://${this.host}:${this.port}${this.path}`);9    return `// Requires the Oxygen HQ client library10// (npm install oxygen-cli -g)11// Then paste this into a .js file and run with:12// oxygen <file>.js13mob.init(${caps}, ${url});14${code}15`;16  }17  codeFor_findAndAssign (strategy, locator, localVar, isArray) {18    // wdio has its own way of indicating the strategy in the locator string19    switch (strategy) {20      case 'xpath': break; // xpath does not need to be updated21      case 'accessibility id': locator = `~${locator}`; break;22      case 'id': locator = `id=${locator}`; break;23      case 'name': locator = `name=${locator}`; break;24      case 'class name': locator = `css=${locator}`; break;25      case '-android uiautomator': locator = `android=${locator}`; break;26      case '-android datamatcher': locator = `android=${locator}`; break;27      case '-ios predicate string': locator = `ios=${locator}`; break;28      case '-ios class chain': locator = `ios=${locator}`; break; // TODO: Handle IOS class chain properly. Not all libs support it. Or take it out29      default: throw new Error(`Can't handle strategy ${strategy}`);30    }31    if (isArray) {32      return `let ${localVar} = mob.findElements(${JSON.stringify(locator)});`;33    } else {34      return `let ${localVar} = mob.findElement(${JSON.stringify(locator)});`;35    }36  }37  codeFor_click (varName, varIndex) {38    return `mob.click(${this.getVarName(varName, varIndex)});`;39  }40  codeFor_clear (varName, varIndex) {41    return `mob.clear(${this.getVarName(varName, varIndex)});`;42  }43  codeFor_sendKeys (varName, varIndex, text) {44    return `mob.type(${this.getVarName(varName, varIndex)}, ${JSON.stringify(text)});`;45  }46  codeFor_back () {47    return `mob.back();`;48  }49  codeFor_tap (varNameIgnore, varIndexIgnore, x, y) {50    return `mob.tap(${x}, ${y});`;51  }52  codeFor_swipe (varNameIgnore, varIndexIgnore, x1, y1, x2, y2) {53    return `mob.swipeScreen(${x1}, ${y1}, ${x2}, ${y2});`;54  }55  codeFor_getCurrentActivity () {56    return `let activityName = mob.getCurrentActivity();`;57  }58  codeFor_getCurrentPackage () {59    return `let packageName = mob.getCurrentPackage();`;60  }61  codeFor_installAppOnDevice (varNameIgnore, varIndexIgnore, app) {62    return `mob.installApp('${app}');`;63  }64  codeFor_isAppInstalledOnDevice (varNameIgnore, varIndexIgnore, app) {65    return `let isAppInstalled = mob.isAppInstalled("${app}");`;66  }67  codeFor_launchApp () {68    return `mob.launchApp();`;69  }70  codeFor_backgroundApp (varNameIgnore, varIndexIgnore, timeout) {71    return `mob.driver().background(${timeout});`;72  }73  codeFor_closeApp () {74    return `mob.closeApp();`;75  }76  codeFor_resetApp () {77    return `mob.resetApp();`;78  }79  codeFor_removeAppFromDevice (varNameIgnore, varIndexIgnore, app) {80    return `mob.removeApp('${app}')`;81  }82  codeFor_getAppStrings (varNameIgnore, varIndexIgnore, language, stringFile) {83    return `let appStrings = mob.driver().getAppStrings(${language ? `${language}, ` : ''}${stringFile ? `"${stringFile}` : ''});`;84  }85  codeFor_getClipboard () {86    return `let clipboardText = mob.driver().getClipboard();`;87  }88  codeFor_setClipboard (varNameIgnore, varIndexIgnore, clipboardText) {89    return `mob.driver().setClipboard('${clipboardText}')`;90  }91  codeFor_pressKeycode (varNameIgnore, varIndexIgnore, keyCode, metaState, flags) {92    return `mob.driver().longPressKeyCode(${keyCode}, ${metaState}, ${flags});`;93  }94  codeFor_longPressKeycode (varNameIgnore, varIndexIgnore, keyCode, metaState, flags) {95    return `mob.driver().longPressKeyCode(${keyCode}, ${metaState}, ${flags});`;96  }97  codeFor_hideDeviceKeyboard () {98    return `mob.driver().hideKeyboard();`;99  }100  codeFor_isKeyboardShown () {101    return `//isKeyboardShown not supported`;102  }103  codeFor_pushFileToDevice (varNameIgnore, varIndexIgnore, pathToInstallTo, fileContentString) {104    return `mob.driver().pushFile('${pathToInstallTo}', '${fileContentString}');`;105  }106  codeFor_pullFile (varNameIgnore, varIndexIgnore, pathToPullFrom) {107    return `let data = mob.driver().pullFile('${pathToPullFrom}');`;108  }109  codeFor_pullFolder (varNameIgnore, varIndexIgnore, folderToPullFrom) {110    return `let data = mob.driver().pullFolder('${folderToPullFrom}');`;111  }112  codeFor_toggleAirplaneMode () {113    return `mob.driver().toggleAirplaneMode();`;114  }115  codeFor_toggleData () {116    return `mob.driver().toggleData();`;117  }118  codeFor_toggleWiFi () {119    return `mob.driver().toggleWiFi();`;120  }121  codeFor_toggleLocationServices () {122    return `mob.driver().toggleLocationServices();`;123  }124  codeFor_sendSMS () {125    return `// Not supported: sendSms;`;126  }127  codeFor_gsmCall () {128    return `// Not supported: gsmCall`;129  }130  codeFor_gsmSignal () {131    return `// Not supported: gsmSignal`;132  }133  codeFor_gsmVoice () {134    return `// Not supported: gsmVoice`;135  }136  codeFor_shake () {137    return `mob.shake();`;138  }139  codeFor_lock (varNameIgnore, varIndexIgnore, seconds) {140    return `mob.driver().lock(${seconds});`;141  }142  codeFor_unlock () {143    return `mob.driver().unlock();`;144  }145  codeFor_isLocked () {146    return `let isLocked = mob.driver().isLocked();`;147  }148  codeFor_rotateDevice (varNameIgnore, varIndexIgnore, x, y, radius, rotation, touchCount, duration) {149    return `mob.driver().rotateDevice(${x}, ${y}, ${radius}, ${rotation}, ${touchCount}, ${duration});`;150  }151  codeFor_getPerformanceData () {152    return `// Not supported: getPerformanceData`;153  }154  codeFor_getSupportedPerformanceDataTypes () {155    return `// Not supported: getSupportedPerformanceDataTypes`;156  }157  codeFor_performTouchId (varNameIgnore, varIndexIgnore, match) {158    return `mob.driver().touchId(${match});`;159  }160  codeFor_toggleTouchIdEnrollment (varNameIgnore, varIndexIgnore, enroll) {161    return `mob.driver().toggleEnrollTouchId(${enroll});`;162  }163  codeFor_openNotifications () {164    return `mob.driver().openNotifications();`;165  }166  codeFor_getDeviceTime () {167    return `let time = mob.getDeviceTime();`;168  }169  codeFor_fingerprint (varNameIgnore, varIndexIgnore, fingerprintId) {170    return `mob.driver().fingerPrint(${fingerprintId});`;171  }172  codeFor_sessionCapabilities () {173    return `let caps = mob.driver().capabilities;`;174  }175  codeFor_setPageLoadTimeout (varNameIgnore, varIndexIgnore, ms) {176    return `mob.driver().setTimeout({'pageLoad': ${ms}});`;177  }178  codeFor_setAsyncScriptTimeout (varNameIgnore, varIndexIgnore, ms) {179    return `mob.driver().setTimeout({'script': ${ms}});`;180  }181  codeFor_setImplicitWaitTimeout (varNameIgnore, varIndexIgnore, ms) {182    return `mob.driver().setTimeout({'implicit': ${ms}});`;183  }184  codeFor_setCommandTimeout () {185    return `// Not supported: setCommandTimeout`;186  }187  codeFor_getOrientation () {188    return `let orientation = mob.driver().getOrientation();`;189  }190  codeFor_setOrientation (varNameIgnore, varIndexIgnore, orientation) {191    return `mob.driver().setOrientation("${orientation}");`;192  }193  codeFor_getGeoLocation () {194    return `let location = mob.driver().getGeoLocation();`;195  }196  codeFor_setGeoLocation (varNameIgnore, varIndexIgnore, latitude, longitude, altitude) {197    return `mob.driver().setGeoLocation({latitude: ${latitude}, longitude: ${longitude}, altitude: ${altitude}});`;198  }199  codeFor_logTypes () {200    return `let logTypes = mob.driver().getLogTypes();`;201  }202  codeFor_log (varNameIgnore, varIndexIgnore, logType) {203    return `let logs = mob.driver().getLogs('${logType}');`;204  }205  codeFor_updateSettings (varNameIgnore, varIndexIgnore, settingsJson) {206    return `mob.driver().updateSettings(${settingsJson});`;207  }208  codeFor_settings () {209    return `let settings = mob.driver().getSettings();`;210  }211}212JsOxygenFramework.readableName = 'JS - Oxygen HQ';...

1/**2 * @file browser interface functions to support common testing3 */45const cov = require('istanbul-middleware');6const webdriver = require('selenium-webdriver');7const expect = require("chai").expect;8const assert = require("chai").assert;9const fs = require('fs');10const http = require('http');1112module.exports.commonFullPath = function ()13{14    return __dirname;15}1617module.exports.refreshCoverage = async function (driver) {18    // post coverage info  19    await driver.executeScript("return window.__coverage__;").then(function (obj) {2021        try {22            var str = JSON.stringify(obj);2324            var options = {25                port: 8888,26                host: "localhost",27                path: "/coverage/client",28                method: "POST",29                headers: {30                    "Content-Type": "application/json",31                }32            };33            var req = http.request(options, function (res) {34                //done();35            });36            req.write(str);37            req.end();38        } catch (e)39        {40            console.log("Error in coverage post:" + e);41        }42    });434445}4647module.exports.openOptions = async function (driver) {48    await driver.findElement(webdriver.By.id('menu-button')).click();49    await driver.findElement(webdriver.By.id('menu-options')).click();50}5152module.exports.closeOptions = async function (driver) {53    var optionsScreen = await driver.findElement(webdriver.By.id('options-screen'))54    await optionsScreen.findElement(webdriver.By.className('close')).click();55}5657exports.encryptWith = async function (driver, password, hint) {5859    await driver.findElement(webdriver.By.id('enc-password')).sendKeys(password);60    await driver.findElement(webdriver.By.id('enc-hint')).sendKeys(hint);6162    await driver.findElement(webdriver.By.id('do-encrypt')).click();6364    await driver.wait(webdriver.until.alertIsPresent())65    await driver.switchTo().alert().accept();66}676869module.exports.assertFormIsLocked = async function (driver, isLocked) {70    var lockedStyle = await driver.findElement(webdriver.By.id('locked')).getAttribute("style");71    var unlockedStyle = await driver.findElement(webdriver.By.id('unlocked')).getAttribute("style");7273    if (isLocked) {74        expect(lockedStyle, "Locked div is hidden").to.be.equal("display: inline;");75        expect(unlockedStyle, "Unlocked div is shown").to.be.equal("display: none;");76    } else {77        expect(lockedStyle, "Locked div is shown").to.be.equal("display: none;");78        expect(unlockedStyle, "Unlocked div is hidden").to.be.equal("display: inline;");79    }80}8182module.exports.assertBrowserUnsupportedMessageIsShown = async function (driver, isShown) {83    var unsupportedStyle = await driver.findElement(webdriver.By.id('unsupported')).getAttribute("style");8485    if (isShown) {86        expect(unsupportedStyle, "Browser unsupported div is hidden").to.be.equal("display: inline;");87    } else {88        expect(unsupportedStyle, "Browser unsupported div is hidden").to.be.equal("display: none;");89    }90}9192module.exports.assertHelpIsShown = async function (driver, isShown) {9394    var helpDisplayed = await driver.findElement(webdriver.By.id('help-screen')).isDisplayed();9596    if (isShown) {97        expect(helpDisplayed, "Help is hidden").to.equal(true);98    } else {99        expect(helpDisplayed, "Help is shown").to.equal(false);100    }101}102103module.exports.decryptWith = async function (driver, password) {104    await driver.findElement(webdriver.By.id('dec-password')).sendKeys(password);105    await driver.findElement(webdriver.By.id('do-decrypt')).click();106}107108module.exports.setEncryptPass = async function (driver, password) {109    var encPass = await driver.findElement(webdriver.By.id('enc-password'))110    await encPass.clear();111    await encPass.sendKeys(password);112}113114module.exports.setCommonOptions = async function (driver, saveFilename, timeout) {115    await this.openOptions(driver);116    await driver.findElement(webdriver.By.id('opt-timeout')).clear();117    await driver.findElement(webdriver.By.id('opt-save-filename')).clear();118    await driver.findElement(webdriver.By.id('opt-timeout')).sendKeys(timeout);119    await driver.findElement(webdriver.By.id('opt-save-filename')).sendKeys(saveFilename);120    await driver.findElement(webdriver.By.id('opt-save-filename')).click(); //updates the timeout121    await this.closeOptions(driver);122}123124module.exports.sendKeysOptionSaveFilename = async function (driver, saveFilename) {125    await this.openOptions(driver);126    await driver.findElement(webdriver.By.id('opt-save-filename')).sendKeys(saveFilename);127}
...

...75            return driver.unlock(key);76        }77    }78    function isLocked(resourceId) {79        return driver.isLocked(lockerFactory.hash(resourceId));80    }81    function purge() {82        return driver.purge();83    }84};85module.exports.hash = function(str) {86    if (!str) {87        throw new Error('Could not hash falsy value');88    }89    if ('string' !== typeof str) {90        throw new Error('Can not hash value which is not a string');91    }92    return crypto93        .createHash(URL_HASH_TYPE)...

1"use strict";2var setup = require("../../common/setup-base")3    , desired = require("./desired")4    , Asserter = require('wd').Asserter5    , chai = require('chai');6describe("apidemos - lock", function () {7  var driver;8  setup(this, desired).then(function (d) { driver = d; });9  var isLockedAsserter = function (opts) {10    return new Asserter(11      function (driver) {12        return driver13          .isLocked()14          .then(function (isLocked) {15            isLocked.should.equal(opts.expected);16            return isLocked;17          })18          .catch(function (err) {19            err.retriable = err instanceof chai.AssertionError;20            throw err;21          });22      }23    );24  };25  it('should lock the screen', function (done) {26    driver27      .isLocked()28      .should.not.eventually.be.ok29      .lockDevice(3)30      .waitFor(isLockedAsserter({expected: true}), 5000, 500)31      .should.eventually.be.ok32      .nodeify(done);33      });34  it('should unlock the screen', function (done) {35    driver36      .lockDevice(3)37      .waitFor(isLockedAsserter({expected: true}), 5000, 500)38      .should.eventually.be.ok39      .unlockDevice()40      .waitFor(isLockedAsserter({expected: false}), 5000, 500)41      .should.not.eventually.be.ok42      .nodeify(done);43    });...

2//driver.lock(5);3//--To Unlock a Device--4//driver.unlock(5);5//boolean value true / false6//driver.isLocked();7//Console log to print line8//To get Current Activity9console.log("Hello Ritzz", driver.getCurrentActivity());10//--To get Current Package11driver.getCurrentPackage();12//--To install Application into Device13driver.installApp(c://rit/flipkart.apk)14  //to check whether this app is installed or not package 15  driver.isAppInstalled(appId)16//to Terminate app17driver.terminateApp(appId)18//--To hide keyword 19driver.hideKeyboard()20//--To check keyboard is open or not true/false...

...6	})7	it('Can lock device', function() {8		driver.lock()9		driver.pause(3000)10		expect(driver.isLocked()).toBe(true)11		driver.unlock()12	})13	it('Can open settings app', function() {14		// android15		// adb shell dumpsys window windows | grep -E 'mCurrentFocus'16		driver.startActivity('com.android.settings', 'com.android.settings.Settings')17		driver.pause(3000)18		// ios19		// https://emm.how/t/ios-12-list-of-default-apps-and-bundle-id-s/79020		// driver.launchApp({ bundleId: "com.apple.Preferences" })21	})...