Global Shortcut Events

Overview

Shortcut events encapsulated in the global module.

Read UI

readAllUIConfig Read UI

• Read all UI config
• @param tmplName UI template file name
• @return {json} JSON data

1
function main() {
2
    var result = readAllUIConfig("Douyin template");
3
    logd(result);
4
    logd(JSON.stringify(result));
5
}
6

7
main();

readAllUIConfig2 Read UI config (new UI)

• Read UI parameter config
• Configure in designer: Control Center → UI Parameters (New)
• Requires EC iOS USB 6.28.0++
• Note: Requires new UI config. Read order: per-device first, then global if empty.
• If params contain __from_global__, the value comes from global config
• @param tmplName Parameter group name
• @param forceGlobal Force global config; true = ignore per-device config
• @return {json} JSON data

1
function main() {
2
    var result = readAllUIConfig2("Douyin template", false);
3
    logd(result);
4
    logd(JSON.stringify(result));
5
}
6

7
main();

Click Functions

clickPoint Click by coordinates

• Click at coordinates
• @param x X coordinate
• @param y Y coordinate
• @return {boolean}

1
function main() {
2
    var result = clickPoint(100, 100);
3
    if (result) {
4
        logd("Click succeeded");
5
    } else {
6
        logd("Click failed");
7
    }
8
}
9

10
main();

clickPointPressure Click coordinates with pressure

• Click coordinates with pressure
• Requires EC iOS 6.4.0+
• @param x X coordinate
• @param y Y coordinate
• @param pressure Pressure value in range 0–1
• @return {boolean}

1
function main() {
2
    var result = clickPointPressure(100, 100, 0.2);
3
    if (result) {
4
        logd("Click succeeded");
5
    } else {
6
        logd("Click failed");
7
    }
8
}
9

10
main();

longClickPoint Long click by coordinates

• Long-click at coordinates
• @param x X coordinate
• @param y Y coordinate
• @return {boolean}

1
function main() {
2
    var result = longClickPoint(100, 100);
3
    if (result) {
4
        logd("Click succeeded");
5
    } else {
6
        logd("Click failed");
7
    }
8
}
9

10
main();

doubleClickPoint Double-click by coordinates

• Double-click at coordinates
• @param x X coordinate
• @param y Y coordinate
• @return {boolean}

1
function main() {
2
    var result = doubleClickPoint(100, 100);
3
    if (result) {
4
        logd("Click succeeded");
5
    } else {
6
        logd("Click failed");
7
    }
8
}
9

10
main();

press Long-press by coordinates

• Long-press event
• @param x X coordinate
• @param y Y coordinate
• @param delay Long-press duration in milliseconds
• @return {bool} true on success, false on failure

1
function main() {
2
    var result = press(100, 100, 5000);
3
    if (result) {
4
        logd("Long press succeeded");
5
    } else {
6
        logd("Long press failed");
7
    }
8
}
9

10
main();

Multi-touch

multiTouch Multi-touch

• Multi-touch
• Touch params: action — 0 = down, 1 = up, 2 = move,3 = pause
• x: X coordinate
• y: Y coordinate
• pointer: finger index (1, 2, 3, … for nth finger)
• delay: delay in ms before this action runs
• @param touch1 First finger touch point array, e.g.: [{"action":0,"x":1,"y":1,"pointer":1,"delay":20},{"action":2,"x":1,"y":1,"pointer":1,"delay":20}]
• @param touch2 Second finger touch point array
• @param touch3 Third finger touch point array
• @param touch4 Fourth finger touch point array
• @param touch5 Fifth finger touch point array
• @param timeout Multi-touch total timeout in milliseconds
• @return {boolean}

