Client
The client provides methods to configure the embedded device, manage sessions and listen to device related events.
Methods
on(event, listener)
Listens for an event of the given name
client.on(event, data => {
console.log(data)
})
Information about the current device, such as type, osVersion, and screen dimensions.
{
type: "session | concurrent",
position: number,
name: string
}
Your position in queue for the device.
concurrent: You've reached the max concurrent sessions for your account and are waiting for the next available slot. The concurrent queue name will be shown.
session: You're in a queue, waiting for the next available device.
startSession()
Starts a session with the requested app, device, operating system, and other launch options.
const session = await client.startSession()
Parameters
setConfig()
Update the configured app, device, operating system, or other launch options.
Note: This will end any active sessions.
await client.setConfig(config)
Parameters
getConfig()
Returns the current config
const config = client.getConfig()
endSession()
Ends the active session or cancels any pending session requests.
await client.endSession()
Properties
device
The currently loaded device. See DeviceInfo.
app
The currently loaded app. See AppetizeApp.
Last updated