@signageos/front-applet 7.2.0 → 8.0.0

package/es6/FrontApplet/Management/RemoteControl/RemoteControl.js

@@ -1,56 +1,80 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * The `sos.management.remoteControl` groups together methods for enabling or disabling control of the device using IR remote controller (TV controller).
+ */
 class RemoteControl {
+    messagePrefix;
+    postMessage;
+    /** @internal */
     constructor(messagePrefix, postMessage) {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
     }
-    enable() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.setEnabled(true);
-        });
+    /**
+     * The `enable()` method enables remote control.
+     *
+     * :::warning
+     *
+     * **Android:** In order to prevent Android from displaying Android homepage and thus not showing your content, you
+     * must Enable Kiosk Mode (or Lock Remote Control) either through Box device settings or through API.
+     *
+     * Always set the Remote Control Lock to `enable` after the deployment.
+     *
+     * :::
+     *
+     * @since 3.0.0
+     */
+    async enable() {
+        await this.setEnabled(true);
     }
-    disable() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.setEnabled(false);
-        });
+    /**
+     * The `disable()` method disables remote control.
+     *
+     * @since 3.0.0
+     */
+    async disable() {
+        await this.setEnabled(false);
     }
-    isEnabled() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { isRemoteControlEnabled } = yield this.postMessage({
-                type: this.getMessage('get_is_remote_control_enabled'),
-            });
-            return isRemoteControlEnabled;
+    /**
+     * The `isEnabled()` method returns whether the remote control is enabled.
+     *
+     * @since 4.0.0
+     */
+    async isEnabled() {
+        const { isRemoteControlEnabled } = await this.postMessage({
+            type: this.getMessage('get_is_remote_control_enabled'),
         });
+        return isRemoteControlEnabled;
     }
-    lock() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.disable();
-        });
+    /**
+     * The `lock()` method is an alias for the `disable()` method.
+     *
+     * @since 4.0.0
+     */
+    async lock() {
+        await this.disable();
     }
-    unlock() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.enable();
-        });
+    /**
+     * The `unlock()` method is an alias for the `enable()` method.
+     *
+     * @since 4.0.0
+     */
+    async unlock() {
+        await this.enable();
     }
