Configuration
You can configure the client to change the device, OS version, currently loaded app (publicKey), and various other options.
await client.config({
device: 'iphone11pro',
osVersion: '15.0'
})
Additionally, you can provide these when requesting a session:
const session = await client.startSession({
device: 'iphone11pro',
osVersion: '15.0'
})
stringstringThe operating system version on which to run your app. e.g. 11.4, 12.2, 13.3, 14.0
Note: We recommend leaving this blank so it will always use our latest default for the device
numberSets the scale of the device. Value must be between 10 and 100.
"portrait" | "horizontal"Sets the orientation of the device
"vertical" | "horizontal" | "both"Centers the device within the embed
"black" | "white"Sets the color of the device chrome
booleanIf true, only show the screen and not the device chrome
stringstring(iOS only) Sets the locale of the device. Must be a locale ID e.g.
en_GB, fr_FRstringboolean(Android only) When true, disabled the onscreen keyboard
string(Android only) Sets location of the device in latitude and longitude. eg.
39.903924,116.391432stringboolean(Android only) Automatically grant all required app permissions
boolean(Android only) Hide password visibility when typing
stringSpecify a deep link to open when your app is launched
string[](iOS only) An array of strings to pass when launching your app
booleanWhen true, the session will listen for debug logs and emit them as a
log event.stringSpecify a proxy server to route network traffic. eg
http://example.com:8080For Appetize.io's built-in intercepting proxy, use
intercept. Network logs are emitted from the session as a network event.boolean(Android only) Sets up an SSH tunnel to allow ADB connections to the emulator. SSH command and info can be found in the session's
deviceInfo eventboolean(Android only) Allows installation of additional APKs after app launch
"dark" | "light"Sets dark or light mode UI on iOS 13+ and Android 10+
objectA JSON object that will be passed to your app on launch
stringThe publicKey of the app that you wish to run
iphone5siphone6iphone6plusiphone7iphone7plusiphone8iphone8plusiphonexiphonexsiphonexsmaxiphone11proiphone11promaxiphone12iphone12miniiphone12proiphone12promaxiphone14proiphone14promaxipadairipadair2ipodtouch7thgeneration
nexus5nexus7nexus9pixel4pixel4xlpixel6pixel6progalaxytabs7
Last modified 1mo ago