1
function main() {
2
 // First style: array-based
3
 var touch1 = [
4
 {"action": 0, "x": 500, "y": 1200, "pointer": 1, "delay": 1},
5
 {"action": 2, "x": 500, "y": 1100, "pointer": 1, "delay": 20},
6
 {"action": 2, "x": 500, "y": 1000, "pointer": 1, "delay": 20},
7
 {"action": 1, "x": 1, "y": 1, "pointer": 1, "delay": 2}
8
 ]
9
 // Second style: chained calls
10
 var touch1 = MultiPoint
11
 .get()
12
 .action(0).x(500).y(1200).pointer(1).delay(100)
13
 .next()
14
 .action(2).x(500).y(1100).pointer(1).delay(100)
15
 .next()
16
 .action(2).x(500).y(1000).pointer(1).delay(100)
17
 .next()
18
 .action(2).x(500).y(900).pointer(1).delay(100)
19
 .next()
20
 .action(1).x(500).y(800).pointer(1).delay(100);
21
 var touch2 = MultiPoint
22
 .get()
23
 .action(0).x(300).y(1200).pointer(2).delay(100)
24
 .next()
25
 .action(2).x(300).y(1100).pointer(2).delay(100)
26
 .next()
27
 .action(2).x(300).y(1000).pointer(2).delay(100)
28
 .next()
29
 .action(2).x(300).y(900).pointer(2).delay(100)
30
 .next()
31
 .action(1).x(300).y(800).pointer(2).delay(100);
32
 var x = multiTouch(touch1, touch2, null, null, null, 30000);
33
 logd("xxs " + x);
34
}
35

36
main();

Swipe Functions

swipeToPoint Swipe between coordinate points

• Swipe from one coordinate to another
• @param startX Start X coordinate
• @param startY Start Y coordinate
• @param endX End X coordinate
• @param endY End Y coordinate
• @param duration Duration in milliseconds
• @return Boolean true Swipe succeeded, false Swipe failed

1
function main() {
2
 var result = swipeToPoint(10, 10, 100, 100, 200);
3
 if (result) {
4
 logd("Swipe succeeded");
5
 } else {
6
 logd("Swipe failed");
7
 }
8
}
9

10
main();

swipeToPointPressure Swipe between points with pressure

• Swipe from one coordinate to another
• Requires EC control center 6.4.0+
• @param startX Start X coordinate
• @param startY Start Y coordinate
• @param endX End X coordinate
• @param endY End Y coordinate
• @param duration Duration in milliseconds
• @param pressure pressure 0–1
• @return Boolean true Swipe succeeded, false Swipe failed

1
function main() {
2
 var result = swipeToPointPressure(10, 10, 100, 100, 200, 0.2);
3
 if (result) {
4
 logd("Swipe succeeded");
5
 } else {
6
 logd("Swipe failed");
7
 }
8
}
9

10
main();

Drag Functions

drag Drag coordinates

• Drag from one coordinate to another
• @param startX Start X coordinate
• @param startY Start Y coordinate
• @param endX End X coordinate
• @param endY End Y coordinate
• @param duration Duration in milliseconds
• @return Boolean true Drag succeeded, false Drag failed

1
function main() {
2
 var result = drag(10, 10, 100, 100, 200);
3
 if (result) {
4
 logd("Drag succeeded");
5
 } else {
6
 logd("Drag failed");
7
 }
8
}
9

10
main();

Input Data

inputText Input text

• Enter text
• @param content Content
• @param duration execution time in milliseconds
• @return {bool} true on success, false on failure

1
function main() {
2
 var result = inputText("My content", 100);
3
 if (result) {
4
 logd("Yes");
5
 } else {
6
 logd("No");
7
 }
8
}
9

10
main();

typingText Input text

• Enter text; simulates typing
• EC IOS 6.1.0+
• @param content Content
• @return {bool} true on success, false on failure

1
function main() {
2
 var result = typingText("My content");
3
 if (result) {
4
 logd("Yes");
5
 } else {
6
 logd("No");
7
 }
8
}
9

10
main();

ioHIDEvent Simulate keyboard

• Simulate HID events, e.g. keyboard and shortcuts; see key values at
• https://ieasyclick.com/iosdocs/advance/keyboard
• @param eventPageID HID type
• @param eventUsageID HID usage
• @param delay typically 0.2; may have delay
• @return {boolean}

