Read the details of a particular TV based on its ID. Returns the ID, name, theme and settings of the TV.
Calls the HTTP API: GET /v1/tv/<ID>
For example:
import * as Qminder from 'qminder-api';
Qminder.setKey('API_KEY_HERE');
const tv = await Qminder.devices.details(1425);
the Device that represents the TV, or the TV ID
a Promise that resolves to device details, or rejects if something went wrong.
Modify the TV's name. This changes the TV's display name in the TV List in the Qminder Dashboard.
Calls the HTTP API: POST /v1/tv/<ID>
For example:9
import * as Qminder from 'qminder-api';
Qminder.setKey('API_KEY_HERE');
let device = Qminder.devices.details(1235);
device = await Qminder.devices.edit(device, device.name + ' (Offsite)');
the Device that represents the TV, or the TV ID.
the desired new name of the TV.
a Promise that resolves to the new TV details, or rejects if something went wrong.
Remove a TV. This deletes the TV and revokes the API key, removing it from the list of TVs.
Calls the HTTP API: DELETE /v1/tv/<ID>
For example:
import * as Qminder from 'qminder-api';
Qminder.setKey('API_KEY_HERE');
// Example 1. Delete based on device ID
await Qminder.devices.remove(1235);
// Example 2. Delete based on Device object
const device = Qminder.devices.details(125);
await Qminder.devices.remove(device);
the Device that represents the TV, or the TV ID.
A promise that resolves when successful and rejects when something went wrong.
Generated using TypeDoc
DeviceService allows the developer to manage devices such as iPads that have the Qminder Sign-In app installed, or Apple TVs with the Qminder TV app.