Apps & sessions

Open, switch to and terminate apps, and query their state. Opening and switching both go through client.session, which also sets up the automation session.

client.session#

Open (or switch to) the app and set up an automation session for it. Usually called at the top of a script.

typescript

client.session(bundleId: string): Client;

Parameters

Name	Type	Required	Default	Description
`bundleId`	`string`	Yes	—	The app's bundle ID, for example com.apple.Preferences (Settings).

Returns

Type	Description
`Client`	A client bound to the new session. You rarely need it: keep using the global client, which follows the current session on its own.

Notes

A locked device is unlocked first (only works without a passcode).

Example

javascript

client.session('com.apple.Preferences');
sleep(2);
clickElement('label', 'General', 5);

client.appTerminate#

Terminate the app's process. To start every round from the app's initial state, terminate it and then open it with client.session.

typescript

client.appTerminate(bundleId: string): object;

Parameters

Name	Type	Required	Default	Description
`bundleId`	`string`	Yes	—	The app's bundle ID, for example com.apple.Preferences (Settings).

Returns

Type	Description
`object`	The raw WDA response; rarely needed.

Example

javascript

client.appTerminate('com.zhiliaoapp.musically');
sleep(randomFloat(1, 2));
client.session('com.zhiliaoapp.musically');

client.appState#

Query the app's run state.

typescript

client.appState(bundleId: string): { value: number };

Parameters

Name	Type	Required	Default	Description
`bundleId`	`string`	Yes	—	The app's bundle ID, for example com.apple.Preferences (Settings).

Returns

Type	Description
`{ value: number }`	value is the state: 1 not running, 2 suspended in the background, 3 running in the background, 4 in the foreground.

Example

javascript

var state = client.appState('com.zhiliaoapp.musically');
if (state.value !== 4) {
  client.session('com.zhiliaoapp.musically');
}

client.appCurrent#

Information about the app in the foreground.

typescript

client.appCurrent(): { bundleId: string; name: string; pid: number };

Returns

Type	Description
`{ bundleId, name, pid }`	The foreground app's bundle ID, name and process ID.

Example

javascript

var app = client.appCurrent();
logi(app.bundleId);

isAppInstalled#

Whether an app is installed on this device.

typescript

isAppInstalled(bundleId: string): boolean;

Parameters

Name	Type	Required	Default	Description
`bundleId`	`string`	Yes	—	The app's bundle ID, for example com.apple.Preferences (Settings).

Returns

Type	Description
`boolean`	True when installed (running or not), false when not.

Throws

Error	Raised when
`WDAError`INVALID_ARGUMENT	bundleId is missing or not a string.

Notes

If the check itself fails (for example the device's automation service does not answer) it throws instead of returning false, so the script does not take the wrong branch.

Example

javascript

if (!isAppInstalled('com.zhiliaoapp.musically')) {
  loge('TikTok is not installed');
  return false;
}
client.session('com.zhiliaoapp.musically');

appList#

The apps running right now, in the foreground or background. This is not the list of installed apps; use isAppInstalled for that.

typescript

appList(): { pid: number; bundleId: string }[];

Returns

Type	Description
`{ pid, bundleId }[]`	The process ID and bundle ID of each running app.

Example

javascript

var apps = appList();
for (var i = 0; i < apps.length; i++) {
  logi(apps[i].bundleId);
}