@signageos/front-applet 8.1.3 → 8.1.4

package/docs/sos_management/audio.md

@@ -28,9 +28,9 @@ setVolume(volume: number): Promise<void>;
 
 #### Params
 
-| Name     | Type     | Description              |
-|----------|----------|--------------------------|
-| `volume` | `number` | Value between 0 and 100. |
+| Name     | Type     | Required         | Description              |
+|----------|----------|------------------|--------------------------|
+| `volume` | `number` |  <div>Yes</div>  | Value between 0 and 100. |
 
 ## API Example
 

package/docs/sos_management/firmware.md

@@ -54,10 +54,10 @@ upgrade(baseUrl: string, version: string): Promise<void>;
 
 #### Params
 
-| Name      | Type     | Description                                      |
-|-----------|----------|--------------------------------------------------|
-| `baseUrl` | `string` | The server URL where firmware files are located. |
-| `version` | `string` | The version of the firmware being installed.     |
+| Name      | Type     | Required         | Description                                      |
+|-----------|----------|------------------|--------------------------------------------------|
+| `baseUrl` | `string` |  <div>Yes</div>  | The server URL where firmware files are located. |
+| `version` | `string` |  <div>Yes</div>  | The version of the firmware being installed.     |
 
 #### Example
 
@@ -86,9 +86,9 @@ upgrade(fwUri: string): Promise<void>;
 
 #### Params
 
-| Name    | Type     | Description                                      |
-|---------|----------|--------------------------------------------------|
-| `fwUri` | `string` | FQN uri where the firmware main file is located. |
+| Name    | Type     | Required         | Description                                      |
+|---------|----------|------------------|--------------------------------------------------|
+| `fwUri` | `string` |  <div>Yes</div>  | FQN uri where the firmware main file is located. |
 
 #### Example
 
@@ -110,7 +110,7 @@ upgrade(version: string, baseUrl?: string): Promise<void>;
 
 #### Params
 
-| Name                   | Type     | Description                                                                                           |
-|------------------------|----------|-------------------------------------------------------------------------------------------------------|
-| `version`              | `string` | The version of the firmware being installed.                                                          |
-| `baseUrl` *(optional)* | `string` | Optional server URL where firmware files are located.<br/>(Default value: `"https://2.signageos.io"`) |
+| Name      | Type     | Required         | Description                                                                                           |
+|-----------|----------|------------------|-------------------------------------------------------------------------------------------------------|
+| `version` | `string` |  <div>Yes</div>  | The version of the firmware being installed.                                                          |
+| `baseUrl` | `string` |  <div>No</div>   | Optional server URL where firmware files are located.<br/>(Default value: `"https://2.signageos.io"`) |

package/docs/sos_management/index.md

@@ -136,9 +136,9 @@ setExtendedManagementUrl(url: string | null): Promise<void>;
 
 #### Params
 
-| Name  | Type             | Description                |
-|-------|------------------|----------------------------|
-| `url` | `string \| null` | The management URL to set. |
+| Name  | Type             | Required         | Description                |
+|-------|------------------|------------------|----------------------------|
+| `url` | `string \| null` |  <div>Yes</div>  | The management URL to set. |
 
 <Separator />
 
@@ -152,9 +152,9 @@ setHardwareAcceleration(enabled: boolean): Promise<void>;
 
 #### Params
 
-| Name      | Type      | Description                                      |
-|-----------|-----------|--------------------------------------------------|
-| `enabled` | `boolean` | Whether hardware acceleration should be enabled. |
+| Name      | Type      | Required         | Description                                      |
+|-----------|-----------|------------------|--------------------------------------------------|
+| `enabled` | `boolean` |  <div>Yes</div>  | Whether hardware acceleration should be enabled. |
 
 <Separator />
 
@@ -173,9 +173,9 @@ type AnyString = string & {};
 
 #### Params
 
-| Name         | Type                   | Description                          |
-|--------------|------------------------|--------------------------------------|
-| `capability` | `ManagementCapability` | The capability to check for support. |
+| Name         | Type                   | Required         | Description                          |
+|--------------|------------------------|------------------|--------------------------------------|
+| `capability` | `ManagementCapability` |  <div>Yes</div>  | The capability to check for support. |
 
 <Separator />
 