1
function main() {
2
 let x = ioHIDEvent("0x07", "0x11", 0.2)
3
 logd(x)
4

5
}
6

7
main();

Screen Orientation

setOrientation Set screen orientation

• Set orientation; landscape supports 90° clockwise only
• Requires EC iOS control center 3.0.0+
• @param orientation 1 = portrait, 2 = 90° clockwise landscape
• @return {boolean}

1
function main() {
2
 let x = setOrientation(1)
3
 logd(x)
4

5
}
6

7
main();

getOrientation Get screen orientation

• Get screen orientation
• Requires EC iOS control center 3.0.0+
• @return int | 0 = portrait, 1 = landscape (90° clockwise))

1
function main() {
2
 let x = getOrientation()
3
 logd(x)
4
}
5

6
main();

adjustScreenOrientation Adjust screen orientation

• Adjust screen orientation and coordinate system
• Requires EC iOS control center 3.0.0+
• @param orientation 0 = auto; 1 = forced portrait; 2 = forced 90° clockwise landscape
• @return JSON string,keys: orientation, screenWidth, screenHeight

1
function main() {
2
 logd(setOrientation(1))
3
 sleep(1000)
4
 logd(getOrientation())
5
 logd("adjustScreenOrientation {}", adjustScreenOrientation(0))
6
}
7

8
main();

System Key Functions

home Go to home screen

• Go to home screen
• @return {null|Boolean}

1
function main() {
2
 var result = home();
3
 if (result) {
4
 logd("Success");
5
 } else {
6
 logd("Failed");
7
 }
8
}
9

10
main();

reboot Reboot device

• Reboot device
• Requires EC iOS 3.5.0+
• @return {null|Boolean}

1
function main() {
2
 var result = reboot();
3
 if (result) {
4
 logd("Success");
5
 } else {
6
 logd("Failed");
7
 }
8
}
9

10
main();

homeScreen Force go to home screen

• Force go to home screen
• Requires EC iOS control center 3.0.0+
• @return {null|Boolean}

1
function main() {
2
 var result = homeScreen();
3
 if (result) {
4
 logd("Success");
5
 } else {
6
 logd("Failed");
7
 }
8
}
9

10
main();

isLocked Whether screen is locked

• Whether screen is locked
• Requires EC iOS control center 3.0.0+
• @return {null|Boolean}

1
function main() {
2
 var result = isLocked();
3
 if (result) {
4
 logd("Success");
5
 } else {
6
 logd("Failed");
7
 }
8
}
9

10
main();

lockScreen Lock screen

• Lock screen
• Requires EC iOS control center 3.0.0+
• @return {null|Boolean}

1
function main() {
2
 var result = lockScreen();
3
 if (result) {
4
 logd("Success");
5
 } else {
6
 logd("Failed");
7
 }
8
}
9

10
main();

unlockScreen Unlock screen

• Unlock screen; must not have password, etc.
• Requires EC iOS control center 3.0.0+
• @return {null|Boolean}

1
function main() {
2
 var result = unlockScreen();
3
 if (result) {
4
 logd("Success");
5
 } else {
6
 logd("Failed");
7
 }
8
}
9

10
main();

openApp Open app by bundle ID

• Open app by bundle ID; unlike appLaunch, uses command channel
• @param bundleId App bundle ID
• @return {boolean} true on success, false on failure

1
function main() {
2
 var result = openApp("com.tencent.xin");
3
 if (result) {
4
 logd("Success");
5
 } else {
6
 logd("Failed");
7
 }
8
}
9

10
main();

openUrl Open URL

• Open URL; call takeMeToFront first to bring this app to foreground
• @param url URL
• @return {boolean} true on success, false on failure

1
function main() {
2
 takeMeToFront()
3
 sleep(1000)
4
 var r = openUrl("http://baidu.com");
5
 logd(r)
6
}
7

8
main();

stopApp Stop app by bundle ID

