@signageos/front-applet 8.0.2 → 8.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/dist/bundle.js.map +1 -1
  2. package/docs/fpath/index.md +1 -1
  3. package/docs/sos/browser.md +27 -17
  4. package/docs/sos/command.md +21 -9
  5. package/docs/sos/debug.md +17 -0
  6. package/docs/sos/deviceInfo.md +26 -0
  7. package/docs/sos/display.md +17 -0
  8. package/docs/sos/fileSystem.md +47 -1
  9. package/docs/sos/hardware/index.md +36 -1
  10. package/docs/sos/hardware/led.md +11 -0
  11. package/docs/sos/index.md +14 -12
  12. package/docs/sos/input.md +13 -0
  13. package/docs/sos/monitors.md +16 -1
  14. package/docs/sos/native/mdc.md +0 -9
  15. package/docs/sos/offline/index.md +0 -14
  16. package/docs/sos/osd.md +15 -0
  17. package/docs/sos/proofOfPlay.md +14 -21
  18. package/docs/sos/sync.md +3 -17
  19. package/docs/sos_management/audio.md +14 -1
  20. package/docs/sos_management/firmware.md +26 -0
  21. package/docs/sos_management/index.md +1 -1
  22. package/docs/sos_management/network.md +3 -3
  23. package/docs/sos_management/package.md +7 -16
  24. package/docs/sos_management/power.md +49 -1
  25. package/docs/sos_management/proxy.md +25 -0
  26. package/docs/sos_management/remoteControl.md +36 -0
  27. package/docs/sos_management/screen.md +0 -18
  28. package/docs/sos_management/time.md +45 -5
  29. package/es6/FrontApplet/FrontApplet.d.ts +8 -2
  30. package/es6/FrontApplet/FrontApplet.js +8 -2
  31. package/es6/FrontApplet/FrontApplet.js.map +1 -1
  32. package/es6/FrontApplet/Management/Firmware/Firmware.d.ts +14 -0
  33. package/es6/FrontApplet/Management/Firmware/Firmware.js +8 -0
  34. package/es6/FrontApplet/Management/Firmware/Firmware.js.map +1 -1
  35. package/es6/FrontApplet/Management/Package/Package.d.ts +0 -8
  36. package/es6/FrontApplet/Management/Package/Package.js +0 -8
  37. package/es6/FrontApplet/Management/Package/Package.js.map +1 -1
  38. package/es6/FrontApplet/Management/Power/Power.d.ts +24 -0
  39. package/es6/FrontApplet/Management/Power/Power.js +25 -1
  40. package/es6/FrontApplet/Management/Power/Power.js.map +1 -1
  41. package/es6/FrontApplet/Management/Proxy/Proxy.d.ts +13 -0
  42. package/es6/FrontApplet/Management/Proxy/Proxy.js +13 -0
  43. package/es6/FrontApplet/Management/Proxy/Proxy.js.map +1 -1
  44. package/es6/FrontApplet/Management/RemoteControl/RemoteControl.d.ts +18 -0
  45. package/es6/FrontApplet/Management/RemoteControl/RemoteControl.js +18 -0
  46. package/es6/FrontApplet/Management/RemoteControl/RemoteControl.js.map +1 -1
  47. package/es6/FrontApplet/Management/Time/Time.d.ts +15 -3
  48. package/es6/FrontApplet/Management/Time/Time.js +9 -0
  49. package/es6/FrontApplet/Management/Time/Time.js.map +1 -1
  50. package/es6/FrontApplet/Monitors/Monitors.d.ts +1 -1
  51. package/es6/FrontApplet/Monitors/Monitors.js +1 -1
  52. package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.d.ts +0 -10
  53. package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.js +0 -10
  54. package/es6/FrontApplet/ProofOfPlay/ProofOfPlay.js.map +1 -1
  55. package/es6/fpath.d.ts +1 -1
  56. package/es6/fpath.js +1 -1
  57. package/package.json +1 -1