package/docs/sos_management/network.md

@@ -30,9 +30,9 @@ disableInterface(interfaceName: string): Promise<void>;
 
 #### Params
 
-| Name            | Type     | Description                                                                                        |
-|-----------------|----------|----------------------------------------------------------------------------------------------------|
-| `interfaceName` | `string` | The interface name which can be retrieved from the list of interfaces returned by listInterfaces() |
+| Name            | Type     | Required         | Description                                                                                        |
+|-----------------|----------|------------------|----------------------------------------------------------------------------------------------------|
+| `interfaceName` | `string` |  <div>Yes</div>  | The interface name which can be retrieved from the list of interfaces returned by listInterfaces() |
 
 <Separator />
 
@@ -85,9 +85,9 @@ setDHCP(interfaceName: string): Promise<void>;
 
 #### Params
 
-| Name            | Type     | Description                                                                                        |
-|-----------------|----------|----------------------------------------------------------------------------------------------------|
-| `interfaceName` | `string` | The interface name which can be retrieved from the list of interfaces returned by listInterfaces() |
+| Name            | Type     | Required         | Description                                                                                        |
+|-----------------|----------|------------------|----------------------------------------------------------------------------------------------------|
+| `interfaceName` | `string` |  <div>Yes</div>  | The interface name which can be retrieved from the list of interfaces returned by listInterfaces() |
 
 <Separator />
 