-    isLocked() {
-        return this.isEnabled();
+    /**
+     * The `isLocked()` method returns whether the remote control is locked (disabled).
+     *
+     * @since 4.0.0
+     */
+    async isLocked() {
+        return !(await this.isEnabled());
     }
-    setEnabled(enabled) {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.postMessage({
-                type: this.getMessage('set_remote_control_enabled'),
-                enabled,
-            });
+    async setEnabled(enabled) {
+        await this.postMessage({
+            type: this.getMessage('set_remote_control_enabled'),
+            enabled,
         });
     }
     getMessage(name) {

package/es6/FrontApplet/Management/RemoteControl/RemoteControl.js.map

@@ -1 +1 @@
-{"version":3,"file":"RemoteControl.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/RemoteControl/RemoteControl.ts"],"names":[],"mappings":";;;;;;;;;;;AAGA,MAAqB,aAAa;IACjC,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAES,MAAM;;YAClB,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;KAAA;IAEY,OAAO;;YACnB,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAC9B,CAAC;KAAA;IAEY,SAAS;;YACrB,MAAM,EAAE,sBAAsB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBACzD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,+BAA+B,CAAC;aACtD,CAAC,CAAC;YAEH,OAAO,sBAAsB,CAAC;QAC/B,CAAC;KAAA;IAEY,IAAI;;YAChB,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACtB,CAAC;KAAA;IAEY,MAAM;;YAClB,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACrB,CAAC;KAAA;IAEM,QAAQ;QACd,OAAO,IAAI,CAAC,SAAS,EAAE,CAAC;IACzB,CAAC;IAEa,UAAU,CAAC,OAAgB;;YACxC,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;gBACnD,OAAO;aACP,CAAC,CAAC;QACJ,CAAC;KAAA;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AA5CD,gCA4CC"}
+{"version":3,"file":"RemoteControl.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/RemoteControl/RemoteControl.ts"],"names":[],"mappings":";;AAGA;;GAEG;AACH,MAAqB,aAAa;IAGxB;IACA;IAHT,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,MAAM;QAClB,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS;QACrB,MAAM,EAAE,sBAAsB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACzD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,+BAA+B,CAAC;SACtD,CAAC,CAAC;QAEH,OAAO,sBAAsB,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI;QAChB,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM;QAClB,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ;QACpB,OAAO,CAAC,CAAC,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;IAClC,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,OAAgB;QACxC,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;YACnD,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AApFD,gCAoFC"}

package/es6/FrontApplet/Management/Screen/Screen.d.ts

@@ -2,17 +2,144 @@ import IPostMessage from '../../IPostMessage';
 import IBrightness from './IBrightness';
 import IOrientation from './IOrientation';
 import IScreen from './IScreen';
+/**
+ * The `sos.management.screen` API groups together methods for controlling the screen of the device. It allows to manipulate the screen
+ * resolution or orientation, set brightness, retrieve the current brightness of the display and manipulate the power mode.
+ *
+ * :::warning
+ *
+ * This method only turns on/off the display/backlight. It will **not** set any power-saving mode. We also strongly recommend to reboot any
+ * device once a day.
+ *
+ * :::
+ *
+ * :::info
+ *
+ * There is a specific behavior based on the device type you operate:
+ * **On SoC displays** (e.g. Samsung Tizen, LG webOS, Android-based SoC displays from Sony, Vestel Philips,...)
+ * - `powerOn()` and `powerOff()` are turning the display backlight and the panel off
+ *
+ * **On external media players** (e.g. BrightSign, Windows PC, Android players, Raspberry Pi)
+ * - `powerOn()` and `powerOff()` are turning off the video output (typically HDMI-out); the connected display backlight is not managed by this functionality and needs to be controlled via RS232 or another way.
+ *
+ * :::
+ */
 export default class Screen implements IScreen {
     private messagePrefix;
     private postMessage;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
+    /**
+     * The `resize()` method changes resolution and orientation of the display.
+     *
+     * :::info
+     *
+     * For Tizen, you have to provide `baseUrl` which points to the Core App for Tizen which will be downloaded to the device [Read more how to upload your Core Apps here.](https://docs.signageos.io/hc/en-us/articles/4405245195666).
+     *
+     * :::
+     *
+     * @param baseUrl SSSP & Tizen devices requires to install a orientation-specific Core App if you want to switch orientation to portrait or landscape.
+     * @param orientation Screen orientation
+     * @param resolution Where it applies (mainly SSSP 2/3)
+     * @param currentVersion Core App version
+     * @param videoOrientation If the video has different orientation than the HTML5 content
+     *
+     * @since 3.0.0
+     *
+     * @example
+     * // for Tizen
+     * await sos.management.screen.resize(
+     *     "https://cdn.your-cms.com/tizen/1.0.4",
+     *     "PORTRAIT",
+     *     "FULL_READY",
+     *     "1.0.4"
+     * );
+     *
+     * // for all other supported device
+     * await sos.management.screen.resize(
+     *     "",
+     *     "PORTRAIT",
+     *     "HD_READY",
+     *     ""
+     * );
+     *
+     * @example // {@link https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/resize/ |How to resize screen on device}
+     */
     resize(baseUrl: string, orientation: string, resolution: string, currentVersion: string, videoOrientation?: string): Promise<void>;
+    /**
+     * The `getOrientation()` method returns the current orientation of the screen.
+     *
+     * @since 4.7.0
+     */
     getOrientation(): Promise<IOrientation>;
+    /**
+     * The `setBrightness()` method sets the brightness of the screen. It supports 2 different brightness values for 2 time points in the day.
+     *
+     * @param timeFrom1 Time in the XX:XX format
+     * @param brightness1 Brightness value between 0 and 100
+     * @param timeFrom2 Time in the XX:XX format
+     * @param brightness2 Brightness value between 0 and 100
+     *
+     * @since 3.0.0
+     *
+     * @example
+     * await sos.management.screen.setBrightness(
+     *     '00:00',
+     *     '10',
+     *     '17:00',
+     *     '30'
+     * );
+     */
     setBrightness(timeFrom1: string, brightness1: number, timeFrom2: string, brightness2: number): Promise<void>;
+    /**
+     * The `getBrightness()` method returns information about the currently set brightness values.
+     *
+     * @since 3.0.0
+     */
     getBrightness(): Promise<IBrightness>;
+    /**
+     * The `takeAndUploadScreenshot()` method takes a screenshot and uploads it to a specified url. This can be either a signageOS upload url
+     * (`https://upload.signageos.io`) or a dedicated server url for uploading screenshots. Format in which the screenshot is uploaded may be
+     * different for every platform.
+     *
+     * To implement a custom screenshot upload server, it needs to implement these endpoints:
+     * - POST `/upload/file?prefix=screenshot/` - Endpoint for receiving screenshot using form data, with the image set to the `file` field.
+     * - POST `/upload/raw?prefix=screenshot/` - Endpoint for receiving screenshots as a raw data.
+     * - POST `/upload/image-data-uri?prefix=screenshot/` - Endpoint for receiving screenshots encoded as a data url.
+     *
+     * signageOS provides standalone server which is implements all of those methods. It is provided to all of our partners through the
+     * [support ticketing system](https://box.signageos.io/support/).
+     *
+     * @since 3.0.0
+     */
     takeAndUploadScreenshot(uploadBaseUrl: string): Promise<string>;
+    /**
+     * The `powerOn()` method turns the screen on.
+     *
+     *
+     * @since 3.0.0
+     */
     powerOn(): Promise<void>;
+    /**
+     * The `powerOff()` method turn the screen off.
+     *
+     * :::warning
+     *
+     * On Android devices, `powerOff()` also shuts down the webview and the Applet. It's default Android behavior that cannot be changed. Once
+     * the Applet is off, you cannot call `powerOn()` to resume the playback.
+     *
+     * To manage the display On/Off state, use [REST API Power Actions](https://developers.signageos.io/api/#tag/DevicePower-Actions) instead.
+     *
+     * :::
+     *
+     * @since 3.0.0
+     */
     powerOff(): Promise<void>;
+    /**
+     * The `isPoweredOn()` method returns whether the screen is on.
+     *
+     * @since 3.0.0
+     */
     isPoweredOn(): Promise<boolean>;
     private getMessage;
     private getMessagePrefix;

package/es6/FrontApplet/Management/Screen/Screen.js

@@ -1,117 +1,225 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const DeviceHelper_1 = require("../helpers/DeviceHelper");
 const VideoHelper_1 = require("../helpers/VideoHelper");
-const Validate_1 = require("../../Validate/Validate");
+const Validate_1 = __importDefault(require("../../Validate/Validate"));
+// TODO: how does this work if there are multiple displays
+/**
+ * The `sos.management.screen` API groups together methods for controlling the screen of the device. It allows to manipulate the screen
+ * resolution or orientation, set brightness, retrieve the current brightness of the display and manipulate the power mode.
+ *
+ * :::warning
+ *
+ * This method only turns on/off the display/backlight. It will **not** set any power-saving mode. We also strongly recommend to reboot any
+ * device once a day.
+ *
+ * :::
+ *
+ * :::info
+ *
+ * There is a specific behavior based on the device type you operate:
+ * **On SoC displays** (e.g. Samsung Tizen, LG webOS, Android-based SoC displays from Sony, Vestel Philips,...)
+ * - `powerOn()` and `powerOff()` are turning the display backlight and the panel off
+ *
+ * **On external media players** (e.g. BrightSign, Windows PC, Android players, Raspberry Pi)
+ * - `powerOn()` and `powerOff()` are turning off the video output (typically HDMI-out); the connected display backlight is not managed by this functionality and needs to be controlled via RS232 or another way.
+ *
+ * :::
+ */
 class Screen {
+    messagePrefix;
+    postMessage;
+    /** @internal */
     constructor(messagePrefix, postMessage) {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
     }
-    resize(baseUrl, orientation, resolution, currentVersion, videoOrientation) {
-        return __awaiter(this, void 0, void 0, function* () {
-            (0, Validate_1.default)({ baseUrl }).required().uri();
-            (0, Validate_1.default)({ currentVersion }).required().string();
-            if (typeof DeviceHelper_1.Orientation[orientation] === 'undefined') {
-                throw new Error('Invalid orientation');
-            }
-            if (typeof DeviceHelper_1.Resolution[resolution] === 'undefined') {
-                throw new Error('Invalid resolution');
-            }
-            if (videoOrientation && typeof VideoHelper_1.Orientation[videoOrientation] === 'undefined') {
-                throw new Error('Invalid video orientation');
-            }
-            yield this.postMessage({
-                type: this.getMessage('resize_screen'),
-                baseUrl,
-                orientation,
-                resolution,
-                currentVersion,
-                videoOrientation,
-            });
+    /**
+     * The `resize()` method changes resolution and orientation of the display.
+     *
+     * :::info
+     *
+     * For Tizen, you have to provide `baseUrl` which points to the Core App for Tizen which will be downloaded to the device [Read more how to upload your Core Apps here.](https://docs.signageos.io/hc/en-us/articles/4405245195666).
+     *
+     * :::
+     *
+     * @param baseUrl SSSP & Tizen devices requires to install a orientation-specific Core App if you want to switch orientation to portrait or landscape.
+     * @param orientation Screen orientation
+     * @param resolution Where it applies (mainly SSSP 2/3)
+     * @param currentVersion Core App version
+     * @param videoOrientation If the video has different orientation than the HTML5 content
+     *
+     * @since 3.0.0
+     *
+     * @example
+     * // for Tizen
+     * await sos.management.screen.resize(
+     *     "https://cdn.your-cms.com/tizen/1.0.4",
+     *     "PORTRAIT",
+     *     "FULL_READY",
+     *     "1.0.4"
+     * );
+     *
+     * // for all other supported device
+     * await sos.management.screen.resize(
+     *     "",
+     *     "PORTRAIT",
+     *     "HD_READY",
+     *     ""
+     * );
+     *
+     * @example // {@link https://github.com/signageos/applet-examples/blob/master/examples/management-js-api/resize/ |How to resize screen on device}
+     */
+    async resize(baseUrl, orientation, resolution, currentVersion, videoOrientation) {
+        (0, Validate_1.default)({ baseUrl }).required().uri();
+        (0, Validate_1.default)({ currentVersion }).required().string();
+        if (typeof DeviceHelper_1.Orientation[orientation] === 'undefined') {
+            throw new Error('Invalid orientation');
+        }
+        if (typeof DeviceHelper_1.Resolution[resolution] === 'undefined') {
+            throw new Error('Invalid resolution');
+        }
+        if (videoOrientation && typeof VideoHelper_1.Orientation[videoOrientation] === 'undefined') {
+            throw new Error('Invalid video orientation');
+        }
+        await this.postMessage({
+            type: this.getMessage('resize_screen'),
+            baseUrl,
+            orientation,
+            resolution,
+            currentVersion,
+            videoOrientation,
         });
     }
-    getOrientation() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { screenOrientation } = yield this.postMessage({
-                type: this.getMessage('get_screen_orientation'),
-            });
-            return screenOrientation;
+    /**
+     * The `getOrientation()` method returns the current orientation of the screen.
+     *
+     * @since 4.7.0
+     */
+    async getOrientation() {
+        const { screenOrientation } = await this.postMessage({
+            type: this.getMessage('get_screen_orientation'),
         });
+        return screenOrientation;
     }
-    setBrightness(timeFrom1, brightness1, timeFrom2, brightness2) {
-        return __awaiter(this, void 0, void 0, function* () {
-            (0, Validate_1.default)({ brightness1 }).required().number().min(0).max(100);
-            (0, Validate_1.default)({ brightness2 }).required().number().min(0).max(100);
-            (0, Validate_1.default)({ timeFrom1 })
-                .canBeNull()
-                .required()
-                .string()
-                .matchRegExp(/\d{2}:\d{2}/)
-                .timerTime();
-            (0, Validate_1.default)({ timeFrom2 })
-                .canBeNull()
-                .required()
-                .string()
-                .matchRegExp(/\d{2}:\d{2}/)
-                .timerTime();
-            yield this.postMessage({
-                type: this.getMessage('set_screen_brightness'),
-                timeFrom1,
-                brightness1,
-                timeFrom2,
-                brightness2,
-            });
+    /**
+     * The `setBrightness()` method sets the brightness of the screen. It supports 2 different brightness values for 2 time points in the day.
+     *
+     * @param timeFrom1 Time in the XX:XX format
+     * @param brightness1 Brightness value between 0 and 100
+     * @param timeFrom2 Time in the XX:XX format
+     * @param brightness2 Brightness value between 0 and 100
+     *
+     * @since 3.0.0
+     *
+     * @example
+     * await sos.management.screen.setBrightness(
+     *     '00:00',
+     *     '10',
+     *     '17:00',
+     *     '30'
+     * );
+     */
+    async setBrightness(timeFrom1, brightness1, timeFrom2, brightness2) {
+        (0, Validate_1.default)({ brightness1 }).required().number().min(0).max(100);
+        (0, Validate_1.default)({ brightness2 }).required().number().min(0).max(100);
+        (0, Validate_1.default)({ timeFrom1 })
+            .canBeNull()
+            .required()
+            .string()
+            .matchRegExp(/\d{2}:\d{2}/)
+            .timerTime();
+        (0, Validate_1.default)({ timeFrom2 })
+            .canBeNull()
+            .required()
+            .string()
+            .matchRegExp(/\d{2}:\d{2}/)
+            .timerTime();
+        await this.postMessage({
+            type: this.getMessage('set_screen_brightness'),
+            timeFrom1,
+            brightness1,
+            timeFrom2,
+            brightness2,
         });
     }
-    getBrightness() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { screenBrightness } = yield this.postMessage({
-                type: this.getMessage('get_screen_brightness'),
-            });
-            return screenBrightness;
+    /**
+     * The `getBrightness()` method returns information about the currently set brightness values.
+     *
+     * @since 3.0.0
+     */
+    async getBrightness() {
+        const { screenBrightness } = await this.postMessage({
+            type: this.getMessage('get_screen_brightness'),
         });
+        return screenBrightness;
     }
-    takeAndUploadScreenshot(uploadBaseUrl) {
-        return __awaiter(this, void 0, void 0, function* () {
-            (0, Validate_1.default)({ uploadBaseUrl }).required().uri();
-            const { screenshotUrl } = yield this.postMessage({
-                type: this.getMessage('upload_screenshot'),
-                uploadBaseUrl,
-            });
-            return screenshotUrl;
+    /**
+     * The `takeAndUploadScreenshot()` method takes a screenshot and uploads it to a specified url. This can be either a signageOS upload url
+     * (`https://upload.signageos.io`) or a dedicated server url for uploading screenshots. Format in which the screenshot is uploaded may be
+     * different for every platform.
+     *
+     * To implement a custom screenshot upload server, it needs to implement these endpoints:
+     * - POST `/upload/file?prefix=screenshot/` - Endpoint for receiving screenshot using form data, with the image set to the `file` field.
+     * - POST `/upload/raw?prefix=screenshot/` - Endpoint for receiving screenshots as a raw data.
+     * - POST `/upload/image-data-uri?prefix=screenshot/` - Endpoint for receiving screenshots encoded as a data url.
+     *
+     * signageOS provides standalone server which is implements all of those methods. It is provided to all of our partners through the
+     * [support ticketing system](https://box.signageos.io/support/).
+     *
+     * @since 3.0.0
+     */
+    async takeAndUploadScreenshot(uploadBaseUrl) {
+        (0, Validate_1.default)({ uploadBaseUrl }).required().uri();
+        const { screenshotUrl } = await this.postMessage({
+            type: this.getMessage('upload_screenshot'),
+            uploadBaseUrl,
         });
+        return screenshotUrl;
     }
-    powerOn() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.postMessage({
-                type: this.getMessage('power_on_display'),
-            });
+    /**
+     * The `powerOn()` method turns the screen on.
+     *
+     *
+     * @since 3.0.0
+     */
+    async powerOn() {
+        await this.postMessage({
+            type: this.getMessage('power_on_display'),
         });
     }
-    powerOff() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.postMessage({
-                type: this.getMessage('power_off_display'),
-            });
+    /**
+     * The `powerOff()` method turn the screen off.
+     *
+     * :::warning
+     *
+     * On Android devices, `powerOff()` also shuts down the webview and the Applet. It's default Android behavior that cannot be changed. Once
+     * the Applet is off, you cannot call `powerOn()` to resume the playback.
+     *
+     * To manage the display On/Off state, use [REST API Power Actions](https://developers.signageos.io/api/#tag/DevicePower-Actions) instead.
+     *
+     * :::
+     *
+     * @since 3.0.0
+     */
+    async powerOff() {
+        await this.postMessage({
+            type: this.getMessage('power_off_display'),
         });
     }
-    isPoweredOn() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { isDisplayPowerOn } = yield this.postMessage({
-                type: this.getMessage('get_is_display_power_on'),
-            });
-            return isDisplayPowerOn;
+    /**
+     * The `isPoweredOn()` method returns whether the screen is on.
+     *
+     * @since 3.0.0
+     */
+    async isPoweredOn() {
+        const { isDisplayPowerOn } = await this.postMessage({
+            type: this.getMessage('get_is_display_power_on'),
         });
+        return isDisplayPowerOn;
     }
     getMessage(name) {
         return this.getMessagePrefix() + '.' + name;

package/es6/FrontApplet/Management/Screen/Screen.js.map

@@ -1 +1 @@
-{"version":3,"file":"Screen.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Screen/Screen.ts"],"names":[],"mappings":";;;;;;;;;;;AAGA,0DAAkE;AAClE,wDAAyE;AACzE,sDAA+C;AAG/C,MAAqB,MAAM;IAC1B,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAES,MAAM,CAClB,OAAe,EACf,WAAmB,EACnB,UAAkB,EAClB,cAAsB,EACtB,gBAAyB;;YAEzB,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC;YACvC,IAAA,kBAAQ,EAAC,EAAE,cAAc,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;YACjD,IAAI,OAAO,0BAAW,CAAC,WAAuC,CAAC,KAAK,WAAW,EAAE;gBAChF,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;aACvC;YACD,IAAI,OAAO,yBAAU,CAAC,UAAqC,CAAC,KAAK,WAAW,EAAE;gBAC7E,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;aACtC;YACD,IAAI,gBAAgB,IAAI,OAAO,yBAAgB,CAAC,gBAAiD,CAAC,KAAK,WAAW,EAAE;gBACnH,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;aAC7C;YAED,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;gBACtC,OAAO;gBACP,WAAW;gBACX,UAAU;gBACV,cAAc;gBACd,gBAAgB;aAChB,CAAC,CAAC;QACJ,CAAC;KAAA;IAEY,cAAc;;YAC1B,MAAM,EAAE,iBAAiB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBACpD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;aAC/C,CAAC,CAAC;YAEH,OAAO,iBAAiB,CAAC;QAC1B,CAAC;KAAA;IAEY,aAAa,CAAC,SAAiB,EAAE,WAAmB,EAAE,SAAiB,EAAE,WAAmB;;YACxG,IAAA,kBAAQ,EAAC,EAAE,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC9D,IAAA,kBAAQ,EAAC,EAAE,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC9D,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC;iBACrB,SAAS,EAAE;iBACX,QAAQ,EAAE;iBACV,MAAM,EAAE;iBACR,WAAW,CAAC,aAAa,CAAC;iBAC1B,SAAS,EAAE,CAAC;YACd,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC;iBACrB,SAAS,EAAE;iBACX,QAAQ,EAAE;iBACV,MAAM,EAAE;iBACR,WAAW,CAAC,aAAa,CAAC;iBAC1B,SAAS,EAAE,CAAC;YAEd,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;gBAC9C,SAAS;gBACT,WAAW;gBACX,SAAS;gBACT,WAAW;aACX,CAAC,CAAC;QACJ,CAAC;KAAA;IAEY,aAAa;;YACzB,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBACnD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;aAC9C,CAAC,CAAC;YAEH,OAAO,gBAAgB,CAAC;QACzB,CAAC;KAAA;IAEY,uBAAuB,CAAC,aAAqB;;YACzD,IAAA,kBAAQ,EAAC,EAAE,aAAa,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC;YAC7C,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAChD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;gBAC1C,aAAa;aACb,CAAC,CAAC;YAEH,OAAO,aAAa,CAAC;QACtB,CAAC;KAAA;IAEY,OAAO;;YACnB,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;aACzC,CAAC,CAAC;QACJ,CAAC;KAAA;IAEY,QAAQ;;YACpB,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;aAC1C,CAAC,CAAC;QACJ,CAAC;KAAA;IAEY,WAAW;;YACvB,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBACnD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;aAChD,CAAC,CAAC;YAEH,OAAO,gBAAgB,CAAC;QACzB,CAAC;KAAA;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,gBAAgB,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC;IAC7C,CAAC;IAEO,gBAAgB;QACvB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC3B,CAAC;CACD;AAjHD,yBAiHC"}
+{"version":3,"file":"Screen.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Screen/Screen.ts"],"names":[],"mappings":";;;;;AAGA,0DAAkE;AAClE,wDAAyE;AACzE,uEAA+C;AAG/C,0DAA0D;AAC1D;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAqB,MAAM;IAGjB;IACA;IAHT,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACI,KAAK,CAAC,MAAM,CAClB,OAAe,EACf,WAAmB,EACnB,UAAkB,EAClB,cAAsB,EACtB,gBAAyB;QAEzB,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC;QACvC,IAAA,kBAAQ,EAAC,EAAE,cAAc,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QACjD,IAAI,OAAO,0BAAW,CAAC,WAAuC,CAAC,KAAK,WAAW,EAAE,CAAC;YACjF,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,OAAO,yBAAU,CAAC,UAAqC,CAAC,KAAK,WAAW,EAAE,CAAC;YAC9E,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACvC,CAAC;QACD,IAAI,gBAAgB,IAAI,OAAO,yBAAgB,CAAC,gBAAiD,CAAC,KAAK,WAAW,EAAE,CAAC;YACpH,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC9C,CAAC;QAED,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;YACtC,OAAO;YACP,WAAW;YACX,UAAU;YACV,cAAc;YACd,gBAAgB;SAChB,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc;QAC1B,MAAM,EAAE,iBAAiB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACpD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;SAC/C,CAAC,CAAC;QAEH,OAAO,iBAAiB,CAAC;IAC1B,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,KAAK,CAAC,aAAa,CAAC,SAAiB,EAAE,WAAmB,EAAE,SAAiB,EAAE,WAAmB;QACxG,IAAA,kBAAQ,EAAC,EAAE,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9D,IAAA,kBAAQ,EAAC,EAAE,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9D,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC;aACrB,SAAS,EAAE;aACX,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,aAAa,CAAC;aAC1B,SAAS,EAAE,CAAC;QACd,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC;aACrB,SAAS,EAAE;aACX,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,aAAa,CAAC;aAC1B,SAAS,EAAE,CAAC;QAEd,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;YAC9C,SAAS;YACT,WAAW;YACX,SAAS;YACT,WAAW;SACX,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,aAAa;QACzB,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACnD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;SAC9C,CAAC,CAAC;QAEH,OAAO,gBAAgB,CAAC;IACzB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,KAAK,CAAC,uBAAuB,CAAC,aAAqB;QACzD,IAAA,kBAAQ,EAAC,EAAE,aAAa,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,GAAG,EAAE,CAAC;QAC7C,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAChD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;YAC1C,aAAa;SACb,CAAC,CAAC;QAEH,OAAO,aAAa,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;SACzC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,QAAQ;QACpB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;SAC1C,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW;QACvB,MAAM,EAAE,gBAAgB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACnD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;SAChD,CAAC,CAAC;QAEH,OAAO,gBAAgB,CAAC;IACzB,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,gBAAgB,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC;IAC7C,CAAC;IAEO,gBAAgB;QACvB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC3B,CAAC;CACD;AA1ND,yBA0NC"}

package/es6/FrontApplet/Management/Security/Security.d.ts

@@ -1,21 +1,36 @@
 import IPostMessage from '../../IPostMessage';
 import ISecurity from './ISecurity';
+/**
+ * The `sos.management.security` API groups together methods for management of a security PIN code of the device.
+ */
 export default class Security implements ISecurity {
     private messagePrefix;
     private postMessage;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
     /**
-     * Get PIN code
-     * @returns 4 digits number string
+     * The `getPinCode()` method returns the currently set PIN code.
+     *
+     * @throws {AppletSecurityError} **41703**: Get PIN code failed because the PIN code has not been set yet.
+     *
+     * @since 4.1.0
      */
     getPinCode(): Promise<string>;
     /**
-     * Set PIN code
-     * @param pinCode 4 digits number string
+     * The `setPinCode()` method sets the pin code.
+     *
+     * @param pinCode The PIN code to be set.
+     *
+     * @throws {AppletSecurityError} **41701**: Invalid PIN code format (has to be 4-digits string).
+     * @throws {AppletSecurityError} **41702**: PIN code 0000 is not allowed, use another PIN code.
+     *
+     * @since 4.1.0
      */
     setPinCode(pinCode: string): Promise<void>;
     /**
-     * Generate 4 digits number string and set it as PIN code
+     * The `getPinCode()` method sets the PIN code to a randomly generated one.
+     *
+     * @since 4.1.0
      */
     generateRandomPinCode(): Promise<void>;
     private getMessage;