app

The sos.management.app API groups together methods for managing the signageOS application installed on the system.

App Management Capabilities

Capability	Description
APP_UPGRADE	If the signageOS application can upgrade itself to a specific version

If you want to check if the device supports this capability, use sos.management.supports().

Methods

getType()

The getType() method returns the type of the platform the application is running on.

info

• If you need to get a specific Android brand or Raspberry Pi model, use the sos.management.firmware.getType().
• default type is always Emulator.

getType(): Promise<AppType>;

Return value

Resolves to the type of the application platform.

Example

const appType = await sos.management.app.getType();
console.log(appType); // tizen, linux, webos, etc.

getVersion()

The getVersion() method returns the version of the Core App that is currently running on the device.

getVersion(): Promise<string>;

Return value

Resolves to the version of the Core application.

Example

const version = await sos.management.app.getVersion();
console.log(`Current application version is: ${version}`); // e.g. '4.0.0', '5.2.1', etc.

upgrade(appUri)

The upgrade(appUri) method upgrades the signageOS application with the provided appUri. Open users can upgrade the app passing FQN URI where the application's main file is located.

This file type/extension differs for every platform. E.g.:

• SSSP: http://example.com/apps/sssp_config.xml or http://example.com/apps/ApplicationName.zip
• Tizen: http://example.com/apps/sssp_config.xml or http://example.com/apps/ApplicationName.wgt
• Webos 1, 2: http://example.com/apps/ApplicationName.zip
• Webos 3+: http://example.com/apps/ApplicationName.ipk
• Brightsign: http://example.com/apps/ApplicationName.zip
• Linux: http://example.com/apps/ApplicationName.apk
• Android: http://example.com/apps/ApplicationName.apk
• ChromeOS: Not supported

tip

Check our latest versions in our changelogs.

upgrade(appUri: string): Promise<void>;

Params

Name	Type	Required	Description
appUri	string	Yes	FQN uri where the application's main file is located.

Return value

A promise that resolves when the upgrade starts.

Possible errors

If the upgrade fails.

Example

// Upgrade the application to a specific version
await sos.management.app.upgrade('http://example.com/apps/ApplicationName.zip')
 .then(() => {
		console.log('Application upgrade started successfully.');
 })
 .catch((error) => {
		console.error('Failed to start application upgrade:', error);
 });

GitHub Example

• How to upgrade application via applets

upgrade(baseUrl, version)

The upgrade(baseUrl, version) does the same as upgrade(version, baseUrl).

upgrade(baseUrl: string, version: string): Promise<void>;

Params

Name	Type	Required	Description
baseUrl	string	Yes	The server URL where application files are located.
version	string	Yes	The version of the application being installed.

upgrade(version, baseUrl)

The upgrade(version, baseUrl?) method upgrades the signageOS application using version and baseUrl. Platform users can install the general application version directly with passing just the version number. Optionally, the baseUrl can be passed as an argument to specify the server where the application files are accessible.

upgrade(version: string, baseUrl?: string): Promise<void>;

Params

Name	Type	Required	Description
version	string	Yes	The version of the application being installed.
baseUrl	string	No	Optional server URL where application files are located. (Default value: "https://2.signageos.io")

Return value

A promise that resolves when the upgrade starts.

Possible errors

If the upgrade fails.

Example

await sos.management.app.upgrade('4.0.0', 'https://2.signageos.io')

GitHub Example

• How to upgrade application via applets