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
Event | Data Type | Description |
---|---|---|
The currently loaded Appetize app. | ||
Information about the current device, such as type, osVersion, and screen dimensions. | ||
| An error has occurred | |
| Your position in queue for the device.
| |
| The active queue has ended. | |
| A new session has started either by the client or user clicking "Tap to Play" | |
| An active session has ended. | |
| A new session has been requested either by the client or user clicking "Tap to Play" |
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.
Note: This will end any active sessions.
Parameters
Name | Type | Description |
---|---|---|
| A JSON object describing the Configuration options for the device. |
getConfig()
Returns the current config
endSession()
Ends the active session or cancels any pending session requests.
Properties
device
The currently loaded device. See DeviceInfo.
app
The currently loaded app. See AppetizeApp.
Last updated