@@ -115,10 +115,10 @@ interface INetworkOptions {
 
 #### Params
 
-| Name            | Type              | Description                                                                                        |
-|-----------------|-------------------|----------------------------------------------------------------------------------------------------|
-| `interfaceName` | `string`          | The interface name which can be retrieved from the list of interfaces returned by listInterfaces() |
-| `options`       | `INetworkOptions` | The network configuration options.                                                                 |
+| Name            | Type              | Required         | Description                                                                                        |
+|-----------------|-------------------|------------------|----------------------------------------------------------------------------------------------------|
+| `interfaceName` | `string`          |  <div>Yes</div>  | The interface name which can be retrieved from the list of interfaces returned by listInterfaces() |
+| `options`       | `INetworkOptions` |  <div>Yes</div>  | The network configuration options.                                                                 |
 
 <Separator />
 

package/docs/sos_management/package.md

@@ -18,12 +18,12 @@ install(baseUrl: string, packageName: string, version: string, build: string | n
 
 #### Params
 
-| Name          | Type             | Description                        |
-|---------------|------------------|------------------------------------|
-| `baseUrl`     | `string`         | URL where the package is available |
-| `packageName` | `string`         | Name of the android package        |
-| `version`     | `string`         | Package version                    |
-| `build`       | `string \| null` | If relevant for your device        |
+| Name          | Type             | Required         | Description                        |
+|---------------|------------------|------------------|------------------------------------|
+| `baseUrl`     | `string`         |  <div>Yes</div>  | URL where the package is available |
+| `packageName` | `string`         |  <div>Yes</div>  | Name of the android package        |
+| `version`     | `string`         |  <div>Yes</div>  | Package version                    |
+| `build`       | `string \| null` |  <div>Yes</div>  | If relevant for your device        |
 
 ## API Example
 

package/docs/sos_management/power.md

@@ -128,9 +128,9 @@ removeScheduledReboot(id: string): Promise<void>;
 
 #### Params
 
-| Name | Type     | Description                     |
-|------|----------|---------------------------------|
-| `id` | `string` | - ID of the rule to be removed. |
+| Name | Type     | Required         | Description                     |
+|------|----------|------------------|---------------------------------|
+| `id` | `string` |  <div>Yes</div>  | - ID of the rule to be removed. |
 
 #### Example
 
@@ -155,13 +155,13 @@ setProprietaryTimer(type: ProprietaryTimerType, timeOn: string | null, timeOff:
 
 #### Params
 
-| Name                             | Type                | Description                                                                             |
-|----------------------------------|---------------------|-----------------------------------------------------------------------------------------|
-| `type`                           | ``TIMER_${number}`` | The type of the timer (`TIMER_1`, ..., `TIMER_7`).                                      |
-| `timeOn`                         | `string \| null`    | The time when the device should turn on.                                                |
-| `timeOff`                        | `string \| null`    | The time when the device should turn off.                                               |
-| `weekdays`                       | `string[]`          | The days of the week when the timer should be active (`mon`, ..., `sun`).               |
-| `keepAppletRunning` *(optional)* | `boolean`           | If `true`, the applet will be kept running when the timer is active on certain devices. |
+| Name                | Type                | Required         | Description                                                                             |
+|---------------------|---------------------|------------------|-----------------------------------------------------------------------------------------|
+| `type`              | ``TIMER_${number}`` |  <div>Yes</div>  | The type of the timer (`TIMER_1`, ..., `TIMER_7`).                                      |
+| `timeOn`            | `string \| null`    |  <div>Yes</div>  | The time when the device should turn on.                                                |
+| `timeOff`           | `string \| null`    |  <div>Yes</div>  | The time when the device should turn off.                                               |
+| `weekdays`          | `string[]`          |  <div>Yes</div>  | The days of the week when the timer should be active (`mon`, ..., `sun`).               |
+| `keepAppletRunning` | `boolean`           |  <div>No</div>   | If `true`, the applet will be kept running when the timer is active on certain devices. |
 
 #### Example
 
@@ -190,10 +190,10 @@ type WeekdayType = 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' |
 
 #### Params
 
-| Name       | Type            | Description                                                      |
-|------------|-----------------|------------------------------------------------------------------|
-| `weekdays` | `WeekdayType[]` |                                                                  |
-| `time`     | `string`        | - Time when the reboot should be executed. Format is `HH:mm:ss`. |
+| Name       | Type            | Required         | Description                                                      |
+|------------|-----------------|------------------|------------------------------------------------------------------|
+| `weekdays` | `WeekdayType[]` |  <div>Yes</div>  |                                                                  |
+| `time`     | `string`        |  <div>Yes</div>  | - Time when the reboot should be executed. Format is `HH:mm:ss`. |
 
 #### Example
 
@@ -217,13 +217,13 @@ setTimer(type: keyof typeof TimerType, timeOn: string | null, timeOff: string |
 
 #### Params
 
-| Name       | Type                                                                                      | Description                                                               |
-|------------|-------------------------------------------------------------------------------------------|---------------------------------------------------------------------------|
-| `type`     | `"TIMER_1" \| "TIMER_2" \| "TIMER_3" \| "TIMER_4" \| "TIMER_5" \| "TIMER_6" \| "TIMER_7"` | The type of the timer (`TIMER_1`, ..., `TIMER_7`).                        |
-| `timeOn`   | `string \| null`                                                                          | The time when the device should turn on.                                  |
-| `timeOff`  | `string \| null`                                                                          | The time when the device should turn off.                                 |
-| `weekdays` | `string[]`                                                                                | The days of the week when the timer should be active (`mon`, ..., `sun`). |
-| `volume`   | `number`                                                                                  | The volume level set when the device is turned on.                        |
+| Name       | Type                                                                                      | Required         | Description                                                               |
+|------------|-------------------------------------------------------------------------------------------|------------------|---------------------------------------------------------------------------|
+| `type`     | `"TIMER_1" \| "TIMER_2" \| "TIMER_3" \| "TIMER_4" \| "TIMER_5" \| "TIMER_6" \| "TIMER_7"` |  <div>Yes</div>  | The type of the timer (`TIMER_1`, ..., `TIMER_7`).                        |
+| `timeOn`   | `string \| null`                                                                          |  <div>Yes</div>  | The time when the device should turn on.                                  |
+| `timeOff`  | `string \| null`                                                                          |  <div>Yes</div>  | The time when the device should turn off.                                 |
+| `weekdays` | `string[]`                                                                                |  <div>Yes</div>  | The days of the week when the timer should be active (`mon`, ..., `sun`). |
+| `volume`   | `number`                                                                                  |  <div>Yes</div>  | The volume level set when the device is turned on.                        |
 
 #### Example
 
@@ -260,9 +260,9 @@ unsetProprietaryTimer(type: ProprietaryTimerType): Promise<void>;
 
 #### Params
 
-| Name   | Type                | Description                                        |
-|--------|---------------------|----------------------------------------------------|
-| `type` | ``TIMER_${number}`` | The type of the timer (`TIMER_1`, ..., `TIMER_7`). |
+| Name   | Type                | Required         | Description                                        |
+|--------|---------------------|------------------|----------------------------------------------------|
+| `type` | ``TIMER_${number}`` |  <div>Yes</div>  | The type of the timer (`TIMER_1`, ..., `TIMER_7`). |
 
 #### Example
 
@@ -282,9 +282,9 @@ unsetTimer(type: keyof typeof TimerType): Promise<void>;
 
 #### Params
 
-| Name   | Type                                                                                      | Description                                        |
-|--------|-------------------------------------------------------------------------------------------|----------------------------------------------------|
-| `type` | `"TIMER_1" \| "TIMER_2" \| "TIMER_3" \| "TIMER_4" \| "TIMER_5" \| "TIMER_6" \| "TIMER_7"` | The type of the timer (`TIMER_1`, ..., `TIMER_7`). |
+| Name   | Type                                                                                      | Required         | Description                                        |
+|--------|-------------------------------------------------------------------------------------------|------------------|----------------------------------------------------|
+| `type` | `"TIMER_1" \| "TIMER_2" \| "TIMER_3" \| "TIMER_4" \| "TIMER_5" \| "TIMER_6" \| "TIMER_7"` |  <div>Yes</div>  | The type of the timer (`TIMER_1`, ..., `TIMER_7`). |
 
 #### Example
 

package/docs/sos_management/screen.md

@@ -117,13 +117,13 @@ resize(baseUrl: string, orientation: string, resolution: string, currentVersion:
 
 #### Params
 
-| Name                            | Type     | Description                                                                                                                          |
-|---------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------|
-| `baseUrl`                       | `string` | SSSP & Tizen devices requires to install a orientation-specific Core App if you want to switch orientation to portrait or landscape. |
-| `orientation`                   | `string` | Screen orientation                                                                                                                   |
-| `resolution`                    | `string` | Where it applies (mainly SSSP 2/3)                                                                                                   |
-| `currentVersion`                | `string` | Core App version                                                                                                                     |
-| `videoOrientation` *(optional)* | `string` | If the video has different orientation than the HTML5 content                                                                        |
+| Name               | Type     | Required         | Description                                                                                                                          |
+|--------------------|----------|------------------|--------------------------------------------------------------------------------------------------------------------------------------|
+| `baseUrl`          | `string` |  <div>Yes</div>  | SSSP & Tizen devices requires to install a orientation-specific Core App if you want to switch orientation to portrait or landscape. |
+| `orientation`      | `string` |  <div>Yes</div>  | Screen orientation                                                                                                                   |
+| `resolution`       | `string` |  <div>Yes</div>  | Where it applies (mainly SSSP 2/3)                                                                                                   |
+| `currentVersion`   | `string` |  <div>Yes</div>  | Core App version                                                                                                                     |
+| `videoOrientation` | `string` |  <div>No</div>   | If the video has different orientation than the HTML5 content                                                                        |
 
 #### Example
 
@@ -163,12 +163,12 @@ setBrightness(timeFrom1: string, brightness1: number, timeFrom2: string, brightn
 
 #### Params
 
-| Name          | Type     | Description                        |
-|---------------|----------|------------------------------------|
-| `timeFrom1`   | `string` | Time in the XX:XX format           |
-| `brightness1` | `number` | Brightness value between 0 and 100 |
-| `timeFrom2`   | `string` | Time in the XX:XX format           |
-| `brightness2` | `number` | Brightness value between 0 and 100 |
+| Name          | Type     | Required         | Description                        |
+|---------------|----------|------------------|------------------------------------|
+| `timeFrom1`   | `string` |  <div>Yes</div>  | Time in the XX:XX format           |
+| `brightness1` | `number` |  <div>Yes</div>  | Brightness value between 0 and 100 |
+| `timeFrom2`   | `string` |  <div>Yes</div>  | Time in the XX:XX format           |
+| `brightness2` | `number` |  <div>Yes</div>  | Brightness value between 0 and 100 |
 
 #### Example
 
@@ -206,10 +206,10 @@ takeAndUploadScreenshot(uploadBaseUrl: string, computeHash?: boolean): Promise<{
 
 #### Params
 
-| Name                       | Type      | Description                                                                                                   |
-|----------------------------|-----------|---------------------------------------------------------------------------------------------------------------|
-| `uploadBaseUrl`            | `string`  | URL to which the screenshot will be uploaded. It can be either a signageOS upload url or a custom server url. |
-| `computeHash` *(optional)* | `boolean` | Whether to compute a hash of the screenshot and return it in the response.                                    |
+| Name            | Type      | Required         | Description                                                                                                   |
+|-----------------|-----------|------------------|---------------------------------------------------------------------------------------------------------------|
+| `uploadBaseUrl` | `string`  |  <div>Yes</div>  | URL to which the screenshot will be uploaded. It can be either a signageOS upload url or a custom server url. |
+| `computeHash`   | `boolean` |  <div>No</div>   | Whether to compute a hash of the screenshot and return it in the response.                                    |
 
 #### Example
 

package/docs/sos_management/security.md

@@ -42,9 +42,9 @@ setPinCode(pinCode: string): Promise<void>;
 
 #### Params
 
-| Name      | Type     | Description             |
-|-----------|----------|-------------------------|
-| `pinCode` | `string` | The PIN code to be set. |
+| Name      | Type     | Required         | Description             |
+|-----------|----------|------------------|-------------------------|
+| `pinCode` | `string` |  <div>Yes</div>  | The PIN code to be set. |
 
 #### Possible errors
 

package/docs/sos_management/time.md

@@ -57,10 +57,10 @@ interface DateTime {
 
 #### Params
 
-| Name       | Type       | Description               |
-|------------|------------|---------------------------|
-| `dateTime` | `DateTime` | The date and time to set. |
-| `timezone` | `string`   | The timezone to set.      |
+| Name       | Type       | Required         | Description               |
+|------------|------------|------------------|---------------------------|
+| `dateTime` | `DateTime` |  <div>Yes</div>  | The date and time to set. |
+| `timezone` | `string`   |  <div>Yes</div>  | The timezone to set.      |
 
 <Separator />
 
@@ -83,10 +83,10 @@ setNTP(ntpServer: string, timezone: string): Promise<void>;
 
 #### Params
 
-| Name        | Type     | Description            |
-|-------------|----------|------------------------|
-| `ntpServer` | `string` | The NTP server to set. |
-| `timezone`  | `string` | The timezone to set.   |
+| Name        | Type     | Required         | Description            |
+|-------------|----------|------------------|------------------------|
+| `ntpServer` | `string` |  <div>Yes</div>  | The NTP server to set. |
+| `timezone`  | `string` |  <div>Yes</div>  | The timezone to set.   |
 
 <Separator />
 

package/docs/sos_management/wifi.md

@@ -54,11 +54,11 @@ type WifiEncryptionType = 'OPEN' | 'WEP' | 'WPA2' | 'WPA2_WPA_MIXED' | 'WPA3' |
 
 #### Params
 
-| Name                    | Type                  | Description                                                                |
-|-------------------------|-----------------------|----------------------------------------------------------------------------|
-| `ssid`                  | `string`              | Name of the network, max. allowed length is 32 characters.                 |
-| `password` *(optional)* | `string`              | Password of the device, must be between 8 and 32 characters.               |
-| `options` *(optional)*  | `IWifiConnectOptions` | Additional options for the connection, such as `hidden` or `securityType`. |
+| Name       | Type                  | Required         | Description                                                                |
+|------------|-----------------------|------------------|----------------------------------------------------------------------------|
+| `ssid`     | `string`              |  <div>Yes</div>  | Name of the network, max. allowed length is 32 characters.                 |
+| `password` | `string`              |  <div>No</div>   | Password of the device, must be between 8 and 32 characters.               |
+| `options`  | `IWifiConnectOptions` |  <div>No</div>   | Additional options for the connection, such as `hidden` or `securityType`. |
 
 #### Return value
 
@@ -126,10 +126,10 @@ enableAP(ssid: string, password: string): Promise<void>;
 
 #### Params
 
-| Name       | Type     | Description                                                  |
-|------------|----------|--------------------------------------------------------------|
-| `ssid`     | `string` | Name of the network, max. allowed length is 32 characters.   |
-| `password` | `string` | Password of the device, must be between 8 and 32 characters. |
+| Name       | Type     | Required         | Description                                                  |
+|------------|----------|------------------|--------------------------------------------------------------|
+| `ssid`     | `string` |  <div>Yes</div>  | Name of the network, max. allowed length is 32 characters.   |
+| `password` | `string` |  <div>Yes</div>  | Password of the device, must be between 8 and 32 characters. |
 
 #### Possible errors
 
@@ -425,9 +425,9 @@ setCountry(countryCode: string): Promise<void>;
 
 #### Params
 
-| Name          | Type     | Description                                       |
-|---------------|----------|---------------------------------------------------|
-| `countryCode` | `string` | 2-letter country code from the ISO 3166 standard. |
+| Name          | Type     | Required         | Description                                       |
+|---------------|----------|------------------|---------------------------------------------------|
+| `countryCode` | `string` |  <div>Yes</div>  | 2-letter country code from the ISO 3166 standard. |
 
 #### Possible errors
 

package/es6/FrontApplet/Debug/Debug.d.ts

@@ -20,7 +20,7 @@ export default class Debug extends EventEmitter implements IDebug {
     /**
      * The `isRemoteDebugEnabled()` method returns the state of the Device debug mode.
      *
-     * @returens {Promise<boolean>} Resolves to `true` if the remote debug mode is enabled, otherwise `false`.
+     * @returns {Promise<boolean>} Resolves to `true` if the remote debug mode is enabled, otherwise `false`.
      * @since 5.8.0
      */
     isRemoteDebugEnabled(): Promise<boolean>;

package/es6/FrontApplet/Debug/Debug.js

@@ -29,7 +29,7 @@ class Debug extends events_1.EventEmitter {
     /**
      * The `isRemoteDebugEnabled()` method returns the state of the Device debug mode.
      *
-     * @returens {Promise<boolean>} Resolves to `true` if the remote debug mode is enabled, otherwise `false`.
+     * @returns {Promise<boolean>} Resolves to `true` if the remote debug mode is enabled, otherwise `false`.
      * @since 5.8.0
      */
     async isRemoteDebugEnabled() {

package/es6/FrontApplet/DeviceInfo/DeviceInfo.d.ts

@@ -15,7 +15,7 @@ export default class DeviceInfo implements IDeviceInfo {
      * updated when changed and persisted in local storage.
      *
      * :::note
-     * Location can be set only in CloudControl on Device Info page, or via Rest API.
+     * Location can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/DeviceLocation/paths/~1v1~1device~1%7BdeviceUid%7D~1location~1%7BlocationUid%7D/get).
      * :::
      *
      * @returns {Promise<IDeviceLocation | null>} A promise that resolves to the device location or `null` if not set.
@@ -27,7 +27,7 @@ export default class DeviceInfo implements IDeviceInfo {
      * updated when changed and persisted in local storage.
      *
      * :::note
-     * Tags can be set only in CloudControl on Device Info page, or via Rest API.
+     * Tags can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/DeviceTag-(Device-Tags)).
      * :::
      *
      * @returns {Promise<IOrganizationTag[]>} A promise that resolves to an array of organization tags.
@@ -38,6 +38,10 @@ export default class DeviceInfo implements IDeviceInfo {
      * The `getDeviceName()` method returns a name of the device. Name is requested from server on application start, automatically
      * updated when changed and persisted in local storage.
      *
+     * :::note
+     * Device name can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/Device/paths/~1v2~1device~1%7BdeviceUid%7D/get).
+     * :::
+     *
      * @returns {Promise<string>} A promise that resolves to the device name.
      * @since 6.6.0
      *

package/es6/FrontApplet/DeviceInfo/DeviceInfo.js

@@ -18,7 +18,7 @@ class DeviceInfo {
      * updated when changed and persisted in local storage.
      *
      * :::note
-     * Location can be set only in CloudControl on Device Info page, or via Rest API.
+     * Location can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/DeviceLocation/paths/~1v1~1device~1%7BdeviceUid%7D~1location~1%7BlocationUid%7D/get).
      * :::
      *
      * @returns {Promise<IDeviceLocation | null>} A promise that resolves to the device location or `null` if not set.
@@ -33,7 +33,7 @@ class DeviceInfo {
      * updated when changed and persisted in local storage.
      *
      * :::note
-     * Tags can be set only in CloudControl on Device Info page, or via Rest API.
+     * Tags can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/DeviceTag-(Device-Tags)).
      * :::
      *
      * @returns {Promise<IOrganizationTag[]>} A promise that resolves to an array of organization tags.
@@ -47,6 +47,10 @@ class DeviceInfo {
      * The `getDeviceName()` method returns a name of the device. Name is requested from server on application start, automatically
      * updated when changed and persisted in local storage.
      *
+     * :::note
+     * Device name can be set only in CloudControl on Device Info page, or via [Rest API](https://developers.signageos.io/api/#tag/Device/paths/~1v2~1device~1%7BdeviceUid%7D/get).
+     * :::
+     *
      * @returns {Promise<string>} A promise that resolves to the device name.
      * @since 6.6.0
      *

package/es6/FrontApplet/DeviceInfo/DeviceInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"DeviceInfo.js","sourceRoot":"","sources":["../../../src/FrontApplet/DeviceInfo/DeviceInfo.ts"],"names":[],"mappings":";;AAGA;;;GAGG;AACH,MAAqB,UAAU;IAKrB;IACA;IALF,MAAM,CAAC,cAAc,GAAW,aAAa,CAAC;IAErD,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;;;;;;;OAUG;IACI,KAAK,CAAC,WAAW;QACvB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;QACvF,OAAO,QAAQ,CAAC;IACjB,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,mBAAmB;QAC/B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;QAC5F,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,aAAa;QACzB,OAAO,IAAI,CAAC,sBAAsB,EAAE,CAAC;IACtC,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxE,CAAC;IAEO,sBAAsB;QAC7B,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;QAC5C,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QACxE,MAAM,aAAa,GAAG,YAAY,CAAC,aAAc,CAAC;QAClD,OAAO,aAAa,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC;IACvE,CAAC;;AAjEF,6BAkEC"}
+{"version":3,"file":"DeviceInfo.js","sourceRoot":"","sources":["../../../src/FrontApplet/DeviceInfo/DeviceInfo.ts"],"names":[],"mappings":";;AAGA;;;GAGG;AACH,MAAqB,UAAU;IAKrB;IACA;IALF,MAAM,CAAC,cAAc,GAAW,aAAa,CAAC;IAErD,gBAAgB;IAChB,YACS,aAAqB,EACrB,WAA8B;QAD9B,kBAAa,GAAb,aAAa,CAAQ;QACrB,gBAAW,GAAX,WAAW,CAAmB;IACpC,CAAC;IAEJ;;;;;;;;;;OAUG;IACI,KAAK,CAAC,WAAW;QACvB,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC,CAAC;QACvF,OAAO,QAAQ,CAAC;IACjB,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,mBAAmB;QAC/B,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,uBAAuB,CAAC,EAAE,CAAC,CAAC;QAC5F,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,KAAK,CAAC,aAAa;QACzB,OAAO,IAAI,CAAC,sBAAsB,EAAE,CAAC;IACtC,CAAC;IAEO,UAAU,CAAC,IAAY;QAC9B,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxE,CAAC;IAEO,sBAAsB;QAC7B,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;QAC5C,MAAM,YAAY,GAAG,YAAY,CAAC,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QACxE,MAAM,aAAa,GAAG,YAAY,CAAC,aAAc,CAAC;QAClD,OAAO,aAAa,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,IAAI,EAAE,CAAC;IACvE,CAAC;;AArEF,6BAsEC"}

package/es6/FrontApplet/Display/Display.d.ts

@@ -32,7 +32,7 @@ declare class Display implements IDisplay {
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
     /**
      * The `supports()` method determines whether a queried capability is supported by the device.
-     * @param capability - The capability to check for support.
+     * @param capability The capability to check for support.
      * @returns {Promise<boolean>} Resolves to `true` if the capability is supported, otherwise `false`.
      * @since 3.1.0
      */

package/es6/FrontApplet/Display/Display.js

@@ -39,7 +39,7 @@ class Display {
     }
     /**
      * The `supports()` method determines whether a queried capability is supported by the device.
-     * @param capability - The capability to check for support.
+     * @param capability The capability to check for support.
      * @returns {Promise<boolean>} Resolves to `true` if the capability is supported, otherwise `false`.
      * @since 3.1.0
      */

package/es6/FrontApplet/Hardware/BarcodeScanner/BarcodeScanner.d.ts

@@ -1,7 +1,15 @@
 import IPostMessage from '../../IPostMessage';
 import IBarcodeScannerDataMessage from './IBarcodeScannerDataMessage';
-import IBarcodeScanner, { IBarcodeScannerOptions } from './IBarcodeScanner';
+import IBarcodeScanner, { IBarcodeScannerOptions, IBarcodeScannerResponse } from './IBarcodeScanner';
 export declare const DEFAULT_SCANNER_ID = 0;
+/**
+ * The `sos.hardware.barcodeScanner` API provides methods for working with barcode scanners.
+ * It allows starting and stopping the scanner, as well as listening for scanned data and errors.
+ *
+ * :::note
+ * This API is experimental and may change in the future.
+ * :::
+ */
 export default class BarcodeScanner implements IBarcodeScanner {
     private messagePrefix;
     private postMessage;
@@ -10,17 +18,37 @@ export default class BarcodeScanner implements IBarcodeScanner {
     /** @internal */
     constructor(messagePrefix: string, postMessage: IPostMessage<any>);
     /**
-     * @experimental
+     * The `getVersion()` method returns the version of the barcode scanner.
+     *
+     * @returns {Promise<string>} Returns a promise that resolves to the version of the barcode scanner.
+     * @throws {Error} If the version cannot be retrieved.
+     * @since 3.0.0
      */
     getVersion(): Promise<string>;
     /**
-     * @experimental
+     * The `start()` starts the barcode scanner and starts listening for scanned data.
+     * @param userOptions User options to configure the scanner.
+     * @param userOptions.timeout The maximum time to wait for a scan before timing out.
+     * @param userOptions.cancelPrevious If set to `true`, it will cancel any previous scanner instance with the same `scannerId`.
+     * @returns Returns a promise that resolves to an object with methods to stop the scanner and listen for scanned data and errors.
+     * @throws {Error} If the scanner cannot be started.
+     * @throws {Error} If the scanner is already running and `cancelPrevious` option is not set to `true`.
+     * @throws {Error} If any other error occurs while starting the scanner.
+     * @since 3.0.0
+     *
+     * @example
+     * // Start the barcode scanner with default options
+     * const scanner = await sos.hardware.barcodeScanner.start();
+     * // Listen for scanned data
+     * scanner.onData((data) => {
+     * 	console.log(`Scanned data: ${data}`);
+     * });
+     * // Listen for errors
+     * scanner.onError((error) => {
+     * 	console.error(`Scanner error: ${error.message}`);
+     * });
      */
-    start(userOptions?: Omit<IBarcodeScannerOptions, 'scannerId'>): Promise<{
-        stop: () => Promise<void>;
-        onData: (listener: (data: string) => void) => void;
-        onError: (listener: (error: Error) => void) => void;
-    }>;
+    start(userOptions?: Omit<IBarcodeScannerOptions, 'scannerId'>): Promise<IBarcodeScannerResponse>;
     /** @internal */
     handleMessageData(msg: IBarcodeScannerDataMessage): void;
     private getMessage;