@@ -22,6 +22,9 @@ class Power {
22
22
  * The `systemReboot()` method initializes a system reboot.
23
23
  *
24
24
  * @since 3.0.0
25
+ *
26
+ * @example
27
+ * await sos.management.power.systemReboot();
25
28
  */
26
29
  async systemReboot() {
27
30
  await this.postMessage({
@@ -32,6 +35,9 @@ class Power {
32
35
  * The `appRestart()` method initializes a restart of the signageOS app.
33
36
  *
34
37
  * @since 3.0.0
38
+ *
39
+ * @example
40
+ * await sos.management.power.appRestart();
35
41
  */
36
42
  async appRestart() {
37
43
  await this.postMessage({
@@ -42,6 +48,9 @@ class Power {
42
48
  * The `getTimers()` method returns a list of currently set native timers.
43
49
  *
44
50
  * @since 4.0.0
51
+ *
52
+ * @example
53
+ * const timers = await sos.management.power.getTimers();
45
54
  */
46
55
  async getTimers() {
47
56
  const { timers } = await this.postMessage({
@@ -59,6 +68,9 @@ class Power {
59
68
  * @param volume The volume level set when the device is turned on.
60
69
  *
61
70
  * @since 3.0.0
71
+ *
72
+ * @example
73
+ * await sos.management.power.setTimer("TIMER_1", "08:00", "22:00", ["mon", "tue", "wed", "thu", "fri", "sat", "sun"], 30);
62
74
  */
63
75
  async setTimer(type, timeOn, timeOff, weekdays, volume) {
64
76
  if (typeof TimerHelper_1.TimerType[type] === 'undefined') {
@@ -98,6 +110,9 @@ class Power {
98
110
  * @param type The type of the timer (`TIMER_1`, ..., `TIMER_7`).
99
111
  *
100
112
  * @since 4.0.0
113
+ *
114
+ * @example
115
+ * await sos.management.power.unsetTimer("TIMER_2");
101
116
  */
102
117
  async unsetTimer(type) {
103
118
  if (typeof TimerHelper_1.TimerType[type] === 'undefined') {
@@ -110,6 +125,9 @@ class Power {
110
125
  * [proprietary timers](https://docs.signageos.io/hc/en-us/articles/4416384202642-Timers#h_01HCD14GEDP96AZV58NRSN2HNQ).
111
126
  *
112
127
  * @since 5.10.0
128
+ *
129
+ * @example
130
+ * const timers = await sos.management.power.getProprietaryTimers();
113
131
  */
114
132
  async getProprietaryTimers() {
115
133
  const { timers } = await this.postMessage({
@@ -128,6 +146,9 @@ class Power {
128
146
  * @param keepAppletRunning If `true`, the applet will be kept running when the timer is active on certain devices.
129
147
  *
130
148
  * @since 5.10.0
149
+ *
150
+ * @example
151
+ * await sos.management.power.setProprietaryTimer("TIMER_20", "08:00", "22:00", ["mon", "tue", "wed", "thu", "fri", "sat", "sun"], 30);
131
152
  */
132
153
  async setProprietaryTimer(type, timeOn, timeOff, weekdays, keepAppletRunning = false) {
133
154
  (0, Validate_1.default)({ type })
@@ -169,6 +190,9 @@ class Power {
169
190
  * @param type The type of the timer (`TIMER_1`, ..., `TIMER_7`).
170
191
  *
171
192
  * @since 5.10.0
193
+ *
194
+ * @example
195
+ * await sos.management.power.unsetProprietaryTimer("TIMER_2");
172
196
  */
173
197
  async unsetProprietaryTimer(type) {
174
198
  try {
@@ -179,7 +203,7 @@ class Power {
179
203
  }
180
204
  catch (error) {
181
205
  // Use failover method if delete fails that is supported in older front-display versions
182
- // It can be removed in some front-applet najor version
206
+ // It can be removed in some front-applet major version
183
207
  await this.setProprietaryTimer(type, null, null, []);
184
208
  }
185
209
  }
@@ -1 +1 @@
1
- {"version":3,"file":"Power.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Power/Power.ts"],"names":[],"mappings":";;;;;AACA,wDAAyE;AACzE,uEAA+C;AAI/C,mCAAmC;AACnC;;;GAGG;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,YAAY;QACxB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;SACtC,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,UAAU;QACtB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;SACpC,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS;QACrB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACzC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;SACnC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,QAAQ,CACpB,IAA4B,EAC5B,MAAqB,EACrB,OAAsB,EACtB,QAAkB,EAClB,MAAc;QAEd,IAAI,OAAO,uBAAS,CAAC,IAA8B,CAAC,KAAK,WAAW,EAAE,CAAC;YACtE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACvC,CAAC;QACD,IAAA,kBAAQ,EAAC,EAAE,MAAM,EAAE,CAAC;aAClB,SAAS,EAAE;aACX,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,mBAAmB,CAAC;aAChC,SAAS,EAAE,CAAC;QACd,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC;aACnB,SAAS,EAAE;aACX,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,mBAAmB,CAAC;aAChC,SAAS,EAAE,CAAC;QACd,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAA,kBAAQ,EAAC,EAAE,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACzD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAChC,IAAI,OAAO,0BAAY,CAAC,OAAoC,CAAC,KAAK,WAAW,EAAE,CAAC;gBAC/E,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;YAC1C,CAAC;QACF,CAAC;QAED,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YAClC,SAAS,EAAE,IAAI;YACf,MAAM;YACN,OAAO;YACP,QAAQ;YACR,MAAM;SACN,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CAAC,IAA4B;QACnD,IAAI,OAAO,uBAAS,CAAC,IAA8B,CAAC,KAAK,WAAW,EAAE,CAAC;YACtE,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACpC,CAAC;QACD,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,oBAAoB;QAChC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACzC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;SAC/C,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,mBAAmB,CAC/B,IAA0B,EAC1B,MAAqB,EACrB,OAAsB,EACtB,QAAkB,EAClB,oBAA6B,KAAK;QAElC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC;aAChB,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,aAAa,CAAC,CAAC;QAC7B,IAAA,kBAAQ,EAAC,EAAE,MAAM,EAAE,CAAC;aAClB,SAAS,EAAE;aACX,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,mBAAmB,CAAC;aAChC,SAAS,EAAE,CAAC;QACd,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC;aACnB,SAAS,EAAE;aACX,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,mBAAmB,CAAC;aAChC,SAAS,EAAE,CAAC;QACd,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAA,kBAAQ,EAAC,EAAE,iBAAiB,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC;QACrD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAChC,IAAI,OAAO,0BAAY,CAAC,OAAoC,CAAC,KAAK,WAAW,EAAE,CAAC;gBAC/E,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;YAC1C,CAAC;QACF,CAAC;QAED,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;YAC9C,SAAS,EAAE,IAAI;YACf,MAAM;YACN,OAAO;YACP,QAAQ;YACR,iBAAiB;SACjB,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,qBAAqB,CAAC,IAA0B;QAC5D,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,0BAA0B,CAAC;gBACjD,SAAS,EAAE,IAAI;aACf,CAAC,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,wFAAwF;YACxF,uDAAuD;YACvD,MAAM,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QACtD,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AApMD,wBAoMC"}
1
+ {"version":3,"file":"Power.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Power/Power.ts"],"names":[],"mappings":";;;;;AACA,wDAAyE;AACzE,uEAA+C;AAI/C,mCAAmC;AACnC;;;GAGG;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;;;;;;;OAOG;IACI,KAAK,CAAC,YAAY;QACxB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;SACtC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,UAAU;QACtB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC;SACpC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,SAAS;QACrB,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACzC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC;SACnC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;OAaG;IACI,KAAK,CAAC,QAAQ,CACpB,IAA4B,EAC5B,MAAqB,EACrB,OAAsB,EACtB,QAAkB,EAClB,MAAc;QAEd,IAAI,OAAO,uBAAS,CAAC,IAA8B,CAAC,KAAK,WAAW,EAAE,CAAC;YACtE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACvC,CAAC;QACD,IAAA,kBAAQ,EAAC,EAAE,MAAM,EAAE,CAAC;aAClB,SAAS,EAAE;aACX,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,mBAAmB,CAAC;aAChC,SAAS,EAAE,CAAC;QACd,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC;aACnB,SAAS,EAAE;aACX,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,mBAAmB,CAAC;aAChC,SAAS,EAAE,CAAC;QACd,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAA,kBAAQ,EAAC,EAAE,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACzD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAChC,IAAI,OAAO,0BAAY,CAAC,OAAoC,CAAC,KAAK,WAAW,EAAE,CAAC;gBAC/E,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;YAC1C,CAAC;QACF,CAAC;QAED,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;YAClC,SAAS,EAAE,IAAI;YACf,MAAM;YACN,OAAO;YACP,QAAQ;YACR,MAAM;SACN,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,UAAU,CAAC,IAA4B;QACnD,IAAI,OAAO,uBAAS,CAAC,IAA8B,CAAC,KAAK,WAAW,EAAE,CAAC;YACtE,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACpC,CAAC;QACD,MAAM,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IAC9C,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,oBAAoB;QAChC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACzC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;SAC/C,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,KAAK,CAAC,mBAAmB,CAC/B,IAA0B,EAC1B,MAAqB,EACrB,OAAsB,EACtB,QAAkB,EAClB,oBAA6B,KAAK;QAElC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC;aAChB,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,aAAa,CAAC,CAAC;QAC7B,IAAA,kBAAQ,EAAC,EAAE,MAAM,EAAE,CAAC;aAClB,SAAS,EAAE;aACX,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,mBAAmB,CAAC;aAChC,SAAS,EAAE,CAAC;QACd,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC;aACnB,SAAS,EAAE;aACX,QAAQ,EAAE;aACV,MAAM,EAAE;aACR,WAAW,CAAC,mBAAmB,CAAC;aAChC,SAAS,EAAE,CAAC;QACd,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAClD,IAAA,kBAAQ,EAAC,EAAE,iBAAiB,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC;QACrD,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAChC,IAAI,OAAO,0BAAY,CAAC,OAAoC,CAAC,KAAK,WAAW,EAAE,CAAC;gBAC/E,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;YAC1C,CAAC;QACF,CAAC;QAED,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC;YAC9C,SAAS,EAAE,IAAI;YACf,MAAM;YACN,OAAO;YACP,QAAQ;YACR,iBAAiB;SACjB,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,qBAAqB,CAAC,IAA0B;QAC5D,IAAI,CAAC;YACJ,MAAM,IAAI,CAAC,WAAW,CAAC;gBACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,0BAA0B,CAAC;gBACjD,SAAS,EAAE,IAAI;aACf,CAAC,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,wFAAwF;YACxF,uDAAuD;YACvD,MAAM,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;QACtD,CAAC;IACF,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AA5ND,wBA4NC"}
@@ -9,24 +9,37 @@ export default class Proxy implements IProxy {
9
9
  * The `isEnabled()` method returns whether the proxy is enabled on the device.
10
10
  *
11
11
  * @since 5.4.0
12
+ *
13
+ * @example
14
+ * const enabled = await sos.management.proxy.isEnabled();
12
15
  */
13
16
  isEnabled(): Promise<boolean>;
14
17
  /**
15
18
  * The `setManual()` method sets the proxy on the device.
16
19
  *
17
20
  * @since 5.4.0
21
+ *
22
+ * @example
23
+ * const enabled = await sos.management.proxy.setManual('178.62.193.192', 1080, 'username', 'password');
18
24
  */
19
25
  setManual(uri: string, port: number, username?: string, password?: string): Promise<void>;
20
26
  /**
21
27
  * The `disable()` method disables the proxy on the device.
22
28
  *
23
29
  * @since 5.4.0
30
+ *
31
+ * @example
32
+ * await sos.management.proxy.disable();
24
33
  */
25
34
  disable(): Promise<void>;
26
35
  /**
27
36
  * The `getConnectedTo()` methods returns the current connected proxy server uri on the device.
28
37
  *
29
38
  * @since 5.4.0
39
+ *
40
+ * @example
41
+ * const uri = await sos.management.proxy.getConnectedTo();
42
+ * console.log(uri); // 178.62.193.192
30
43
  */
31
44
  getConnectedTo(): Promise<string>;
32
45
  private getMessage;
@@ -12,6 +12,9 @@ class Proxy {
12
12
  * The `isEnabled()` method returns whether the proxy is enabled on the device.
13
13
  *
14
14
  * @since 5.4.0
15
+ *
16
+ * @example
17
+ * const enabled = await sos.management.proxy.isEnabled();
15
18
  */
16
19
  async isEnabled() {
17
20
  const { isEnabled } = await this.postMessage({
@@ -23,6 +26,9 @@ class Proxy {
23
26
  * The `setManual()` method sets the proxy on the device.
24
27
  *
25
28
  * @since 5.4.0
29
+ *
30
+ * @example
31
+ * const enabled = await sos.management.proxy.setManual('178.62.193.192', 1080, 'username', 'password');
26
32
  */
27
33
  async setManual(uri, port, username, password) {
28
34
  await this.postMessage({
@@ -37,6 +43,9 @@ class Proxy {
37
43
  * The `disable()` method disables the proxy on the device.
38
44
  *
39
45
  * @since 5.4.0
46
+ *
47
+ * @example
48
+ * await sos.management.proxy.disable();
40
49
  */
41
50
  async disable() {
42
51
  await this.postMessage({
@@ -47,6 +56,10 @@ class Proxy {
47
56
  * The `getConnectedTo()` methods returns the current connected proxy server uri on the device.
48
57
  *
49
58
  * @since 5.4.0
59
+ *
60
+ * @example
61
+ * const uri = await sos.management.proxy.getConnectedTo();
62
+ * console.log(uri); // 178.62.193.192
50
63
  */
51
64
  async getConnectedTo() {
52
65
  const { connectedTo } = await this.postMessage({
@@ -1 +1 @@
1
- {"version":3,"file":"Proxy.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Proxy/Proxy.ts"],"names":[],"mappings":";;AAGA,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,SAAS;QACrB,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC5C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;SACzC,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CAAC,GAAW,EAAE,IAAY,EAAE,QAAiB,EAAE,QAAiB;QACrF,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;YACzC,GAAG;YACH,IAAI;YACJ,QAAQ;YACR,QAAQ;SACR,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;SACtC,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc;QAC1B,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC9C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;SAC/C,CAAC,CAAC;QACH,OAAO,WAAW,CAAC;IACpB,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AA7DD,wBA6DC"}
1
+ {"version":3,"file":"Proxy.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Proxy/Proxy.ts"],"names":[],"mappings":";;AAGA,MAAqB,KAAK;IAGhB;IACA;IAHT,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;;;;OAOG;IACI,KAAK,CAAC,SAAS;QACrB,MAAM,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC5C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;SACzC,CAAC,CAAC;QAEH,OAAO,SAAS,CAAC;IAClB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,SAAS,CAAC,GAAW,EAAE,IAAY,EAAE,QAAiB,EAAE,QAAiB;QACrF,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kBAAkB,CAAC;YACzC,GAAG;YACH,IAAI;YACJ,QAAQ;YACR,QAAQ;SACR,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;SACtC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,cAAc;QAC1B,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC9C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,wBAAwB,CAAC;SAC/C,CAAC,CAAC;QACH,OAAO,WAAW,CAAC;IACpB,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AA1ED,wBA0EC"}
@@ -21,36 +21,54 @@ export default class RemoteControl implements IRemoteControl {
21
21
  * :::
22
22
  *
23
23
  * @since 3.0.0
24
+ *
25
+ * @example
26
+ * await sos.management.remoteControl.enable();
24
27
  */
25
28
  enable(): Promise<void>;
26
29
  /**
27
30
  * The `disable()` method disables remote control.
28
31
  *
29
32
  * @since 3.0.0
33
+ *
34
+ * @example
35
+ * await sos.management.remoteControl.disable();
30
36
  */
31
37
  disable(): Promise<void>;
32
38
  /**
33
39
  * The `isEnabled()` method returns whether the remote control is enabled.
34
40
  *
35
41
  * @since 4.0.0
42
+ *
43
+ * @example
44
+ * const enabled = await sos.management.remoteControl.isEnabled();
36
45
  */
37
46
  isEnabled(): Promise<boolean>;
38
47
  /**
39
48
  * The `lock()` method is an alias for the `disable()` method.
40
49
  *
41
50
  * @since 4.0.0
51
+ *
52
+ * @example
53
+ * await sos.management.remoteControl.lock();
42
54
  */
43
55
  lock(): Promise<void>;
44
56
  /**
45
57
  * The `unlock()` method is an alias for the `enable()` method.
46
58
  *
47
59
  * @since 4.0.0
60
+ *
61
+ * @example
62
+ * await sos.management.remoteControl.unlock();
48
63
  */
49
64
  unlock(): Promise<void>;
50
65
  /**
51
66
  * The `isLocked()` method returns whether the remote control is locked (disabled).
52
67
  *
53
68
  * @since 4.0.0
69
+ *
70
+ * @example
71
+ * const locked = await sos.management.remoteControl.isLocked();
54
72
  */
55
73
  isLocked(): Promise<boolean>;
56
74
  private setEnabled;
@@ -24,6 +24,9 @@ class RemoteControl {
24
24
  * :::
25
25
  *
26
26
  * @since 3.0.0
27
+ *
28
+ * @example
29
+ * await sos.management.remoteControl.enable();
27
30
  */
28
31
  async enable() {
29
32
  await this.setEnabled(true);
@@ -32,6 +35,9 @@ class RemoteControl {
32
35
  * The `disable()` method disables remote control.
33
36
  *
34
37
  * @since 3.0.0
38
+ *
39
+ * @example
40
+ * await sos.management.remoteControl.disable();
35
41
  */
36
42
  async disable() {
37
43
  await this.setEnabled(false);
@@ -40,6 +46,9 @@ class RemoteControl {
40
46
  * The `isEnabled()` method returns whether the remote control is enabled.
41
47
  *
42
48
  * @since 4.0.0
49
+ *
50
+ * @example
51
+ * const enabled = await sos.management.remoteControl.isEnabled();
43
52
  */
44
53
  async isEnabled() {
45
54
  const { isRemoteControlEnabled } = await this.postMessage({
@@ -51,6 +60,9 @@ class RemoteControl {
51
60
  * The `lock()` method is an alias for the `disable()` method.
52
61
  *
53
62
  * @since 4.0.0
63
+ *
64
+ * @example
65
+ * await sos.management.remoteControl.lock();
54
66
  */
55
67
  async lock() {
56
68
  await this.disable();
@@ -59,6 +71,9 @@ class RemoteControl {
59
71
  * The `unlock()` method is an alias for the `enable()` method.
60
72
  *
61
73
  * @since 4.0.0
74
+ *
75
+ * @example
76
+ * await sos.management.remoteControl.unlock();
62
77
  */
63
78
  async unlock() {
64
79
  await this.enable();
@@ -67,6 +82,9 @@ class RemoteControl {
67
82
  * The `isLocked()` method returns whether the remote control is locked (disabled).
68
83
  *
69
84
  * @since 4.0.0
85
+ *
86
+ * @example
87
+ * const locked = await sos.management.remoteControl.isLocked();
70
88
  */
71
89
  async isLocked() {
72
90
  return !(await this.isEnabled());
@@ -1 +1 @@
1
- {"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"}
1
+ {"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;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,MAAM;QAClB,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,OAAO;QACnB,MAAM,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAC9B,CAAC;IAED;;;;;;;OAOG;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;;;;;;;OAOG;IACI,KAAK,CAAC,IAAI;QAChB,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;IACtB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,MAAM;QAClB,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;IACrB,CAAC;IAED;;;;;;;OAOG;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;AAtGD,gCAsGC"}
@@ -19,11 +19,14 @@ export default class Time implements ITime {
19
19
  /** @deprecated Use `setManual(dateTime, timezone)` instead. */
20
20
  setManual(currentDate: Date, timezone: string): Promise<void>;
21
21
  /**
22
- * The `setManual()` method sets the system time and the system timezone.
22
+ * The `setManual()` method sets the system time and the system timezone and disables NTP server settings.
23
23
  *
24
- * :::warning
24
+ * :::warning Setting NTP server and timezone has side effects
25
25
  *
26
- * This method will disable NTP server settings.
26
+ * - **Tizen**: After calling this API, display Reboots!
27
+ * Tizen has limited set of available timezones. Read more here.
28
+ * - **RaspberryPi**: After calling this API, RPi Reboots backend server which can take up to 60 seconds! During the reboot no JS API is
29
+ * available. **Always wait for Promise resolution.**
27
30
  *
28
31
  * :::
29
32
  *
@@ -36,6 +39,15 @@ export default class Time implements ITime {
36
39
  /**
37
40
  * The `setNTP()` method sets the NTP server and the system timezone.
38
41
  *
42
+ * :::warning Setting NTP server and timezone has side effects
43
+ *
44
+ * - **Tizen / WebOS**: After calling this API, display Reboots!
45
+ * Tizen has limited set of available timezones. Read more here.
46
+ * - **RaspberryPi**: After calling this API, RPi Reboots backend server which can take up to 60 seconds! During the reboot no JS API is
47
+ * available. **Always wait for Promise resolution.**
48
+ *
49
+ * :::
50
+ *
39
51
  * @param ntpServer The NTP server to set.
40
52
  * @param timezone The timezone to set.
41
53
  *
@@ -51,6 +51,15 @@ class Time {
51
51
  /**
52
52
  * The `setNTP()` method sets the NTP server and the system timezone.
53
53
  *
54
+ * :::warning Setting NTP server and timezone has side effects
55
+ *
56
+ * - **Tizen / WebOS**: After calling this API, display Reboots!
57
+ * Tizen has limited set of available timezones. Read more here.
58
+ * - **RaspberryPi**: After calling this API, RPi Reboots backend server which can take up to 60 seconds! During the reboot no JS API is
59
+ * available. **Always wait for Promise resolution.**
60
+ *
61
+ * :::
62
+ *
54
63
  * @param ntpServer The NTP server to set.
55
64
  * @param timezone The timezone to set.
56
65
  *
@@ -1 +1 @@
1
- {"version":3,"file":"Time.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Time/Time.ts"],"names":[],"mappings":";;;;;AACA,uEAA+C;AAC/C,mCAA+D;AAE/D,+IAA+I;AAC/I;;GAEG;AACH,MAAqB,IAAI;IAGf;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,GAAG;QACf,MAAM,EAAE,uBAAuB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC1D,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC;SACvD,CAAC,CAAC;QAEH,OAAO,uBAAuB,CAAC;IAChC,CAAC;IAED,+DAA+D;IACxD,GAAG,CAAC,WAAiB,EAAE,QAAgB;QAC7C,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAsBD,gBAAgB;IACT,KAAK,CAAC,SAAS,CAAC,GAAG,IAA+B;QACxD,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC;QAErC,IAAI,WAAW,YAAY,IAAI,EAAE,CAAC;YACjC,IAAA,kBAAQ,EAAC,EAAE,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;QAC7C,CAAC;aAAM,CAAC;YACP,IAAA,kBAAQ,EAAC,EAAE,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,iBAAS,CAAC,CAAC;QACxD,CAAC;QACD,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAE3C,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC;YACvD,WAAW;YACX,QAAQ;SACR,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,QAAgB;QACtD,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC5C,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC3C,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;YACnD,SAAS;YACT,QAAQ;SACR,CAAC,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AApFD,uBAoFC"}
1
+ {"version":3,"file":"Time.js","sourceRoot":"","sources":["../../../../src/FrontApplet/Management/Time/Time.ts"],"names":[],"mappings":";;;;;AACA,uEAA+C;AAC/C,mCAA+D;AAE/D,+IAA+I;AAC/I;;GAEG;AACH,MAAqB,IAAI;IAGf;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,GAAG;QACf,MAAM,EAAE,uBAAuB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC1D,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC;SACvD,CAAC,CAAC;QAEH,OAAO,uBAAuB,CAAC;IAChC,CAAC;IAED,+DAA+D;IACxD,GAAG,CAAC,WAAiB,EAAE,QAAgB;QAC7C,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IAC9C,CAAC;IAwBD,gBAAgB;IACT,KAAK,CAAC,SAAS,CAAC,GAAG,IAA+B;QACxD,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC;QAErC,IAAI,WAAW,YAAY,IAAI,EAAE,CAAC;YACjC,IAAA,kBAAQ,EAAC,EAAE,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;QAC7C,CAAC;aAAM,CAAC;YACP,IAAA,kBAAQ,EAAC,EAAE,WAAW,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,iBAAS,CAAC,CAAC;QACxD,CAAC;QACD,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAE3C,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,gCAAgC,CAAC;YACvD,WAAW;YACX,QAAQ;SACR,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,MAAM,CAAC,SAAiB,EAAE,QAAgB;QACtD,IAAA,kBAAQ,EAAC,EAAE,SAAS,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC5C,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAC3C,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;YACnD,SAAS;YACT,QAAQ;SACR,CAAC,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,IAAI,CAAC,aAAa,GAAG,GAAG,GAAG,IAAI,CAAC;IACxC,CAAC;CACD;AA/FD,uBA+FC"}
@@ -1,7 +1,7 @@
1
1
  import IPostMessage from '../IPostMessage';
2
2
  import IMonitor, { IConnectedMonitor } from './IMonitor';
3
3
  /**
4
- * The `sos.management.monitors` API groups together methods for providing information about monitors connected to the device.
4
+ * The `sos.monitors` API groups together methods for providing information about monitors connected to the device.
5
5
  */
6
6
  declare class Monitors implements IMonitor {
7
7
  private messagePrefix;
@@ -1,7 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  /**
4
- * The `sos.management.monitors` API groups together methods for providing information about monitors connected to the device.
4
+ * The `sos.monitors` API groups together methods for providing information about monitors connected to the device.
5
5
  */
6
6
  class Monitors {
7
7
  messagePrefix;
@@ -11,16 +11,6 @@ export default class ProofOfPlay implements IProofOfPlay {
11
11
  *
12
12
  * @since 5.5.1
13
13
  *
14
- * @example
15
- * await sos.proofOfPlay.recordItemPlayed({
16
- * name: 'generic-brand-christmas-coffee-ad',
17
- * customId: 'dBE43bFB3312VFfvd34bgGHJVV334cd2',
18
- * type: 'video',
19
- * tags: ['generic-brand', 'christmas'],
20
- * fileName: 'coffee.mp4',
21
- * playbackSuccess: false,
22
- * errorMessage: 'Unsupported framerate 60fps',
23
- * });
24
14
  */
25
15
  recordItemPlayed(options: IRecordItemOptions): Promise<void>;
26
16
  }
@@ -17,16 +17,6 @@ class ProofOfPlay {
17
17
  *
18
18
  * @since 5.5.1
19
19
  *
20
- * @example
21
- * await sos.proofOfPlay.recordItemPlayed({
22
- * name: 'generic-brand-christmas-coffee-ad',
23
- * customId: 'dBE43bFB3312VFfvd34bgGHJVV334cd2',
24
- * type: 'video',
25
- * tags: ['generic-brand', 'christmas'],
26
- * fileName: 'coffee.mp4',
27
- * playbackSuccess: false,
28
- * errorMessage: 'Unsupported framerate 60fps',
29
- * });
30
20
  */
31
21
  async recordItemPlayed(options) {
32
22
  const { name, customId, type, tags, fileName, playbackSuccess, errorMessage } = options;
@@ -1 +1 @@
1
- {"version":3,"file":"ProofOfPlay.js","sourceRoot":"","sources":["../../../src/FrontApplet/ProofOfPlay/ProofOfPlay.ts"],"names":[],"mappings":";;;;;AAEA,oEAA4C;AAC5C,wEAAgD;AAGhD,MAAqB,WAAW;IAEX;IADpB,gBAAgB;IAChB,YAAoB,UAAsB;QAAtB,eAAU,GAAV,UAAU,CAAY;IAAG,CAAC;IAE9C;;;;;;;;;;;;;;;;OAgBG;IACI,KAAK,CAAC,gBAAgB,CAAC,OAA2B;QACxD,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;QACxF,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QACvC,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QAChC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;QAChE,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACnC,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QAChC,IAAA,kBAAQ,EAAC,EAAE,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;QACxC,IAAA,kBAAQ,EAAC,EAAE,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QAEpC,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;YAC9B,IAAI,EAAE,yBAAe,CAAC,UAAU;YAChC,QAAQ,EAAE,IAAI;YACd,QAAQ;YACR,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,IAAI;YACd,QAAQ;YACR,eAAe;YACf,YAAY;SACZ,CAAC,CAAC;IACJ,CAAC;CACD;AA1CD,8BA0CC"}
1
+ {"version":3,"file":"ProofOfPlay.js","sourceRoot":"","sources":["../../../src/FrontApplet/ProofOfPlay/ProofOfPlay.ts"],"names":[],"mappings":";;;;;AAEA,oEAA4C;AAC5C,wEAAgD;AAGhD,MAAqB,WAAW;IAEX;IADpB,gBAAgB;IAChB,YAAoB,UAAsB;QAAtB,eAAU,GAAV,UAAU,CAAY;IAAG,CAAC;IAE9C;;;;;;OAMG;IACI,KAAK,CAAC,gBAAgB,CAAC,OAA2B;QACxD,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,eAAe,EAAE,YAAY,EAAE,GAAG,OAAO,CAAC;QACxF,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QACvC,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QAChC,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;QAChE,IAAA,kBAAQ,EAAC,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACnC,IAAA,kBAAQ,EAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QAChC,IAAA,kBAAQ,EAAC,EAAE,eAAe,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;QACxC,IAAA,kBAAQ,EAAC,EAAE,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;QAEpC,MAAM,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;YAC9B,IAAI,EAAE,yBAAe,CAAC,UAAU;YAChC,QAAQ,EAAE,IAAI;YACd,QAAQ;YACR,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,IAAI;YACd,QAAQ;YACR,eAAe;YACf,YAAY;SACZ,CAAC,CAAC;IACJ,CAAC;CACD;AAhCD,8BAgCC"}
package/es6/fpath.d.ts CHANGED
@@ -3,7 +3,7 @@ import { IFilePath } from './FrontApplet/FileSystem/types';
3
3
  /**
4
4
  * fpath utility mirrors node [path](https://nodejs.org/docs/latest/api/path.html)
5
5
  * module, but accepts IFilePath type instead of strings. It is useful when
6
- * working with [sos.filesystem](/sdk/sos/fileSystem).
6
+ * working with [sos.fileSystem](/sdk/sos/fileSystem).
7
7
  *
8
8
  * Not implemented functions:
9
9
  * - format
package/es6/fpath.js CHANGED
@@ -38,7 +38,7 @@ const path = __importStar(require("path-browserify"));
38
38
  /**
39
39
  * fpath utility mirrors node [path](https://nodejs.org/docs/latest/api/path.html)
40
40
  * module, but accepts IFilePath type instead of strings. It is useful when
41
- * working with [sos.filesystem](/sdk/sos/fileSystem).
41
+ * working with [sos.fileSystem](/sdk/sos/fileSystem).
42
42
  *
43
43
  * Not implemented functions:
44
44
  * - format
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@signageos/front-applet",
3
- "version": "8.0.2",
3
+ "version": "8.0.3",
4
4
  "main": "dist/bundle.js",
5
5
  "types": "es6/bundle.d.ts",
6
6
  "files": [