@signageos/front-applet 8.2.0 → 8.2.2

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

@@ -19,10 +19,30 @@ import Security from './Security/Security';
 import Time from './Time/Time';
 import Wifi from './Wifi/Wifi';
 /**
- * The `sos.management` API group provides methods for managing the device. Through this API things like device firmware,
- * battery status, brightness, network information, remote control, power, time or volume can be monitored.
+ * The `sos.management` API group provides methods for managing the device. Through this API, things like device firmware,
+ * battery status, brightness, network information, remote control, power, time, or volume can be monitored.
  *
- * @example // {@link https://developers.signageos.io/sdk/management/js-management-management Example of the App API}
+ * :::note GitHub Example
+ * - [Basic usage of the Management API](https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/basics)
+ * - [Getting basic management data](https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/js-management-getters)
+ * - [Setting management data](https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/js-management-setters)
+ * :::
+ *
+ * <details>
+ *     <summary>Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `MODEL` | If device can return proper model name |
+ * 		| `SERIAL_NUMBER` | If device can return serial number |
+ * 		| `BATTERY_STATUS` | If device can return battery status |
+ * 		| `TEMPERATURE` | If device can return current temperature |
+ * 		| `BRAND` | If device can return manufacturer brand |
+ * 		| `FACTORY_RESET` | If device can perform factory reset |
+ * 		| `EXTENDED_MANAGEMENT` | If device can return or set extended management URL |
+ * 		| `HARDWARE_ACCELERATION` | If device can turn hardware acceleration on or off |
+ *
+ * 		If you want to check if the device supports those capabilities, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+ * </details>
  */
 export default class Management implements IManagement {
     private messagePrefix;
@@ -49,21 +69,48 @@ export default class Management implements IManagement {
     /**
      * The `supports()` method determines whether a queried capability is supported.
      *
-     * @param capability The capability to check for support.
+     * #### What are capabilities?
+     * Capabilities are features or functionalities that a device can support. We divided those capabilities into `front` and `management` capabilities.
+     * This section is about management capabilities, which include features to manage the device, receive information about the device, or change its settings.
+     *
+     * On the other hand, the `front` capabilities are features that are related to the application running on the device, such as displaying content, handling user input, etc.
+     * To check `front` capabilities, refer to the `sos.display.supports()` method or [this section](https://developers.signageos.io/sdk/sos/display#supports).
      *
+     * :::tip
+     * If you want to check specific capabilities, refer to the sidebar for the selected management section. Every section has its capabilities written in the description,
+     * or check the **ManagementCapability** type in `supports()` method. It has a list of all available capabilities for all platforms.
+     * :::
+     *
+     * @param capability The capability to check for support.
+     * @returns {Promise<boolean>} A promise that resolves to `true` if the capability is supported, otherwise `false`.
+     * @throws {Error} If the capability is not a valid string.
      * @since 2.0.0
+     *
+     * @example
+     * const isSupported = await sos.management.supports('OS_VERSION');
+     * console.log(`Is OS_VERSION supported? ${isSupported}`);
      */
     supports(capability: ManagementCapability): Promise<boolean>;
     /**
      * The `getModel()` method returns the model of the device.
      *
+     * @returns {Promise<string>} A promise that resolves to the model name of the device.
      * @since 2.0.0
+     *
+     * @example
+     * const model = await sos.management.getModel();
+     * console.log(`Device model is: ${model}`); // e.g. 'XC4055' (BrightSign)
      */
     getModel(): Promise<string>;
     /**
      * The `getSerialNumber()` method returns the serial number of the device.
      *
+     * @returns {Promise<string>} A promise that resolves to the serial number of the device.
      * @since 2.1.0
+     *
+     * @example
+     * const serialNumber = await sos.management.getSerialNumber();
+     * console.log(`Device serial number is: ${serialNumber}`); // e.g. '1234567890'
      */
     getSerialNumber(): Promise<string>;
     /** @deprecated Use `sos.management.network.listInterfaces()` instead. */
@@ -71,77 +118,128 @@ export default class Management implements IManagement {
     /**
      * The `getBatteryStatus()` method returns information about the battery of the device.
      *
+     * :::note
+     * - Emulator has mocked this method and will always return a battery status with 100% charge.
+     * :::
+     *
+     * @returns {Promise<IBatteryStatus>} A promise that resolves to an object containing the battery status.
+     * @throws {Error} If the device does not support battery status monitoring.
      * @since 2.1.0
+     *
+     * @example
+     * const batteryStatus = await sos.management.getBatteryStatus();
+     * console.log(`Battery status: ${batteryStatus.percentage}% charged`);
      */
     getBatteryStatus(): Promise<IBatteryStatus>;
     /**
-     * The `getTemperature()` method returns the temperature of the device (in 0-100 range of degrees Celsius).
+     * The `getTemperature()` method returns the temperature of the device (in the 0-100 range of degrees Celsius).
      *
+     * @returns {Promise<number>} A promise that resolves to the current temperature of the device.
+     * @throws {Error} If the device does not support temperature monitoring.
      * @since 3.0.0
+     *
+     * @example
+     * const temperature = await sos.management.getTemperature();
+     * console.log(`Current device temperature is: ${temperature}°C`); // e.g. 25°C
      */
     getTemperature(): Promise<number>;
     /**
      * The `getBrand()` method returns the manufacturer brand of the device.
      *
+     * @returns {Promise<string>} A promise that resolves to the brand name of the device.
+     * @throws {Error} If the device does not support brand information.
      * @since 5.7.0
+     *
+     * @example
+     * const brand = await sos.management.getBrand();
+     * console.log(`Device brand is: ${brand}`); // e.g., 'Samsung', 'LG', BrightSign, etc.
      */
     getBrand(): Promise<string>;
     /**
      * The `resetSettings()` method initializes the reset of the specific device settings.
      *
-     * :::info
-     *
-     * This is currently only implemented on Linux platform.
-     *
+     * :::warning
+     * This is currently only implemented on the Linux platform.
      * :::
      *
+     * @returns {Promise<void>} A promise that resolves when the settings are reset.
+     * @throws {Error} If the device does not support settings reset.
      * @since 4.0.0
      */
     resetSettings(): Promise<void>;
     /**
      * The `factoryReset()` method initializes the factory reset of the device.
      *
+     * @returns {Promise<void>} A promise that resolves when the factory reset is initiated.
+     * @throws {Error} If the device does not support factory reset.
      * @since 4.0.0
      */
     factoryReset(): Promise<void>;
     /**
-     * The `getExtendedManagementUrl()` method returns the management url of the device.
+     * The `getExtendedManagementUrl()` method returns the management URL of the device.
      *
      * :::info
-     *
-     * This is currently only implemented for the MagicInfo on Tizen platform.
-     *
+     * This is currently only implemented for the MagicInfo on the Tizen platform.
      * :::
      *
+     * @returns {Promise<string | null>} A promise that resolves to the management URL of the device, or `null` if not set.
+     * @throws {Error} If the device does not support the extended management URL.
      * @since 6.2.0
      */
     getExtendedManagementUrl(): Promise<string | null>;
     /**
-     * The `getExtendedManagementUrl()` set the management url of the device.
+     * The `getExtendedManagementUrl()` sets the management URL of the device.
      *
      * :::info
-     *
-     * This is currently only implemented for the MagicInfo on Tizen platform.
-     *
+     * This is currently only implemented for the MagicInfo on the Tizen platform.
      * :::
      *
-     * @param url The management URL to set.
-     *
+     * @param url The management URL to set. If `null`, it will remove the current URL.
+     * @returns {Promise<void>} A promise that resolves when the URL is set.
+     * @throws {Error} If the URL is not a valid string or if the device
+     * @throws {Error} If the device does not support the extended management URL.
      * @since 6.2.0
+     *
+     * @example
+     * await sos.management.setExtendedManagementUrl('https://example.com/management');
+     * // later
+     * const url = await sos.management.getExtendedManagementUrl();
+     * console.log(`Extended management URL is: ${url}`); // e.g. 'https://example.com/management'
      */
     setExtendedManagementUrl(url: string | null): Promise<void>;
     /**
-     * The `setHardwareAcceleration()` method enables or disables hardware acceleration.
+     * The `setHardwareAcceleration()` method turns hardware acceleration on or off.
      *
-     * @param enabled Whether hardware acceleration should be enabled.
+     * :::note
+     * - This is currently only implemented for the BrightSign platform.
+     * - Device must always be rebooted for the changes to take effect.
+     * :::
      *
+     * @param enabled Whether hardware acceleration should be enabled.
+     * @returns {Promise<void>} A promise that resolves when the hardware acceleration setting is applied.
+     * @throws {Error} If the `enabled` parameter is not a boolean.
+     * @throws {Error} If the device does not support hardware acceleration management.
      * @since 7.1.0
+     *
+     * @example
+     * await sos.management.setHardwareAcceleration(true).then(async () => {
+     * 	console.log('Hardware acceleration enabled.');
+     * 	await sos.management.reboot();
+     * }).catch((error) => {
+     * 	console.error('Failed to set hardware acceleration:', error);
+     * });
      */
     setHardwareAcceleration(enabled: boolean): Promise<void>;
     /**
      * The `isHardwareAccelerationEnabled()` method returns whether hardware acceleration is enabled.
      *
+     * @returns {Promise<boolean>} A promise that resolves to `true` if hardware acceleration is enabled, otherwise `false`.
+     * @throws {Error} If the device does not support hardware acceleration management.
      * @since 7.1.0
+     *
+     * @example
+     * const isEnabled = await sos.management.isHardwareAccelerationEnabled();
+     * console.log(`Hardware acceleration is ${isEnabled ? 'enabled' : 'disabled'}.`);
      */
     isHardwareAccelerationEnabled(): Promise<boolean>;
     private getMessage;

package/es6/FrontApplet/Management/Management.js

@@ -21,10 +21,30 @@ const Security_1 = __importDefault(require("./Security/Security"));
 const Time_1 = __importDefault(require("./Time/Time"));
 const Wifi_1 = __importDefault(require("./Wifi/Wifi"));
 /**
- * The `sos.management` API group provides methods for managing the device. Through this API things like device firmware,
- * battery status, brightness, network information, remote control, power, time or volume can be monitored.
+ * The `sos.management` API group provides methods for managing the device. Through this API, things like device firmware,
+ * battery status, brightness, network information, remote control, power, time, or volume can be monitored.
  *
- * @example // {@link https://developers.signageos.io/sdk/management/js-management-management Example of the App API}
+ * :::note GitHub Example
+ * - [Basic usage of the Management API](https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/basics)
+ * - [Getting basic management data](https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/js-management-getters)
+ * - [Setting management data](https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/js-management-setters)
+ * :::
+ *
+ * <details>
+ *     <summary>Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `MODEL` | If device can return proper model name |
+ * 		| `SERIAL_NUMBER` | If device can return serial number |
+ * 		| `BATTERY_STATUS` | If device can return battery status |
+ * 		| `TEMPERATURE` | If device can return current temperature |
+ * 		| `BRAND` | If device can return manufacturer brand |
+ * 		| `FACTORY_RESET` | If device can perform factory reset |
+ * 		| `EXTENDED_MANAGEMENT` | If device can return or set extended management URL |
+ * 		| `HARDWARE_ACCELERATION` | If device can turn hardware acceleration on or off |
+ *
+ * 		If you want to check if the device supports those capabilities, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+ * </details>
  */
 class Management {
     messagePrefix;
@@ -70,9 +90,26 @@ class Management {
     /**
      * The `supports()` method determines whether a queried capability is supported.
      *
-     * @param capability The capability to check for support.
+     * #### What are capabilities?
+     * Capabilities are features or functionalities that a device can support. We divided those capabilities into `front` and `management` capabilities.
+     * This section is about management capabilities, which include features to manage the device, receive information about the device, or change its settings.
+     *
+     * On the other hand, the `front` capabilities are features that are related to the application running on the device, such as displaying content, handling user input, etc.
+     * To check `front` capabilities, refer to the `sos.display.supports()` method or [this section](https://developers.signageos.io/sdk/sos/display#supports).
      *
+     * :::tip
+     * If you want to check specific capabilities, refer to the sidebar for the selected management section. Every section has its capabilities written in the description,
+     * or check the **ManagementCapability** type in `supports()` method. It has a list of all available capabilities for all platforms.
+     * :::
+     *
+     * @param capability The capability to check for support.
+     * @returns {Promise<boolean>} A promise that resolves to `true` if the capability is supported, otherwise `false`.
+     * @throws {Error} If the capability is not a valid string.
      * @since 2.0.0
+     *
+     * @example
+     * const isSupported = await sos.management.supports('OS_VERSION');
+     * console.log(`Is OS_VERSION supported? ${isSupported}`);
      */
     async supports(capability) {
         (0, Validate_1.default)({ capability }).required().string();
@@ -85,7 +122,12 @@ class Management {
     /**
      * The `getModel()` method returns the model of the device.
      *
+     * @returns {Promise<string>} A promise that resolves to the model name of the device.
      * @since 2.0.0
+     *
+     * @example
+     * const model = await sos.management.getModel();
+     * console.log(`Device model is: ${model}`); // e.g. 'XC4055' (BrightSign)
      */
     async getModel() {
         const { model } = await this.postMessage({
@@ -96,7 +138,12 @@ class Management {
     /**
      * The `getSerialNumber()` method returns the serial number of the device.
      *
+     * @returns {Promise<string>} A promise that resolves to the serial number of the device.
      * @since 2.1.0
+     *
+     * @example
+     * const serialNumber = await sos.management.getSerialNumber();
+     * console.log(`Device serial number is: ${serialNumber}`); // e.g. '1234567890'
      */
     async getSerialNumber() {
         const { serialNumber } = await this.postMessage({
@@ -111,7 +158,17 @@ class Management {
     /**
      * The `getBatteryStatus()` method returns information about the battery of the device.
      *
+     * :::note
+     * - Emulator has mocked this method and will always return a battery status with 100% charge.
+     * :::
+     *
+     * @returns {Promise<IBatteryStatus>} A promise that resolves to an object containing the battery status.
+     * @throws {Error} If the device does not support battery status monitoring.
      * @since 2.1.0
+     *
+     * @example
+     * const batteryStatus = await sos.management.getBatteryStatus();
+     * console.log(`Battery status: ${batteryStatus.percentage}% charged`);
      */
     async getBatteryStatus() {
         const { batteryStatus } = await this.postMessage({
@@ -120,9 +177,15 @@ class Management {
         return batteryStatus;
     }
     /**
-     * The `getTemperature()` method returns the temperature of the device (in 0-100 range of degrees Celsius).
+     * The `getTemperature()` method returns the temperature of the device (in the 0-100 range of degrees Celsius).
      *
+     * @returns {Promise<number>} A promise that resolves to the current temperature of the device.
+     * @throws {Error} If the device does not support temperature monitoring.
      * @since 3.0.0
+     *
+     * @example
+     * const temperature = await sos.management.getTemperature();
+     * console.log(`Current device temperature is: ${temperature}°C`); // e.g. 25°C
      */
     async getTemperature() {
         const { currentTemperature } = await this.postMessage({
@@ -133,7 +196,13 @@ class Management {
     /**
      * The `getBrand()` method returns the manufacturer brand of the device.
      *
+     * @returns {Promise<string>} A promise that resolves to the brand name of the device.
+     * @throws {Error} If the device does not support brand information.
      * @since 5.7.0
+     *
+     * @example
+     * const brand = await sos.management.getBrand();
+     * console.log(`Device brand is: ${brand}`); // e.g., 'Samsung', 'LG', BrightSign, etc.
      */
     async getBrand() {
         const { brand } = await this.postMessage({
@@ -141,16 +210,15 @@ class Management {
         });
         return brand;
     }
-    // TODO: Used only by NEC, can be eventually removed?
     /**
      * The `resetSettings()` method initializes the reset of the specific device settings.
      *
-     * :::info
-     *
-     * This is currently only implemented on Linux platform.
-     *
+     * :::warning
+     * This is currently only implemented on the Linux platform.
      * :::
      *
+     * @returns {Promise<void>} A promise that resolves when the settings are reset.
+     * @throws {Error} If the device does not support settings reset.
      * @since 4.0.0
      */
     async resetSettings() {
@@ -161,6 +229,8 @@ class Management {
     /**
      * The `factoryReset()` method initializes the factory reset of the device.
      *
+     * @returns {Promise<void>} A promise that resolves when the factory reset is initiated.
+     * @throws {Error} If the device does not support factory reset.
      * @since 4.0.0
      */
     async factoryReset() {
@@ -169,14 +239,14 @@ class Management {
         });
     }
     /**
-     * The `getExtendedManagementUrl()` method returns the management url of the device.
+     * The `getExtendedManagementUrl()` method returns the management URL of the device.
      *
      * :::info
-     *
-     * This is currently only implemented for the MagicInfo on Tizen platform.
-     *
+     * This is currently only implemented for the MagicInfo on the Tizen platform.
      * :::
      *
+     * @returns {Promise<string | null>} A promise that resolves to the management URL of the device, or `null` if not set.
+     * @throws {Error} If the device does not support the extended management URL.
      * @since 6.2.0
      */
     async getExtendedManagementUrl() {
@@ -186,17 +256,23 @@ class Management {
         return url;
     }
     /**
-     * The `getExtendedManagementUrl()` set the management url of the device.
+     * The `getExtendedManagementUrl()` sets the management URL of the device.
      *
      * :::info
-     *
-     * This is currently only implemented for the MagicInfo on Tizen platform.
-     *
+     * This is currently only implemented for the MagicInfo on the Tizen platform.
      * :::
      *
-     * @param url The management URL to set.
-     *
+     * @param url The management URL to set. If `null`, it will remove the current URL.
+     * @returns {Promise<void>} A promise that resolves when the URL is set.
+     * @throws {Error} If the URL is not a valid string or if the device
+     * @throws {Error} If the device does not support the extended management URL.
      * @since 6.2.0
+     *
+     * @example
+     * await sos.management.setExtendedManagementUrl('https://example.com/management');
+     * // later
+     * const url = await sos.management.getExtendedManagementUrl();
+     * console.log(`Extended management URL is: ${url}`); // e.g. 'https://example.com/management'
      */
     async setExtendedManagementUrl(url) {
         (0, Validate_1.default)({ url }).string().canBeNull();
@@ -206,11 +282,26 @@ class Management {
         });
     }
     /**
-     * The `setHardwareAcceleration()` method enables or disables hardware acceleration.
+     * The `setHardwareAcceleration()` method turns hardware acceleration on or off.
      *
-     * @param enabled Whether hardware acceleration should be enabled.
+     * :::note
+     * - This is currently only implemented for the BrightSign platform.
+     * - Device must always be rebooted for the changes to take effect.
+     * :::
      *
+     * @param enabled Whether hardware acceleration should be enabled.
+     * @returns {Promise<void>} A promise that resolves when the hardware acceleration setting is applied.
+     * @throws {Error} If the `enabled` parameter is not a boolean.
+     * @throws {Error} If the device does not support hardware acceleration management.
      * @since 7.1.0
+     *
+     * @example
+     * await sos.management.setHardwareAcceleration(true).then(async () => {
+     * 	console.log('Hardware acceleration enabled.');
+     * 	await sos.management.reboot();
+     * }).catch((error) => {
+     * 	console.error('Failed to set hardware acceleration:', error);
+     * });
      */
     async setHardwareAcceleration(enabled) {
         (0, Validate_1.default)({ enabled }).required().boolean();
@@ -222,7 +313,13 @@ class Management {
     /**
      * The `isHardwareAccelerationEnabled()` method returns whether hardware acceleration is enabled.
      *
+     * @returns {Promise<boolean>} A promise that resolves to `true` if hardware acceleration is enabled, otherwise `false`.
+     * @throws {Error} If the device does not support hardware acceleration management.
      * @since 7.1.0
+     *
+     * @example
+     * const isEnabled = await sos.management.isHardwareAccelerationEnabled();
+     * console.log(`Hardware acceleration is ${isEnabled ? 'enabled' : 'disabled'}.`);
      */
     async isHardwareAccelerationEnabled() {
         const { enabled } = await this.postMessage({

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

@@ -1 +1 @@
-{"version":3,"file":"Management.js","sourceRoot":"","sources":["../../../src/FrontApplet/Management/Management.ts"],"names":[],"mappings":";;;;;AACA,oEAA4C;AAC5C,oDAA4B;AAC5B,0DAAkC;AAClC,+EAAuD;AACvD,0DAAkC;AAClC,mEAA2C;AAI3C,gEAAwC;AACxC,iDAAyB;AACzB,gEAAwC;AACxC,+EAAuD;AACvD,0DAAkC;AAClC,0DAAkC;AAClC,kFAA0D;AAC1D,6DAAqC;AACrC,mEAA2C;AAC3C,uDAA+B;AAC/B,uDAA+B;AAE/B;;;;;GAKG;AACH,MAAqB,UAAU;IAsBrB;IACA;IAtBF,MAAM,CAAC,cAAc,GAAW,YAAY,CAAC;IAEpC,GAAG,CAAM;IACT,EAAE,CAAK;IACP,KAAK,CAAQ;IACb,KAAK,CAAQ;IACb,QAAQ,CAAW;IACnB,OAAO,CAAU;IACjB,KAAK,CAAQ;IACb,aAAa,CAAgB;IAC7B,MAAM,CAAS;IACf,IAAI,CAAO;IACX,OAAO,CAAU;IACjB,IAAI,CAAO;IACX,QAAQ,CAAW;IACnB,KAAK,CAAQ;IACb,YAAY,CAAe;IAC3B,YAAY,CAAe;IAE3C,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;QAC9D,IAAI,CAAC,EAAE,GAAG,IAAI,YAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC5D,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACxE,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACtE,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,aAAa,GAAG,IAAI,uBAAa,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClF,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACpE,IAAI,CAAC,IAAI,GAAG,IAAI,cAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACtE,IAAI,CAAC,IAAI,GAAG,IAAI,cAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACxE,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,YAAY,GAAG,IAAI,sBAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAChF,IAAI,CAAC,YAAY,GAAG,IAAI,sBAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,QAAQ,CAAC,UAAgC;QACrD,IAAA,kBAAQ,EAAC,EAAE,UAAU,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAE7C,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC3C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YACjC,UAAU;SACV,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ;QACpB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACxC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;SAClC,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe;QAC3B,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC/C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;SAC1C,CAAC,CAAC;QAEH,OAAO,YAAY,CAAC;IACrB,CAAC;IAED,yEAAyE;IAClE,KAAK,CAAC,cAAc;QAC1B,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;IAC3C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,gBAAgB;QAC5B,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAChD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;SAC3C,CAAC,CAAC;QAEH,OAAO,aAAa,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc;QAC1B,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACrD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;SAChD,CAAC,CAAC;QAEH,OAAO,kBAAkB,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ;QACpB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACxC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;SAClC,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACd,CAAC;IAED,qDAAqD;IACrD;;;;;;;;;;OAUG;IACI,KAAK,CAAC,aAAa;QACzB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;SACvC,CAAC,CAAC;IACJ,CAAC;IAED;;;;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;;;;;;;;;;OAUG;IACI,KAAK,CAAC,wBAAwB;QACpC,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACtC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;SACnD,CAAC,CAAC;QACH,OAAO,GAAG,CAAC;IACZ,CAAC;IAED;;;;;;;;;;;;OAYG;IACI,KAAK,CAAC,wBAAwB,CAAC,GAAkB;QACvD,IAAA,kBAAQ,EAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,CAAC;QACvC,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;YACnD,GAAG;SACH,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,uBAAuB,CAAC,OAAgB;QACpD,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC;QAC3C,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;YAClD,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,6BAA6B;QACzC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC1C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kCAAkC,CAAC;SACzD,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IAChB,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,UAAU,CAAC,cAAc,CAAC;IAC7D,CAAC;;AAvOF,6BAwOC"}
+{"version":3,"file":"Management.js","sourceRoot":"","sources":["../../../src/FrontApplet/Management/Management.ts"],"names":[],"mappings":";;;;;AACA,oEAA4C;AAC5C,oDAA4B;AAC5B,0DAAkC;AAClC,+EAAuD;AACvD,0DAAkC;AAClC,mEAA2C;AAI3C,gEAAwC;AACxC,iDAAyB;AACzB,gEAAwC;AACxC,+EAAuD;AACvD,0DAAkC;AAClC,0DAAkC;AAClC,kFAA0D;AAC1D,6DAAqC;AACrC,mEAA2C;AAC3C,uDAA+B;AAC/B,uDAA+B;AAE/B;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAqB,UAAU;IAsBrB;IACA;IAtBF,MAAM,CAAC,cAAc,GAAW,YAAY,CAAC;IAEpC,GAAG,CAAM;IACT,EAAE,CAAK;IACP,KAAK,CAAQ;IACb,KAAK,CAAQ;IACb,QAAQ,CAAW;IACnB,OAAO,CAAU;IACjB,KAAK,CAAQ;IACb,aAAa,CAAgB;IAC7B,MAAM,CAAS;IACf,IAAI,CAAO;IACX,OAAO,CAAU;IACjB,IAAI,CAAO;IACX,QAAQ,CAAW;IACnB,KAAK,CAAQ;IACb,YAAY,CAAe;IAC3B,YAAY,CAAe;IAE3C,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;QAC9D,IAAI,CAAC,EAAE,GAAG,IAAI,YAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC5D,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACxE,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACtE,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,aAAa,GAAG,IAAI,uBAAa,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClF,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACpE,IAAI,CAAC,IAAI,GAAG,IAAI,cAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,CAAC,OAAO,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACtE,IAAI,CAAC,IAAI,GAAG,IAAI,cAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,CAAC,QAAQ,GAAG,IAAI,kBAAQ,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QACxE,IAAI,CAAC,KAAK,GAAG,IAAI,eAAK,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAClE,IAAI,CAAC,YAAY,GAAG,IAAI,sBAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAChF,IAAI,CAAC,YAAY,GAAG,IAAI,sBAAY,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,KAAK,CAAC,QAAQ,CAAC,UAAgC;QACrD,IAAA,kBAAQ,EAAC,EAAE,UAAU,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;QAE7C,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC3C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC;YACjC,UAAU;SACV,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC;IACjB,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,QAAQ;QACpB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACxC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;SAClC,CAAC,CAAC;QAEH,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACI,KAAK,CAAC,eAAe;QAC3B,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC/C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;SAC1C,CAAC,CAAC;QAEH,OAAO,YAAY,CAAC;IACrB,CAAC;IAED,yEAAyE;IAClE,KAAK,CAAC,cAAc;QAC1B,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACI,KAAK,CAAC,gBAAgB;QAC5B,MAAM,EAAE,aAAa,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAChD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;SAC3C,CAAC,CAAC;QAEH,OAAO,aAAa,CAAC;IACtB,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,cAAc;QAC1B,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACrD,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,yBAAyB,CAAC;SAChD,CAAC,CAAC;QAEH,OAAO,kBAAkB,CAAC;IAC3B,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,QAAQ;QACpB,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACxC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC;SAClC,CAAC,CAAC;QACH,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,aAAa;QACzB,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;SACvC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;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;;;;;;;;;;OAUG;IACI,KAAK,CAAC,wBAAwB;QACpC,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YACtC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;SACnD,CAAC,CAAC;QACH,OAAO,GAAG,CAAC;IACZ,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACI,KAAK,CAAC,wBAAwB,CAAC,GAAkB;QACvD,IAAA,kBAAQ,EAAC,EAAE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,CAAC;QACvC,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,4BAA4B,CAAC;YACnD,GAAG;SACH,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACI,KAAK,CAAC,uBAAuB,CAAC,OAAgB;QACpD,IAAA,kBAAQ,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC;QAC3C,MAAM,IAAI,CAAC,WAAW,CAAC;YACtB,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,2BAA2B,CAAC;YAClD,OAAO;SACP,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,6BAA6B;QACzC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC;YAC1C,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,kCAAkC,CAAC;SACzD,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IAChB,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,UAAU,CAAC,cAAc,CAAC;IAC7D,CAAC;;AApTF,6BAqTC"}

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

@@ -2,13 +2,16 @@ import IPostMessage from '../../IPostMessage';
 import INetworkInfo, { INetworkInterface, INetworkOptions, INetworkOptionsLegacy, NetworkInterface } from './INetworkInfo';
 import INetwork from './INetwork';
 /**
- * The `sos.management.network` API groups together methods for networking.
+ * The `sos.management.network` API groups together networking methods. For Wi-Fi setup, use the [Wi-Fi API](https://developers.signageos.io/sdk/sos_management/wifi).
  *
- * :::info
+ * <details>
+ *     <summary>Network Management Capabilities</summary>
+ * 		| Capability | Description |
+ * 		|:------------|:-------------|
+ * 		| `NETWORK_INFO` | If device supports returning network information |
  *
- * Use `sos.management.supports('NETWORK_INFO')` to check if the device supports managing the network setup.
- *
- * :::
+ * 		If you want to check if the device supports this capability, use [`sos.management.supports()`](https://developers.signageos.io/sdk/sos_management/#supports).
+ * </details>
  */
 export default class Network implements INetwork {
     private messagePrefix;
@@ -18,11 +21,19 @@ export default class Network implements INetwork {
     /** @deprecated Use `sos.management.network.listInterfaces()` instead. */
     getActiveInfo(): Promise<INetworkInfo>;
     /**
-     * The `listInterface()` method returns list of all network interfaces, and their information like MAC address, IP address, etc. Wifi
-     * connection strength is described as percentage in range from 0 to 100, linearly converted from dBm -90 to -30 respectively based on
-     * platform.
+     * The `listInterface()` method returns a list of all network interfaces, and their information like MAC address, IP address, etc.
+     * Wi-Fi connection strength is described as a percentage in the range from 0 to 100, linearly converted from dBm -90 to -30, respectively, based on the platform.
      *
+     * @returns {Promise<INetworkInterface[]>} Resolves to an array of network interfaces with their information.
      * @since 4.9.0
+     *
+     * @example // {@link https://github.com/signageos/applet-examples/tree/master/examples/management-js-api/network | Applet Example with Network Interfaces}
+     *
+     * @example
+     * const interfaces = await sos.management.network.listInterfaces();
+     * interfaces.forEach((iface) => {
+     *    console.log(`Interface: ${iface.name}, IP: ${iface.ipAddress}, MAC: ${iface.macAddress}`);
+     * });
      */
     listInterfaces(): Promise<INetworkInterface[]>;
     /** @deprecated Use `sos.management.network.setManual(interfaceName, options)` instead. */
@@ -31,45 +42,53 @@ export default class Network implements INetwork {
      * The `setManual()` method manually configures a network interface.
      *
      * :::warning
-     *
-     * Wi-Fi interface can be configured with this method but it has to be first enabled via the [Wi-Fi API](./wifi#enableClient).
-     *
+     * Wi-Fi interface can be configured with this method, but it has to be first enabled via the [Wi-Fi API](https://developers.signageos.io/sdk/sos_management/wifi#enableclient).
      * :::
      *
-     * @param interfaceName The interface name which can be retrieved from the list of interfaces returned by listInterfaces()
+     * @param interfaceName The interface name which can be retrieved from the list of interfaces returned by `listInterfaces()`
      * @param options The network configuration options.
-     *
+     * @param options.localAddress The local IP address to be set.
+     * @param options.gateway The gateway IP address to be set.
+     * @param options.netmask The netmask to be set.
+     * @param options.dns The DNS server array of IP addresses to be set.
+     * @returns {Promise<void>} A promise that resolves when the network is set.
+     * @throws {Error} If the network options are invalid.
+     * @throws {Error} If the device does not support network management.
      * @since 4.0.0
      */
     setManual(interfaceName: string, options: INetworkOptions): Promise<void>;
     /** @deprecated Use `sos.management.network.setDHCP(interfaceName)` instead. */
     setDHCP(networkInterface: NetworkInterface): Promise<void>;
     /**
-     * The `setDHCP()` method configures a network interface to use DHCP.
+     * The `setDHCP()` method configures a selected network interface to use DHCP.
      *
      * :::warning
-     *
-     * Wi-Fi interface can be configured with this method but it has to be first enabled via the [Wi-Fi API](./wifi#enableClient).
-     *
+     * Wi-Fi interface can be configured with this method, but it has to be first enabled via the [Wi-Fi API](https://developers.signageos.io/sdk/sos_management/wifi#enableclient).
      * :::
      *
-     * @param interfaceName The interface name which can be retrieved from the list of interfaces returned by listInterfaces()
-     *
+     * @param interfaceName The interface name which can be retrieved from the list of interfaces returned by `listInterfaces()`
+     * @returns {Promise<void>} A promise that resolves when the network interface is set to use DHCP.
      * @since 4.0.0
+     *
+     * @example
+     * await sos.management.network.setDHCP('eth0');
      */
     setDHCP(interfaceName: string): Promise<void>;
     /**
-     * The `disableInterface()` disables a network interface.
+     * The `disableInterface()` turns off a selected network interface.
      *
      * :::warning
-     *
-     * Don't use this method to disable Wi-Fi. Use [Wi-Fi API](./wifi) to enable/disable Wi-Fi.
-     *
+     * Don't use this method to disable Wi-Fi. Use [Wi-Fi API](https://developers.signageos.io/sdk/sos_management/wifi) to turn Wi-Fi on/off.
      * :::
      *
-     * @param interfaceName The interface name which can be retrieved from the list of interfaces returned by listInterfaces()
-     *
+     * @param interfaceName The interface name which can be retrieved from the list of interfaces returned by `listInterfaces()`
+     * @return {Promise<void>} A promise that resolves when the network interface is disabled.
+     * @throws {Error} If the interface name is invalid.
+     * @throws {Error} If the device does not support network management.
      * @since 4.13.0
+     *
+     * @example
+     * await sos.management.network.disableInterface('eth0');
      */
     disableInterface(interfaceName: string): Promise<void>;
     private getMessage;