@signageos/front-applet 7.2.0 → 8.0.0

package/es6/FrontApplet/NativeCommands/MDC/Mdc.d.ts

@@ -8,14 +8,63 @@ export interface IMDCResponse {
     result: number;
 }
 /**
- * Implementation of MDC Serial Command communication for Tizen devices.
+ * The `sos.native.mdc` API groups together methods for controlling Tizen devices using MDC commands.
+ *
+ * :::warning
+ *
+ * This API is currently available on Tizen devices only.
+ *
+ * :::
+ *
+ * :::info
+ *
+ * You can ensure that the device supports MDC commands via `sos.management.supports("NATIVE_COMMANDS_MDC")`.
+ *
+ * :::
  */
 export default class Mdc implements INativeMdcCommands {
     private messagePrefix;
     private postMessage;
     static MESSAGE_PREFIX: string;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
-    sendOne(ipAddress: IpAddressType, command: CodesMDC, data?: number[] | []): Promise<IMDCResponse>;
+    /**
+     * The `sendOne()` method sends an MDC command to another Tizen device on the same network or to the localhost.
+     *
+     * @param ipAddress The IP address of the device to send the command to.
+     * @param command The MDC command to send.
+     * @param data The optional data to send with the command.
+     *
+     * @since 6.5.1
+     *
+     * @example
+     * await sos.native.mdc.sendOne('localhost', CodesMDC.BRIGHTNESS_CONTROL); // Promise<IMDCResponse>
+     * await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.VOLUME_CONTROL, [50]); // Promise<IMDCResponse>
+     * await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.PICTURE_CONTROL, [0x54, 0x03]); // Promise<IMDCResponse>
+     *
+     * // You can also send custom number if we don't have predefined command in our enum
+     * await sos.native.mdc.sendOne('192.168.0.10', 0x01, []); // Promise<IMDCResponse>
+     */
+    sendOne(ipAddress: IpAddressType, command: CodesMDC, data?: number[]): Promise<IMDCResponse>;
+    /**
+     * The `sendOneRaw()` method sends an MDC command to another Tizen device on the same network or to the localhost,
+     * but without explicitly specifying the command.
+     *
+     * @param ipAddress The IP address of the device to send the command to.
+     * @param data The data to send with the command.
+     *
+     * @since 6.5.1
+     *
+     * @example
+     * await sos.native.mdc.sendOneRaw('localhost', [0x1B, 0x00, 0x01, 0x74]); // Promise<IMDCResponse>
+     *
+     * // Example of returned object
+     * {
+     *     "type": "ACK", // or NACK
+     *     "commandType": 4,
+     *     "result": 0, // Value what command returned
+     * }
+     */
     sendOneRaw(ipAddress: IpAddressType, data: number[] | []): Promise<IMDCResponse>;
     private getMessage;
     private getMessagePrefix;

package/es6/FrontApplet/NativeCommands/MDC/Mdc.js

@@ -1,53 +1,95 @@
 "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"));
 /**
- * Implementation of MDC Serial Command communication for Tizen devices.
+ * The `sos.native.mdc` API groups together methods for controlling Tizen devices using MDC commands.
+ *
+ * :::warning
+ *
+ * This API is currently available on Tizen devices only.
+ *
+ * :::
+ *
+ * :::info
+ *
+ * You can ensure that the device supports MDC commands via `sos.management.supports("NATIVE_COMMANDS_MDC")`.
+ *
+ * :::
  */
 class Mdc {
+    messagePrefix;
+    postMessage;
+    static MESSAGE_PREFIX = 'mdc';
+    /** @internal */
     constructor(messagePrefix, postMessage) {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
     }
-    sendOne(ipAddress, command, data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            (0, Validate_1.default)({ ipAddress }).required().string();
-            (0, Validate_1.default)({ command }).required().number();
-            if (typeof data !== 'undefined') {
-                (0, Validate_1.default)({ data }).required().array('number');
-            }
-            if (typeof data === 'undefined') {
-                data = [];
-            }
-            const { commandResponse } = yield this.postMessage({
-                type: this.getMessage('send_one'),
-                ipAddress,
-                command,
-                data,
-            });
-            return commandResponse;
+    /**
+     * The `sendOne()` method sends an MDC command to another Tizen device on the same network or to the localhost.
+     *
+     * @param ipAddress The IP address of the device to send the command to.
+     * @param command The MDC command to send.
+     * @param data The optional data to send with the command.
+     *
+     * @since 6.5.1
+     *
+     * @example
+     * await sos.native.mdc.sendOne('localhost', CodesMDC.BRIGHTNESS_CONTROL); // Promise<IMDCResponse>
+     * await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.VOLUME_CONTROL, [50]); // Promise<IMDCResponse>
+     * await sos.native.mdc.sendOne('192.168.0.10', CodesMDC.PICTURE_CONTROL, [0x54, 0x03]); // Promise<IMDCResponse>
+     *
+     * // You can also send custom number if we don't have predefined command in our enum
+     * await sos.native.mdc.sendOne('192.168.0.10', 0x01, []); // Promise<IMDCResponse>
+     */
+    async sendOne(ipAddress, command, data) {
+        (0, Validate_1.default)({ ipAddress }).required().string();
+        (0, Validate_1.default)({ command }).required().number();
+        if (typeof data !== 'undefined') {
+            (0, Validate_1.default)({ data }).required().array('number');
+        }
+        if (typeof data === 'undefined') {
+            data = [];
+        }
+        const { commandResponse } = await this.postMessage({
+            type: this.getMessage('send_one'),
+            ipAddress,
+            command,
+            data,
         });
+        return commandResponse;
     }
-    sendOneRaw(ipAddress, data) {
-        return __awaiter(this, void 0, void 0, function* () {
-            (0, Validate_1.default)({ ipAddress }).required().string();
-            (0, Validate_1.default)({ data }).required().array('number');
-            const { commandResponse } = yield this.postMessage({
-                type: this.getMessage('send_one_raw'),
-                ipAddress,
-                data,
-            });
-            return commandResponse;
+    /**
+     * The `sendOneRaw()` method sends an MDC command to another Tizen device on the same network or to the localhost,
+     * but without explicitly specifying the command.
+     *
+     * @param ipAddress The IP address of the device to send the command to.
+     * @param data The data to send with the command.
+     *
+     * @since 6.5.1
+     *
+     * @example
+     * await sos.native.mdc.sendOneRaw('localhost', [0x1B, 0x00, 0x01, 0x74]); // Promise<IMDCResponse>
+     *
+     * // Example of returned object
+     * {
+     *     "type": "ACK", // or NACK
+     *     "commandType": 4,
+     *     "result": 0, // Value what command returned
+     * }
+     */
+    async sendOneRaw(ipAddress, data) {
+        (0, Validate_1.default)({ ipAddress }).required().string();
+        (0, Validate_1.default)({ data }).required().array('number');
+        const { commandResponse } = await this.postMessage({
+            type: this.getMessage('send_one_raw'),
+            ipAddress,
+            data,
         });
+        return commandResponse;
     }
     getMessage(name) {
         return this.getMessagePrefix() + '.' + name;
@@ -56,6 +98,5 @@ class Mdc {
         return this.messagePrefix + '.' + Mdc.MESSAGE_PREFIX;
     }
 }
-Mdc.MESSAGE_PREFIX = 'mdc';
 exports.default = Mdc;
 //# sourceMappingURL=Mdc.js.map

package/es6/FrontApplet/NativeCommands/MDC/Mdc.js.map

@@ -1 +1 @@
-{"version":3,"file":"Mdc.js","sourceRoot":"","sources":["../../../../src/FrontApplet/NativeCommands/MDC/Mdc.ts"],"names":[],"mappings":";;;;;;;;;;;AACA,sDAA+C;AAW/C;;GAEG;AACH,MAAqB,GAAG;IAGvB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAES,OAAO,CAAC,SAAwB,EAAE,OAAiB,EAAE,IAAoB;;YACrF,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;YAC5C,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;YAC1C,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;gBAChC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;aAC9C;YACD,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;gBAChC,IAAI,GAAG,EAAE,CAAC;aACV;YAED,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAClD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;gBACjC,SAAS;gBACT,OAAO;gBACP,IAAI;aACJ,CAAC,CAAC;YACH,OAAO,eAAe,CAAC;QACxB,CAAC;KAAA;IAEY,UAAU,CAAC,SAAwB,EAAE,IAAmB;;YACpE,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;YAC5C,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YAE9C,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;gBAClD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;gBACrC,SAAS;gBACT,IAAI;aACJ,CAAC,CAAC;YACH,OAAO,eAAe,CAAC;QACxB,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,GAAG,GAAG,GAAG,GAAG,CAAC,cAAc,CAAC;IACtD,CAAC;;AA5Ca,kBAAc,GAAW,KAAK,CAAC;kBADzB,GAAG"}
+{"version":3,"file":"Mdc.js","sourceRoot":"","sources":["../../../../src/FrontApplet/NativeCommands/MDC/Mdc.ts"],"names":[],"mappings":";;;;;AACA,uEAA+C;AAW/C;;;;;;;;;;;;;;GAcG;AACH,MAAqB,GAAG;IAKd;IACA;IALF,MAAM,CAAC,cAAc,GAAW,KAAK,CAAC;IAE7C,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,OAAO,CAAC,SAAwB,EAAE,OAAiB,EAAE,IAAe;QAChF,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC5C,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC1C,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE,CAAC;YACjC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC/C,CAAC;QACD,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE,CAAC;YACjC,IAAI,GAAG,EAAE,CAAC;QACX,CAAC;QAED,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAClD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YACjC,SAAS;YACT,OAAO;YACP,IAAI;SACJ,CAAC,CAAC;QACH,OAAO,eAAe,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,KAAK,CAAC,UAAU,CAAC,SAAwB,EAAE,IAAmB;QACpE,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC5C,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAE9C,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAClD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;YACrC,SAAS;YACT,IAAI;SACJ,CAAC,CAAC;QACH,OAAO,eAAe,CAAC;IACxB,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,GAAG,GAAG,GAAG,GAAG,CAAC,cAAc,CAAC;IACtD,CAAC;;AAlFF,sBAmFC"}

package/es6/FrontApplet/NativeCommands/NativeCommands.d.ts

@@ -1,10 +1,14 @@
 import IPostMessage from '../IPostMessage';
 import Mdc from './MDC/Mdc';
+/**
+ * The `sos.native` API groups together methods for controlling the device using native commands.
+ */
 export default class NativeCommands {
     private messagePrefix;
     private postMessage;
     static MESSAGE_PREFIX: string;
     readonly mdc: Mdc;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
     private getMessagePrefix;
 }

package/es6/FrontApplet/NativeCommands/NativeCommands.js

@@ -1,7 +1,18 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const Mdc_1 = require("./MDC/Mdc");
+const Mdc_1 = __importDefault(require("./MDC/Mdc"));
+/**
+ * The `sos.native` API groups together methods for controlling the device using native commands.
+ */
 class NativeCommands {
+    messagePrefix;
+    postMessage;
+    static MESSAGE_PREFIX = 'native_commands';
+    mdc;
+    /** @internal */
     constructor(messagePrefix, postMessage) {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
@@ -11,6 +22,5 @@ class NativeCommands {
         return this.messagePrefix + '.' + NativeCommands.MESSAGE_PREFIX;
     }
 }
-NativeCommands.MESSAGE_PREFIX = 'native_commands';
 exports.default = NativeCommands;
 //# sourceMappingURL=NativeCommands.js.map

package/es6/FrontApplet/NativeCommands/NativeCommands.js.map

@@ -1 +1 @@
-{"version":3,"file":"NativeCommands.js","sourceRoot":"","sources":["../../../src/FrontApplet/NativeCommands/NativeCommands.ts"],"names":[],"mappings":";;AACA,mCAA4B;AAE5B,MAAqB,cAAc;IAKlC,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;QAEtC,IAAI,CAAC,GAAG,GAAG,IAAI,aAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC/D,CAAC;IAEO,gBAAgB;QACvB,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,cAAc,CAAC,cAAc,CAAC;IACjE,CAAC;;AAba,6BAAc,GAAW,iBAAiB,CAAC;kBADrC,cAAc"}
+{"version":3,"file":"NativeCommands.js","sourceRoot":"","sources":["../../../src/FrontApplet/NativeCommands/NativeCommands.ts"],"names":[],"mappings":";;;;;AACA,oDAA4B;AAE5B;;GAEG;AACH,MAAqB,cAAc;IAOzB;IACA;IAPF,MAAM,CAAC,cAAc,GAAW,iBAAiB,CAAC;IAEzC,GAAG,CAAM;IAEzB,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;QAEtC,IAAI,CAAC,GAAG,GAAG,IAAI,aAAG,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IAC/D,CAAC;IAEO,gBAAgB;QACvB,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,cAAc,CAAC,cAAc,CAAC;IACjE,CAAC;;AAfF,iCAgBC"}

package/es6/FrontApplet/OSD/OSD.d.ts

@@ -1,10 +1,19 @@
 import IPostMessage from '../IPostMessage';
 import IOSD from './IOSD';
+/**
+ * The `sos.osd` API groups together methods for working with the OSD (On Screen Display).
+ */
 export default class OSD implements IOSD {
     private messagePrefix;
     private postMessage;
     static MESSAGE_PREFIX: string;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
+    /**
+     * The `showOSD()` method opens the OSD without typing the pin.
+     *
+     * @since 5.5.0
+     */
     showOSD(): Promise<void>;
     private getMessage;
 }

package/es6/FrontApplet/OSD/OSD.js

@@ -1,30 +1,30 @@
 "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.osd` API groups together methods for working with the OSD (On Screen Display).
+ */
 class OSD {
+    messagePrefix;
+    postMessage;
+    static MESSAGE_PREFIX = 'osd';
+    /** @internal */
     constructor(messagePrefix, postMessage) {
         this.messagePrefix = messagePrefix;
         this.postMessage = postMessage;
     }
-    showOSD() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.postMessage({
-                type: this.getMessage('show_osd'),
-            });
+    /**
+     * The `showOSD()` method opens the OSD without typing the pin.
+     *
+     * @since 5.5.0
+     */
+    async showOSD() {
+        await this.postMessage({
+            type: this.getMessage('show_osd'),
         });
     }
     getMessage(name) {
         return this.messagePrefix + '.' + OSD.MESSAGE_PREFIX + '.' + name;
     }
 }
-OSD.MESSAGE_PREFIX = 'osd';
 exports.default = OSD;
 //# sourceMappingURL=OSD.js.map

package/es6/FrontApplet/OSD/OSD.js.map

@@ -1 +1 @@
-{"version":3,"file":"OSD.js","sourceRoot":"","sources":["../../../src/FrontApplet/OSD/OSD.ts"],"names":[],"mappings":";;;;;;;;;;;AAGA,MAAqB,GAAG;IAGvB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAES,OAAO;;YACnB,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;aACjC,CAAC,CAAC;QACJ,CAAC;KAAA;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,GAAG,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACnE,CAAC;;AAfa,kBAAc,GAAW,KAAK,CAAC;kBADzB,GAAG"}
+{"version":3,"file":"OSD.js","sourceRoot":"","sources":["../../../src/FrontApplet/OSD/OSD.ts"],"names":[],"mappings":";;AAGA;;GAEG;AACH,MAAqB,GAAG;IAKd;IACA;IALF,MAAM,CAAC,cAAc,GAAW,KAAK,CAAC;IAE7C,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;OAIG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;SACjC,CAAC,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,GAAG,CAAC,cAAc,GAAG,GAAG,GAAG,IAAI,CAAC;IACnE,CAAC;;AAtBF,sBAuBC"}

package/es6/FrontApplet/Offline/Cache/Cache.d.ts

@@ -9,28 +9,117 @@ import IListedContentsMessage from './IListedContentsMessage';
 import IValidatedChecksumMessage from './IValidatedChecksumMessage';
 import IChecksumMessage from './IChecksumMessage';
 import IOfflineCache from './IOfflineCache';
+import { HashAlgorithm } from '../../FileSystem/HashAlgorithm';
+/**
+ * The `sos.offline` API groups together methods used to download and save arbitrary files, which can be accessed even if the device is offline.
+ *
+ * :::warning
+ *
+ * Emulator has certain limitations while handling offline files. [Read more here](https://docs.signageos.io/hc/en-us/articles/4405238997138)
+ *
+ * :::
+ */
 export default class Cache implements IOfflineCache {
     private messagePrefix;
     private postMessage;
     static MESSAGE_PREFIX: string;
     private savedFiles;
     private savedContents;
+    /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<ISavedFileMessage & ISavedContentMessage & ILoadedFileMessage & ILoadedContentMessage & IListedFilesMessage & IListedContentsMessage & IChecksumMessage & IValidatedChecksumMessage>);
+    /**
+     * The `listFiles()` method list all currently cached files.
+     *
+     * @since 2.0.0
+     */
     listFiles(): Promise<string[]>;
+    /**
+     * The `loadFile()` method loads cached file, which was previously saved by `saveFile()` or `loadOrSaveFile()` methods.
+     *
+     * @throws If the uid does not exists
+     *
+     * @since 1.0.3
+     */
     loadFile(uid: string): Promise<IFile>;
+    /**
+     * The `saveFile()` method downloads file from `uri` and saves it to the offline cache.
+     *
+     * :::warning
+     *
+     * `uid` should have the same file extension (e.g.: mp4, svg, jpg) as the original file.
+     *
+     * :::
+     *
+     * @throws If the network request fails or a file with the same uid is already cached
+     *
+     * @since 1.0.3
+     */
     saveFile(uid: string, uri: string, headers?: {
         [key: string]: string;
     }): Promise<void>;
+    /**
+     * The loadOrSaveFile() method loads the file from the cache, or downloads it if it's not already cached.
+     *
+     * @since 1.0.9
+     */
     loadOrSaveFile(uid: string, uri: string, headers?: {
         [key: string]: string;
     }): Promise<IFile>;
+    /**
+     * The `deleteFile()` method removes the file specified by `uid`.
+     *
+     * @since 2.0.0
+     *
+     * @throws If the uid does not exist.
+     */
     deleteFile(uid: string): Promise<void>;
+    /**
+     * The `listContent()` method lists all values saved by `saveContent()` method.
+     *
+     * @since 2.0.0
+     */
     listContents(): Promise<string[]>;
+    /**
+     * The `loadContent()` method gets the value specified by `uid`, which was previously saved by `saveContent()`.
+     *
+     * @since 1.0.3
+     */
     loadContent(uid: string): Promise<string>;
+    /**
+     * The `saveContent()` method saves a string value to the cache.
+     *
+     * @since 1.0.3
+     */
     saveContent(uid: string, content: string): Promise<void>;
+    /**
+     * The `deleteContent() method removes the value specified by `uid` key.
+     *
+     * @since 2.0.0
+     */
     deleteContent(uid: string): Promise<void>;
-    validateChecksumFile(uid: string, hash: string, hashType: string): Promise<boolean>;
-    getChecksumFile(uid: string, hashType: string): Promise<string>;
+    /**
+     * The `validateChecksumFile()` method validates whether the file, specified by `uid`, has the correct checksum.
+     *
+     * @throws If the uid does not exist or the hashing algorithm is not supported.
+     *
+     * @since 2.0.0
+     */
+    validateChecksumFile(uid: string, hash: string, hashType: HashAlgorithm): Promise<boolean>;
+    /**
+     * The `getChecksumFile()` computes a checksum of the file specified by `uid`.
+     *
+     * @throws If the uid does not exist or the hashing algorithm is not supported.
+     *
+     * @since 2.0.0
+     */
+    getChecksumFile(uid: string, hashType: HashAlgorithm): Promise<string>;
+    /**
+     * The `decompressFile()` decompresses the file specified by `uid` into a new file specified by `destinationUid`.
+     *
+     * @throws If the uid does not exist.
+     *
+     * @since 2.1.0
+     */
     decompressFile(uid: string, destinationUid: string, method: 'zip'): Promise<void>;
     private getCachedFile;
     private getMessage;