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.
Parameters
Name | Type | Description |
---|---|---|
|
| A JSON object describing the Configuration options for the device. |
setConfig()
Update the configured app, device, operating system, or other launch options. See Configuration for acceptable values.
Note: This will end any active sessions.
endSession()
Ends the active session or cancels any pending session requests.
Session
adbShellCommand()
Executes an adb shell
command on the device (Android only)
allowInteractions()
Enables or disables all interactions on the device.
biometryEnrollment()
Sets the biometry enrollment status (iOS Only)
biometry()
Simulate a matching fingerprint (Android 8+ only) or Face ID (iOS)
end()
Ends the session
getUI()
Experimental The data structure of the response is subject to change
Returns an array of elements describing the current UI on the device.
heartbeat()
Sends a heartbeat to the server, resetting the inactivity timer of the session
keypress()
Sends a single key press to the device.
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
launchApp(appId)
Launches the specified application using the provided appId
.
If the app is already running, it will be brought to the foreground instead of being relaunched. If the app was originally launched with params or a launchUrl, these will also be passed with this method.
Parameters
Name | Type | Description |
---|---|---|
|
| Android:
The app's package name / appId (e.g., |
restartApp()
Restarts the app
reinstallApp()
Reinstalls the app
rotate()
Rotates the device 90 degrees left or right
screenshot()
Takes a screenshot of the device and returns the data as a buffer.
Alternatively, it can return the data as a base64 encoded string
shake()
Shakes device
toggleSoftKeyboard()
Toggles the soft keyboard (iOS only)
setLanguage()
Changes the current language.
If your app does not automatically handle language/locale changes, you would need to explicitly call restartApp for this to take effect. Some apps might also cache data in the previously used language. In these cases use reinstallApp to clear any previous cached data.
type()
Types the given text
Typing is limited to 1000 characters at a time to ensure optimal performance and prevent potential disruptions. For larger payloads, you can use multiple 'type' operations.
addMedia(file)
The maximum file size for uploading media is 50 MB.
Upload media to the device.
Last updated