Interface IGondolaMobile

example

gondola.checkAppIsInstalled("com.example.appName);

example

// get current app activity name
// full command: adb shell "dumpsys window windows | grep -E 'mCurrentFocus|mFocusedApp'"
await gondola.runOnAndroid(async () => {
    const currentAppInfo = await gondola.executeCommand("mobile:shell", [{
        command: "dumpsys",
        args: [
            "window",
            "windows",
            "|",
            "grep",
            "-E",
            "'mCurrentFocus|mFocusedApp'",
        ],
    }]);
    console.log(currentAppInfo);
});

// get battery info on iOS
await gondola.runOnIOS(async () => {
    const batteryInfo = await gondola.executeCommand("mobile:batteryInfo", []);
    console.log(batteryInfo);
});

example

let allContext: string[] = await gondola.getAllContexts();

example

let currentContext: string = await gondola.getContext();

example

const browser = await gondola.getCurrentBrowser();
const element = await browser.findElement("accessibility id", "exampleId");
* ```

example

let screenSize = await gondola.getDeviceScreenSize();

example

let bound = await gondola.getElementBounds("~accessibleId");
let right = bound.left + bound.width;
let bottom = bound.top + bound.height;

experimental

v1 > Can be changed or removed soon

Note: When using the capabilities option, your option must be declared in the gondola config file for it to work.

example

gondola.runOnAndroid(async () => {
     await gondola.tap("~accessibleId");
     // ...
});

// Filter can be applied by checking for capabilities. This code only run on Android 7.0
gondola.runOnAndroid({platformVersion: '7.0'}, () =>{
     // ...
});

// Capabilities can be checked by a function. In this case , code will be executed only on android >= 6
gondola.runOnAndroid((cap) => {return cap.platformVersion >= 6}, ()=>{
     // ...
});

Note: if you're using Appium's Desired Capabilities, you must have the options set in ```gondola.json`` under the helpers->Appium->desiredCapabilities section.

example

gondola.runOnIOS(async () => {
     await gondola.tap("~accessibleId");
     // ...
});

// Filter can be applied by checking for capabilities. This code only run on runOnIOS 6.0
gondola.runOnIOS({platformVersion: '6.0'}, () => {
     // ...
});

// Capabilities can be checked by a function. In this case , code will be executed only on runOnIOS >= 6
gondola.runOnIOS((cap) => {return cap.platformVersion >= 6}, () => {
     // ...
});

example

await gondola.scrollIntoView({xpath: "//a"}});

example

gondola.sendDeviceKeyEvent(3);

experimental

v1 > Can be changed or removed soon

experimental

v1 > For IOS SDK version 12.x, use Xcode 11

example

// Single item: pickerElement is a day, month or year that is a child control of a picker
await gondola.setPickerValue(pickerElement, "item name");

// Multiple items: pickerElement is a picker control. It does not include any child controls.
await gondola.setPickerValue(pickerElement, ["one", "two", "three"]);

// Multiple items that contain an undefined item: the undefined item will not change
// and pickerElement is a picker control. It does not include any child controls.
await gondola.setPickerValue(pickerElement, ["one", undefined, "three"]);

example

await gondola.swipe("~accessibleId",0, -1000);

example

await gondola.swipeByCoordinates(0, 0, 0, 600);

example

await gondola.switchToContext("NATIVE_APP");

example

gondola.tap("~accessibleId");
gondola.tap({id: "buttonId"});
gondola.tap({
     android: "//com.android.TextView[@text='myLabel']",
     ios: "~myId"
});