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'
})
string
string
The 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
number
Sets 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
boolean
If true, only show the screen and not the device chrome
string
string
(iOS only) Sets the locale of the device. Must be a locale ID e.g.
en_GB
, fr_FR
string
boolean
(Android only) When true, disabled the onscreen keyboard
string
(Android only) Sets location of the device in latitude and longitude. eg.
39.903924,116.391432
string
boolean
(Android only) Automatically grant all required app permissions
boolean
(Android only) Hide password visibility when typing
string
Specify a deep link to open when your app is launched
string[]
(iOS only) An array of strings to pass when launching your app
boolean
When true, the session will listen for debug logs and emit them as a
log
event.string
Specify a proxy server to route network traffic. eg
http://example.com:8080
For 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+
object
A JSON object that will be passed to your app on launch
string
The publicKey of the app that you wish to run
iphone5s
iphone6
iphone6plus
iphone7
iphone7plus
iphone8
iphone8plus
iphonex
iphonexs
iphonexsmax
iphone11pro
iphone11promax
iphone12
iphone12mini
iphone12pro
iphone12promax
iphone14pro
iphone14promax
ipadair
ipadair2
ipodtouch7thgeneration
nexus5
nexus7
nexus9
pixel4
pixel4xl
pixel6
pixel6pro
galaxytabs7
Last modified 1mo ago