• Stop app by bundle ID; unlike appKillByBundleId, uses command channel
• @param bundleId App bundle ID
• @return {boolean} true on success, false on failure

1
function main() {
2
 var result = stopApp("com.tencent.xin");
3
 if (result) {
4
 logd("Success");
5
 } else {
6
 logd("Failed");
7
 }
8
}
9

10
main();

appLaunchByPrefix Launch app by prefix

• Find and launch app by bundle ID prefix
• @param bundleIdPrefix App bundle ID prefix; comma-separated
• @return {boolean} true on success

1
function main() {
2
 var result = appLaunchByPrefix("com.tencent.xin,123");
3
 if (result) {
4
 logd("Success");
5
 } else {
6
 logd("Failed");
7
 }
8
}
9

10
main();

appLaunch Launch app

• Launch app
• Automation not required
• @param bundleId App bundle ID
• @return {int} process ID

1
function main() {
2
 var result = appLaunch("com.tencent.xin");
3
 if (result > 0) {
4
 logd("Success");
5
 } else {
6
 logd("Failed");
7
 }
8
}
9

10
main();

appLaunchEx Open an app

• Open an app
• Requires EC iOS USB 6.25.0+
• Automation required
• @param bundleId App bundle ID
• @param ignoreState 1 = ignore previous state and open directly; otherwise ""
• @return {boolean} true on success

1
function main() {
2
 var result = appLaunchEx("com.tencent.xin", "1");
3
 if (result) {
4
 logd("Success");
5
 } else {
6
 logd("Failed");
7
 }
8
}
9

10
main();

appKillByBundleId Kill app by bundle ID

• Kill process by bundle ID
• Automation not required
• @param bundleId App bundle ID
• @return {boolean} true on success, false on failure

1
function main() {
2
 var result = appKillByBundleId("com.tencent.xin");
3
 if (result) {
4
 logd("Success");
5
 } else {
6
 logd("Failed");
7
 }
8
}
9

10
main();

appKillByBundleIdEx Kill app by bundle ID

• Kill process by bundle ID
• Requires EC iOS USB 6.25.0+
• Automation required
• @param bundleId App bundle ID
• @param ignoreState 1 = ignore previous state and kill process; otherwise ""
• @return {boolean} true on success, false on failure

1
function main() {
2
 var result = appKillByBundleIdEx("com.tencent.xin", "1");
3
 if (result) {
4
 logd("Success");
5
 } else {
6
 logd("Failed");
7
 }
8
}
9

10
main();

installApp Install app by path

• Install app by path (automation not required)
• @param bundleId App bundle ID
• @param path IPA path on same PC as bridge
• @return {string} “ok” = success; other string = failure

1
function main() {
2
 var result = installApp("com.test.xin", "c:/a.ipa");
3
 logd("result " + result);
4
 if (result == "ok") {
5
 logd("Success");
6
 } else {
7
 logd("Failed");
8
 }
9
}
10

11
main();

uninstallApp Uninstall app by bundle ID

• Uninstall app by bundle ID (automation not required)
• @param bundleId App bundle ID
• @return {string} “ok” = success; other string = failure

1
function main() {
2
 var result = uninstallApp("com.test.xin");
3
 logd("result " + result);
4
 if (result == "ok") {
5
 logd("Success");
6
 } else {
7
 logd("Failed");
8
 }
9
}
10

11
main();

other Functions

setAssistiveTouch AssistiveTouch toggle

• Toggle AssistiveTouch floating ball
• Requires EC IOS 6.0.0+
• @param open true = show, false = hide
• @return {boolean} true on success, false on failure

1
function main() {
2
 var result = setAssistiveTouch(true);
3
 logd(result);
4
}
5

6
main();

resetUsbConn Reset USB connection

• Reset USB connection; try when automation is enabled
• @return {boolean} true on success, false on failure

1
function main() {
2
 var result = resetUsbConn();
3
 logd(result);
4
}
5

6
main();

reconnectUsb Reconnect USB

