Update Device Kiosk Mode/IR Remote Control
PUT/v1/device/:deviceUid/remote-control
This endpoint enables/disables the IR Remote Control sensor on the SoC devices & locks/unlocks Android devices Kiosk mode.
If you want to disable IR Remote Control sensor to prevent anyone from controlling your device over IR remote control or if you want to lock tablet into kiosk mode.
Android Device Attention Required:
In order to prevent Android from displaying Android homepage and thus not showing your content, you must Enable Kiosk Mode (= Lock Remote Control) either through Box device settings or through API.
Always set the Remote Control to enabled=false via this REST API or in Box on the device detail's Settings tab.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
deviceUid | string | required | device application id |
Body
content-type: application/json or application/x-www-form-urlencoded
| Field | Type | Description |
|---|---|---|
locked | boolean | FALSE – device is unlocked (possible to use IR control and kiosk mode is disabled) TRUE – device is locked (no IR control, kiosk mode enabled) |
kiosk | boolean | alias to locked |
enabled | boolean | DEPRECATED - TRUE – device is unlocked (possible to use IR control and kiosk mode is disabled) FALSE – device is locked (no IR control, kiosk mode enabled) |
Request
Responses
- 200
- 404
OK
Response Headers
Contains URL pointing to the result of this action. Keep making requests to this URL, until the response indicates, that the action was processed. For more information, refer to endpoint Get Device History.
Not Found