@signageos/front-applet 7.1.1 → 8.0.0

package/es6/FrontApplet/Management/Debug/Debug.js

@@ -1,45 +1,52 @@
 "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 Validate_1 = require("../../Validate/Validate");
+const Validate_1 = __importDefault(require("../../Validate/Validate"));
+/**
+ * The `sos.management.debug` API groups together method for working with native debug mode.
+ */
 class Debug {
+    messagePrefix;
+    postMessage;
+    /** @internal */
     constructor(messagePrefix, postMessage) {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
     }
-    enable() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.setDebug(true);
-        });
+    /**
+     * The `enable()` method enables the [native debug](https://docs.signageos.io/hc/en-us/articles/4413935787154-Applet-Native-Device-Debug) mode.
+     *
+     * @since 3.0.0
+     */
+    async enable() {
+        await this.setDebug(true);
     }
-    disable() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.setDebug(false);
-        });
+    /**
+     * The `enable()` method disables the [native debug](https://docs.signageos.io/hc/en-us/articles/4413935787154-Applet-Native-Device-Debug) mode.
+     *
+     * @since 3.0.0
+     */
+    async disable() {
+        await this.setDebug(false);
     }
-    isEnabled() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { isEnabled } = yield this.postMessage({
-                type: this.getMessage('is_enabled'),
-            });
-            return isEnabled;
+    /**
+     * The `isEnabled()` method returns whether the [native debug](https://docs.signageos.io/hc/en-us/articles/4413935787154-Applet-Native-Device-Debug) mode is enabled.
+     *
+     * @since 4.1.0
+     */
+    async isEnabled() {
+        const { isEnabled } = await this.postMessage({
+            type: this.getMessage('is_enabled'),
         });
+        return isEnabled;
     }