• Flash-disconnect USB and reconnect (like unplugging cable)
• Requires EC 7.2.0+
• @return {boolean} true on success, false on failure

1
function main() {
2
 var result = reconnectUsb();
3
 logd(result);
4
}
5

6
main();

setAgentSetting Set agent program config

• Set agent program config
• @param ext is a map,e.g. {"screenStreamQuality":100}
• screenStreamQuality: screen mirroring quality 1–100
• screenStreamFramerate: screen mirroring framerate 10–60
• @return {bool} true on success, false on failure

1
function main() {
2
 // Omit map keys for properties you do not want to set
3
 var result = setAgentSetting({"screenStreamQuality": 60, "screenStreamFramerate": 20});
4
 logd(result);
5
}
6

7
main();

setAgentTimeout Set agent request timeout

• @param envTimeout Automation startup timeout (ms); 10000–15000
• @param readTimeout other request timeout (ms); 2000–5000
• @return {boolean} true on success

1
function main() {
2
 setAgentTimeout(10000, 3000);
3
}
4

5
main();

activeAppInfo Current running app bundle ID

• @param Current running app bundleId
• @return {string} current running app bundleId

1
function main() {
2
 let d = activeAppInfo();
3
 logd(d);
4
}
5

6
main();

erasePhone Factory reset

• Factory reset (wipe device)
• Requires EC iOS USB 8.10.0+
• Use with caution; wipes device data and reboots automatically
• @return {boolean} true on success, false on failure

1
function main() {
2
 let d = erasePhone();
3
 logd(d);
4
}
5

6
main();

Gallery Operations

uploadInsertImage Insert image into gallery

• Insert image into gallery via agent IPA
• Requires EC IOS 6.5.0 +
• @param path image path
• @return {boolean} true on success, false on failure

1
function main() {
2
 let d = uploadInsertImage("D:/a.jpg");
3
 logd(d);
4
}
5

6
main();

uploadInsertVideo Insert video into gallery

• Insert video into gallery via agent IPA
• Requires EC IOS 6.5.0 +
• @param path video path
• @return {boolean} true on success, false on failure

1
function main() {
2
 let d = uploadInsertVideo("D:/a.mp4");
3
 logd(d);
4
}
5

6
main();

File Operations

fsyncFileOpr File operations on iOS device

• File operations on iOS device
• Requires EC 7.2.0+
• @param action Actions: list= list files or folders,rm= delete file or folder,mkdir = create folder
• @param path file path
• @return {JSON} code=0 = success; data = payload; when action=list, data is an array with file path, size, etc.

1
function main() {
2
 // List all files under /
3
 let d = fsyncFileOpr("list", "/");
4
 logd(JSON.stringify(d));
5
 // List all files under /Downloads
6
 d = fsyncFileOpr("list", "/Downloads");
7
 logd(JSON.stringify(d));
8

9

10
 // Create folder
11
 d = fsyncFileOpr("mkdir", "/Downloads/123");
12
 logd(JSON.stringify(d));
13

14
 // Delete file or folder
15
 d = fsyncFileOpr("rm", "/Downloads/123.txt");
16
 logd(JSON.stringify(d));
17
}
18

19
main();

fsyncFilePushPull Pull file

• Push/pull files to/from iOS device
• Requires EC 7.2.0+
• @param action Actions: push = push file from PC to remote device,pull = pull file from device to PC
• @param srcPath Source path; for push = PC path; for pull = iOS path
• @param destPath Destination path; for push = iOS path; for pull = PC path
• @return {json} code=0 means success

1
function main() {
2
 // Push C:/a.txt to iOS device at /Downloads/a.txt
3
 let d = fsyncFilePushPull("push", "C:/a.txt", "/Downloads/a.txt");
4
 logd(JSON.stringify(d));
5
 // Pull file to local machine
6
 d = fsyncFilePushPull("pull", "/Downloads/a.txt", "c:/bb.txt");
7
 logd(JSON.stringify(d));
8

9
}
10

11
main();