Device commands

The client provides methods to configure the device and start a session, while the session provides methods for user interaction.

Client

startSession()

Starts a session with the requested app, device, operating system, and other launch options.

const session = await client.startSession()

Parameters

Name	Type	Description
config?	Record<string, any>	A JSON object describing the Configuration options for the device.

config()

Update the configured app, device, operating system, or other launch options. See Configuration for acceptable values.

Note: This will end any active sessions.

await client.config(config)

Session

adbShellCommand

Executes an adb shell command on the device (Android only)

await session.adbShellCommand("am start -a android.intent.action.VIEW -d https://appetize.io/")

allowInteractions()

Enables or disables all interactions on the device.

await session.allowInteractions(false)

biometry()

Simulate a matching fingerprint (Android 8+ only)

await session.biometry({
    match: true/false
})

end()

Ends the session

await session.end()

getUI()

Returns the UI of the app as an XML string

This returns an XML representation of your app's user interface. You may find it helpful to retrieve this data (UI Dump) to programmatically understand what your app is displaying.

await session.getUI()

// returns a string, eg. "<?xml version='1.0' encoding='UTF-8' ?>..."

heartbeat()

Sends a heartbeat to the server, resetting the inactivity timer

await session.heartbeat()

keypress()

Sends a single key press to the device.

await session.keypress("a")

This can also be used to send hardware keys:

• HOME

• VOLUME_UP (Android)

• VOLUME_DOWN (Android)

• ANDROID_KEYCODE_MENU (Android)

openUrl()

Opens a deep-link or web URL

await session.openUrl("https://appetize.io")

restartApp()

Restarts the app

await session.restartApp()

rotate()

Rotates the device 90 degrees left or right

await session.rotate('left')

await session.rotate('right')

screenshot()

Takes a screenshot of the device and returns the data as a buffer.

const { data, mimeType } = await session.screenshot()

Alternatively, it can return the data as a base64 encoded string

const { data, mimeType } = await session.screenshot('base64')

shake()

Shakes device (iOS only)

await session.shake()

setLanguage()

Changes the current language and restarts the app

await session.setLanguage("fr")