-    setDebug(enabled) {
-        return __awaiter(this, void 0, void 0, function* () {
-            Validate_1.default({ enabled }).required().boolean();
-            yield this.postMessage({
-                type: this.getMessage('set_debug'),
-                enabled,
-            });
+    async setDebug(enabled) {
+        (0, Validate_1.default)({ enabled }).required().boolean();
+        await this.postMessage({
+            type: this.getMessage('set_debug'),
+            enabled,
         });
     }
     getMessage(name) {

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

@@ -1 +1 @@
-{"version":3,"file":"Debug.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Debug/Debug.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,sDAA+C;AAG/C,MAAqB,KAAK;IACzB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAES,MAAM;;YAClB,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC3B,CAAC;KAAA;IAEY,OAAO;;YACnB,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC5B,CAAC;KAAA;IAEY,SAAS;;YACrB,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAC5C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;aACnC,CAAC,CAAC;YAEH,OAAO,SAAS,CAAC;QAClB,CAAC;KAAA;IAEa,QAAQ,CAAC,OAAgB;;YACtC,kBAAQ,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC;YAC3C,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;gBAClC,OAAO;aACP,CAAC,CAAC;QACJ,CAAC;KAAA;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AAjCD,wBAiCC"}
+{"version":3,"file":"Debug.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Debug/Debug.ts"],"names":[],"mappings":";;;;;AACA,uEAA+C;AAG/C;;GAEG;AACH,MAAqB,KAAK;IAGhB;IACA;IAHT,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;OAIG;IACI,KAAK,CAAC,MAAM;QAClB,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS;QACrB,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC5C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;SACnC,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IAClB,CAAC;IAEO,KAAK,CAAC,QAAQ,CAAC,OAAgB;QACtC,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC;QAC3C,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YAClC,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AAjDD,wBAiDC"}

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

@@ -1,27 +1,39 @@
 import IPostMessage from '../../IPostMessage';
-import { FirmwareType } from './FirmwareType';
 import IFirmware from './IFirmware';
+/**
+ * The `sos.management.firmware` API groups together methods for working with the firmware of the device.
+ */
 export default class Firmware implements IFirmware {
     private messagePrefix;
     private postMessage;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
     /**
-     * Platform users can install general firmware version directly with passing just version number.
-     * Optionally, the baseUrl can be passed as argument to specify server where the firmware files are accessible.
+     * The `upgrade(version, baseUrl?)` method initializes a firmware upgrade using version and baseUrl. Platform users can install general
+     * firmware version directly with passing just version number. Optionally, the baseUrl can be passed as argument to specify server where
+     * the firmware files are accessible.
      *
-     * @param version of installing firmware
-     * @param baseUrl server URL where fw files are located (default: https://2.signageos.io)
+     * @param version The version of the firmware being installed.
+     * @param [baseUrl='https://2.signageos.io'] Optional server URL where firmware files are located.
+     *
+     * @since 4.0.0
      */
     upgrade(version: string, baseUrl?: string): Promise<void>;
     /**
-     * Alias for method with swapped arguments
+     * The `upgrade(baseUrl, version)` does the same as `upgrade(version, baseUrl)`.
+     *
      * @alias upgrade(version: string, baseUrl?: string)
-     * @param baseUrl server URL where fw files are located
-     * @param version of installing firmware
+     *
+     * @param baseUrl The server URL where firmware files are located.
+     * @param version The version of the firmware being installed.
+     *
+     * @since 4.0.0
      */
     upgrade(baseUrl: string, version: string): Promise<void>;
     /**
-     * Open users can upgrade fw passing FQN uri where the firmware main file is located.
+     * The `upgrade(fwUri)` method initializes a firmware upgrade. Open users can upgrade fw passing FQN
+     * uri where the firmware main file is located.
+     *
      * This file type/extension differs for every platform. E.g.:
      * - SSSP: http://example.com/fw/T-0.0.0.msd
      * - Tizen: http://example.com/fw/T-0.0.0.bem
@@ -29,10 +41,25 @@ export default class Firmware implements IFirmware {
      * - Brightsign: http://example.com/fw/hd2-0.0.0.bsfw
      * - Linux: http://example.com/fw/rpi-0.0.0.img.zip
      * - Android: http://example.com/fw/FB-00.0.0.zip
+     *
      * @param fwUri FQN uri where the firmware main file is located.
+     *
+     * @since 4.0.0
      */
     upgrade(fwUri: string): Promise<void>;
+    /**
+     * The `getVersion()` method returns the version of the firmware currently installed on the device.
+     *
+     * @since 4.0.0
+     */
     getVersion(): Promise<string>;
-    getType(): Promise<FirmwareType>;
+    /**
+     * The `getType()` method returns the type of the firmware currently installed on the device.
+     *
+     * This information, when combined with firmware version, can be used to identify a correct firmware image to install on the current device.
+     *
+     * @since 4.8.0
+     */
+    getType(): Promise<string>;
     private getMessage;
 }

package/es6/FrontApplet/Management/Firmware/Firmware.js

@@ -1,46 +1,50 @@
 "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 });
 const UpgradeHelper_1 = require("../helpers/UpgradeHelper");
+/**
+ * The `sos.management.firmware` API groups together methods for working with the firmware of the device.
+ */
 class Firmware {
+    messagePrefix;
+    postMessage;
+    /** @internal */
     constructor(messagePrefix, postMessage) {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
     }
-    upgrade(arg1, arg2) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { baseUrl, version, directUri } = UpgradeHelper_1.parseUpgradeArguments(arg1, arg2);
-            yield this.postMessage({
-                type: this.getMessage('firmware_upgrade'),
-                baseUrl,
-                version,
-                directUri,
-            });
+    /** @internal */
+    async upgrade(arg1, arg2) {
+        const { baseUrl, version, directUri } = (0, UpgradeHelper_1.parseUpgradeArguments)(arg1, arg2);
+        await this.postMessage({
+            type: this.getMessage('firmware_upgrade'),
+            baseUrl,
+            version,
+            directUri,
         });
     }
-    getVersion() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { firmwareVersion } = yield this.postMessage({
-                type: this.getMessage('get_firmware_version'),
-            });
-            return firmwareVersion;
+    /**
+     * The `getVersion()` method returns the version of the firmware currently installed on the device.
+     *
+     * @since 4.0.0
+     */
+    async getVersion() {
+        const { firmwareVersion } = await this.postMessage({
+            type: this.getMessage('get_firmware_version'),
         });
+        return firmwareVersion;
     }
-    getType() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { firmwareType } = yield this.postMessage({
-                type: this.getMessage('get_firmware_type'),
-            });
-            return firmwareType;
+    /**
+     * The `getType()` method returns the type of the firmware currently installed on the device.
+     *
+     * This information, when combined with firmware version, can be used to identify a correct firmware image to install on the current device.
+     *
+     * @since 4.8.0
+     */
+    async getType() {
+        const { firmwareType } = await this.postMessage({
+            type: this.getMessage('get_firmware_type'),
         });
+        return firmwareType;
     }
     getMessage(name) {
         return this.messagePrefix + '.' + name;

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

@@ -1 +1 @@
-{"version":3,"file":"Firmware.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Firmware/Firmware.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,4DAAiE;AAIjE,MAAqB,QAAQ;IAC5B,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IA8BS,OAAO,CAAC,IAAY,EAAE,IAAa;;YAC/C,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,qCAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAC1E,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;gBACzC,OAAO;gBACP,OAAO;gBACP,SAAS;aACT,CAAC,CAAC;QACJ,CAAC;KAAA;IAEY,UAAU;;YACtB,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAClD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;aAC7C,CAAC,CAAC;YAEH,OAAO,eAAe,CAAC;QACxB,CAAC;KAAA;IAEY,OAAO;;YACnB,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAC/C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;aAC1C,CAAC,CAAC;YACH,OAAO,YAAY,CAAC;QACrB,CAAC;KAAA;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AA9DD,2BA8DC"}
+{"version":3,"file":"Firmware.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Firmware/Firmware.ts"],"names":[],"mappings":";;AACA,4DAAiE;AAGjE;;GAEG;AACH,MAAqB,QAAQ;IAGnB;IACA;IAHT,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IA4CJ,gBAAgB;IACT,KAAK,CAAC,OAAO,CAAC,IAAY,EAAE,IAAa;QAC/C,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,IAAA,qCAAqB,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC1E,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;YACzC,OAAO;YACP,OAAO;YACP,SAAS;SACT,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,UAAU;QACtB,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAClD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;SAC7C,CAAC,CAAC;QAEH,OAAO,eAAe,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC/C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;SAC1C,CAAC,CAAC;QACH,OAAO,YAAY,CAAC;IACrB,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AA1FD,2BA0FC"}

package/es6/FrontApplet/Management/Firmware/IFirmware.d.ts

@@ -1,9 +1,8 @@
-import { FirmwareType } from './FirmwareType';
 export default interface IFirmware {
     upgrade(version: string, baseUrl?: string): Promise<void>;
     upgrade(baseUrl: string, version: string): Promise<void>;
     upgrade(fwUri: string): Promise<void>;
     upgrade(arg1: string, arg2?: string): Promise<void>;
     getVersion(): Promise<string>;
-    getType(): Promise<FirmwareType>;
+    getType(): Promise<string>;
 }

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

@@ -1,7 +1,9 @@
 import INetworkInfo from './Network/INetworkInfo';
 import IBatteryStatus from './IBatteryStatus';
+import { AnyString } from '../../utils/types';
+export type ManagementCapability = 'MODEL' | 'SERIAL_NUMBER' | 'BRAND' | 'OS_VERSION' | 'BATTERY_STATUS' | 'STORAGE_UNITS' | 'TEMPERATURE' | 'SCREENSHOT_UPLOAD' | 'NETWORK_INFO' | 'WIFI' | 'WIFI_SCAN' | 'WIFI_AP' | 'WIFI_STRENGTH' | 'TIMERS_PROPRIETARY' | 'BRIGHTNESS_SCHEDULING' | 'TIMERS_NATIVE' | 'SET_BRIGHTNESS' | 'GET_BRIGHTNESS' | 'SCREEN_RESIZE' | 'SET_TIME' | 'SET_TIMEZONE' | 'GET_TIMEZONE' | 'NTP_TIME' | 'APP_UPGRADE' | 'FIRMWARE_UPGRADE' | 'PACKAGE_INSTALL' | 'SET_VOLUME' | 'GET_VOLUME' | 'SET_REMOTE_CONTROL_ENABLED' | 'SET_DEBUG' | 'SYSTEM_REBOOT' | 'APP_RESTART' | 'DISPLAY_POWER' | 'SERVLET' | 'HARDWARE_LED_SET_COLOR' | 'PROXIMITY_SENSOR' | 'FACTORY_RESET' | 'ORIENTATION_LANDSCAPE' | 'ORIENTATION_PORTRAIT' | 'ORIENTATION_LANDSCAPE_FLIPPED' | 'ORIENTATION_PORTRAIT_FLIPPED' | 'ORIENTATION_AUTO' | 'SCHEDULE_POWER_ACTION' | 'EXTENDED_MANAGEMENT' | 'SYSTEM_CPU' | 'SYSTEM_MEMORY' | 'PROXY' | 'AUTO_RECOVERY' | 'PEER_RECOVERY' | 'FILE_SYSTEM_WIPEOUT' | 'REMOTE_DESKTOP' | 'HOTEL_MODE' | 'VPN' | 'CUSTOM_SCRIPTS' | 'NATIVE_COMMANDS_MDC' | 'DEVICE_OWNER' | 'ACCESSIBILITY_SERVICE' | 'DISPLAY_MANAGER' | 'SECRETS' | 'HARDWARE_ACCELERATION' | 'WIFI_COUNTRY' | AnyString;
 export default interface IManagement {
-    supports(capability: string): Promise<boolean>;
+    supports(capability: ManagementCapability): Promise<boolean>;
     getModel(): Promise<string>;
     getSerialNumber(): Promise<string>;
     getNetworkInfo(): Promise<INetworkInfo>;

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

@@ -1,23 +1,29 @@
 import IPostMessage from '../IPostMessage';
+import App from './App/App';
+import Audio from './Audio/Audio';
+import AutoRecovery from './AutoRecovery/AutoRecovery';
+import Debug from './Debug/Debug';
+import Firmware from './Firmware/Firmware';
 import IBatteryStatus from './IBatteryStatus';
+import IManagement, { ManagementCapability } from './IManagement';
 import INetworkInfo from './Network/INetworkInfo';
-import Firmware from './Firmware/Firmware';
-import Audio from './Audio/Audio';
-import Screen from './Screen/Screen';
-import RemoteControl from './RemoteControl/RemoteControl';
-import Time from './Time/Time';
-import App from './App/App';
+import Network from './Network/Network';
 import OS from './OS/OS';
-import Debug from './Debug/Debug';
 import Package from './Package/Package';
+import PeerRecovery from './PeerRecovery/PeerRecovery';
 import Power from './Power/Power';
-import Network from './Network/Network';
-import Wifi from './Wifi/Wifi';
-import Security from './Security/Security';
 import Proxy from './Proxy/Proxy';
-import PeerRecovery from './PeerRecovery/PeerRecovery';
-import AutoRecovery from './AutoRecovery/AutoRecovery';
-import IManagement from './IManagement';
+import RemoteControl from './RemoteControl/RemoteControl';
+import Screen from './Screen/Screen';
+import Security from './Security/Security';
+import Time from './Time/Time';
+import Wifi from './Wifi/Wifi';
+/**
+ * The `sos.management` API group provides methods for managing the device. Through this API things like device firmware,
+ * battery status, brightness, network information, remote control, power, time or volume can be monitored.
+ *
+ * @example // {@link https://developers.signageos.io/sdk/management/js-management-management Example of the App API}
+ */
 export default class Management implements IManagement {
     private messagePrefix;
     private postMessage;
@@ -38,20 +44,105 @@ export default class Management implements IManagement {
     readonly proxy: Proxy;
     readonly autoRecovery: AutoRecovery;
     readonly peerRecovery: PeerRecovery;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
-    supports(capability: string): Promise<boolean>;
+    /**
+     * The `supports()` method determines whether a queried capability is supported.
+     *
+     * @param capability The capability to check for support.
+     *
+     * @since 2.0.0
+     */
+    supports(capability: ManagementCapability): Promise<boolean>;
+    /**
+     * The `getModel()` method returns the model of the device.
+     *
+     * @since 2.0.0
+     */
     getModel(): Promise<string>;
+    /**
+     * The `getSerialNumber()` method returns the serial number of the device.
+     *
+     * @since 2.1.0
+     */
     getSerialNumber(): Promise<string>;
-    /** @deprecated Use sos.management.network.getActiveInfo() instead */
+    /** @deprecated Use `sos.management.network.listInterfaces()` instead. */
     getNetworkInfo(): Promise<INetworkInfo>;
+    /**
+     * The `getBatteryStatus()` method returns information about the battery of the device.
+     *
+     * @since 2.1.0
+     */
     getBatteryStatus(): Promise<IBatteryStatus>;
+    /**
+     * The `getTemperature()` method returns the temperature of the device (in 0-100 range of degrees Celsius).
+     *
+     * @since 3.0.0
+     */
     getTemperature(): Promise<number>;
+    /**
+     * The `getBrand()` method returns the manufacturer brand of the device.
+     *
+     * @since 5.7.0
+     */
     getBrand(): Promise<string>;
+    /**
+     * The `resetSettings()` method initializes the reset of the specific device settings.
+     *
+     * :::info
+     *
+     * This is currently only implemented on Linux platform.
+     *
+     * :::
+     *
+     * @since 4.0.0
+     */
     resetSettings(): Promise<void>;
+    /**
+     * The `factoryReset()` method initializes the factory reset of the device.
+     *
+     * @since 4.0.0
+     */
     factoryReset(): Promise<void>;
+    /**
+     * The `getExtendedManagementUrl()` method returns the management url of the device.
+     *
+     * :::info
+     *
+     * This is currently only implemented for the MagicInfo on Tizen platform.
+     *
+     * :::
+     *
+     * @since 6.2.0
+     */
     getExtendedManagementUrl(): Promise<string | null>;
+    /**
+     * The `getExtendedManagementUrl()` set the management url of the device.
+     *
+     * :::info
+     *
+     * This is currently only implemented for the MagicInfo on Tizen platform.
+     *
+     * :::
+     *
+     * @param url The management URL to set.
+     *
+     * @since 6.2.0
+     */
     setExtendedManagementUrl(url: string | null): Promise<void>;
+    /**
+     * The `setHardwareAcceleration()` method enables or disables hardware acceleration.
+     *
+     * @param enabled Whether hardware acceleration should be enabled.
+     *
+     * @since 7.1.0
+     */
     setHardwareAcceleration(enabled: boolean): Promise<void>;
+    /**
+     * The `isHardwareAccelerationEnabled()` method returns whether hardware acceleration is enabled.
+     *
+     * @since 7.1.0
+     */
     isHardwareAccelerationEnabled(): Promise<boolean>;
     private getMessage;
     private getMessagePrefix;